Skip to main content

Class: EnumValueTypeDef

A definition of a value in a custom enum defined in a Module.

Extends​

  • BaseClient

Constructors​

new EnumValueTypeDef()​

new EnumValueTypeDef(parent?, _id?, _description?, _name?): EnumValueTypeDef

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

Parameters​

• parent?

• parent.ctx?: Context

• parent.queryTree?: QueryTree[]

• _id?: EnumValueTypeDefID

• _description?: string

• _name?: string

Returns​

EnumValueTypeDef

Overrides​

BaseClient.constructor

Methods​

description()​

description(): Promise<string>

A doc string for the enum value, if any.

Returns​

Promise<string>

id()​

id(): Promise<EnumValueTypeDefID>

A unique identifier for this EnumValueTypeDef.

Returns​

Promise<EnumValueTypeDefID>

name()​

name(): Promise<string>

The name of the enum value.

Returns​

Promise<string>