Skip to main content

Class: EnumTypeDef

A definition of a custom enum defined in a Module.

Extends​

  • BaseClient

Constructors​

new EnumTypeDef()​

new EnumTypeDef(parent?, _id?, _description?, _name?, _sourceModuleName?): EnumTypeDef

Constructor is used for internal usage only, do not create object from it.

Parameters​

• parent?

• parent.ctx?: Context

• parent.queryTree?: QueryTree[]

• _id?: EnumTypeDefID

• _description?: string

• _name?: string

• _sourceModuleName?: string

Returns​

EnumTypeDef

Overrides​

BaseClient.constructor

Methods​

description()​

description(): Promise<string>

A doc string for the enum, if any.

Returns​

Promise<string>

id()​

id(): Promise<EnumTypeDefID>

A unique identifier for this EnumTypeDef.

Returns​

Promise<EnumTypeDefID>

name()​

name(): Promise<string>

The name of the enum.

Returns​

Promise<string>

sourceModuleName()​

sourceModuleName(): Promise<string>

If this EnumTypeDef is associated with a Module, the name of the module. Unset otherwise.

Returns​

Promise<string>

values()​

values(): Promise<EnumValueTypeDef[]>

The values of the enum.

Returns​

Promise<EnumValueTypeDef[]>