Dagger NodeJS SDK
api/client.gen.FieldTypeDef
A definition of a field on a custom object defined in a Module.
A field on an object has a static value, as opposed to a function on an object whose value is computed by invoking code (and can accept arguments).
Hierarchy
-
BaseClient↳
FieldTypeDef
Constructors
constructor
new FieldTypeDef(parent?, _id?, _description?, _name?): FieldTypeDef
Constructor is used for internal usage only, do not create object from it.
Parameters
| Name | Type |
|---|---|
parent? | Object |
parent.ctx | Context |
parent.queryTree? | QueryTree[] |
_id? | FieldTypeDefID |
_description? | string |
_name? | string |
Returns
Overrides
BaseClient.constructor
Properties
_description
Private Optional Readonly _description: string = undefined
_id
Private Optional Readonly _id: FieldTypeDefID = undefined
_name
Private Optional Readonly _name: string = undefined
Methods
description
description(): Promise<string>
A doc string for the field, if any.
Returns
Promise<string>
id
id(): Promise<FieldTypeDefID>
A unique identifier for this FieldTypeDef.
Returns
Promise<FieldTypeDefID>
name
name(): Promise<string>
The name of the field in lowerCamelCase format.
Returns
Promise<string>
typeDef
typeDef(): TypeDef
The type of the field.