Interface Enumeration

See: relevant section in reference guide

interface Enumeration {
    $CreationOptions?: EnumerationCreationOptions;
    $ID: string;
    $Type: "Enumerations$Enumeration";
    documentation: string;
    excluded: boolean;
    exportLevel: ExportLevel;
    name: string;
    remoteSource: null | RemoteEnumerationSource;
    values: EnumerationValue[];
    addEnumerationValue(
        options: EnumerationValueCreationOptions,
    ): Promise<EnumerationValue>;
    getEnumerationValue(name: string): undefined | EnumerationValue;
}

Hierarchy

Document
- Enumeration

Index

Properties

$CreationOptions? $ID $Type documentation excluded exportLevel name remoteSource values

Methods

addEnumerationValue getEnumerationValue

Properties

`Optional`$CreationOptions

$CreationOptions?: EnumerationCreationOptions

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type: "Enumerations$Enumeration"

The type of the element.

documentation

documentation: string

excluded

excluded: boolean

exportLevel

exportLevel: ExportLevel

name

name: string

remoteSource

remoteSource: null | RemoteEnumerationSource

values

values: EnumerationValue[]

Methods

addEnumerationValue

addEnumerationValue(
options: EnumerationValueCreationOptions,
): Promise<EnumerationValue>
Parameters
- options: EnumerationValueCreationOptions
Returns Promise<EnumerationValue>

getEnumerationValue

getEnumerationValue(name: string): undefined | EnumerationValue
Parameters
- name: string
Returns undefined | EnumerationValue