Home > @microsoft/api-extractor-model > ApiEnumMember

ApiEnumMember class

Represents a member of a TypeScript enum declaration.

Signature:

export declare class ApiEnumMember extends ApiEnumMember_base 

Remarks

This is part of the ApiModel hierarchy of classes, which are serializable representations of API declarations.

ApiEnumMember represents an enum member such as Small = 100 in the example below:

export enum FontSizes {
  Small = 100,
  Medium = 200,
  Large = 300
}

Constructors

Constructor Modifiers Description
(constructor)(options)   Constructs a new instance of the ApiEnumMember class

Properties

Property Modifiers Type Description
containerKey   string  
initializerExcerpt   Excerpt An Excerpt that describes the value of the enum member.
kind   ApiItemKind  

Methods

Method Modifiers Description
buildCanonicalReference()   (BETA)
getContainerKey(name) static  
onDeserializeInto(options, context, jsonObject) static  
serializeInto(jsonObject)