Skip to main content

TypeScript SDK Reference

api/client.gen.EnumValueTypeDef

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

Hierarchy​

  • BaseClient

    ↳ EnumValueTypeDef

Constructors​

constructor​

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

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

Parameters​

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

Returns​

EnumValueTypeDef

Overrides​

BaseClient.constructor

Properties​

_description​

Private Optional Readonly _description: string = undefined

_id​

Private Optional Readonly _id: EnumValueTypeDefID = undefined

_name​

Private Optional Readonly _name: string = undefined

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>