Skip to main content

TypeScript SDK Reference

api/client.gen.EnumTypeDef

A definition of a custom enum defined in a Module.

Hierarchy​

  • BaseClient

    ↳ EnumTypeDef

Constructors​

constructor​

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

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

Parameters​

NameType
parent?Object
parent.ctxContext
parent.queryTree?QueryTree[]
_id?EnumTypeDefID
_description?string
_name?string
_sourceModuleName?string

Returns​

EnumTypeDef

Overrides​

BaseClient.constructor

Properties​

_description​

Private Optional Readonly _description: string = undefined

_id​

Private Optional Readonly _id: EnumTypeDefID = undefined

_name​

Private Optional Readonly _name: string = undefined

_sourceModuleName​

Private Optional Readonly _sourceModuleName: string = undefined

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[]>