Class: 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).
Extends​
BaseClient
Constructors​
Constructor​
new FieldTypeDef(
ctx?,_id?,_description?,_name?):FieldTypeDef
Constructor is used for internal usage only, do not create object from it.
Parameters​
ctx?​
Context
_id?​
_description?​
string
_name?​
string
Returns​
FieldTypeDef
Overrides​
BaseClient.constructor
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>
sourceMap()​
sourceMap():
SourceMap
The location of this field declaration.
Returns​
typeDef()​
typeDef():
TypeDef
The type of the field.