Skip to main content

TypeScript SDK Reference

api/client.gen.ScalarTypeDef

A definition of a custom scalar defined in a Module.

Hierarchy​

  • BaseClient

    ↳ ScalarTypeDef

Constructors​

constructor​

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

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

Parameters​

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

Returns​

ScalarTypeDef

Overrides​

BaseClient.constructor

Properties​

_description​

Private Optional Readonly _description: string = undefined

_id​

Private Optional Readonly _id: ScalarTypeDefID = 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 scalar, if any.

Returns​

Promise<string>

id​

id(): Promise<ScalarTypeDefID>

A unique identifier for this ScalarTypeDef.

Returns​

Promise<ScalarTypeDefID>

name​

name(): Promise<string>

The name of the scalar.

Returns​

Promise<string>

sourceModuleName​

sourceModuleName(): Promise<string>

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

Returns​

Promise<string>