RoadmapShopEvents
Skip to main content

Home > @microsoft/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

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

ConstructorModifiersDescription
(constructor)(options)Constructs a new instance of the ApiEnumMember class

Properties

PropertyModifiersTypeDescription
containerKeystring
initializerExcerptExcerptAn Excerpt that describes the value of the enum member.
kindApiItemKind

Methods

MethodModifiersDescription
buildCanonicalReference()(BETA)
getContainerKey(name)static
onDeserializeInto(options, context, jsonObject)static
serializeInto(jsonObject)