api-extractor-model.apienummember

ApiEnumMember class

Represents a member of a TypeScript enum declaration.

Signature:

export declare class ApiEnumMember extends ApiEnumMember_base 

Extends: ApiEnumMember_base

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
}

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

Property	Modifiers	Type	Description
containerKey	`readonly`	string
kind	`readonly`	ApiItemKind

Method	Modifiers	Description
buildCanonicalReference()		*(BETA)*
getContainerKey(name)	`static`