Dagger NodeJS SDK
api/client.gen.ObjectTypeDef
A definition of a custom object defined in a Module.
Hierarchy
-
BaseClient↳
ObjectTypeDef
Constructors
constructor
new ObjectTypeDef(parent?, _id?, _description?, _name?, _sourceModuleName?): ObjectTypeDef
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? | ObjectTypeDefID |
_description? | string |
_name? | string |
_sourceModuleName? | string |
Returns
Overrides
BaseClient.constructor
Properties
_description
Private Optional Readonly _description: string = undefined
_id
Private Optional Readonly _id: ObjectTypeDefID = undefined
_name
Private Optional Readonly _name: string = undefined
_sourceModuleName
Private Optional Readonly _sourceModuleName: string = undefined
Methods
constructor_
constructor_(): Function_
The function used to construct new instances of this object, if any
Returns
description
description(): Promise<string>
The doc string for the object, if any.
Returns
Promise<string>
fields
fields(): Promise<FieldTypeDef[]>
Static fields defined on this object, if any.
Returns
Promise<FieldTypeDef[]>
functions
functions(): Promise<Function_[]>
Functions defined on this object, if any.
Returns
Promise<Function_[]>
id
id(): Promise<ObjectTypeDefID>
A unique identifier for this ObjectTypeDef.
Returns
Promise<ObjectTypeDefID>
name
name(): Promise<string>
The name of the object.
Returns
Promise<string>
sourceModuleName
sourceModuleName(): Promise<string>
If this ObjectTypeDef is associated with a Module, the name of the module. Unset otherwise.
Returns
Promise<string>