Type
Defined in: packages/candid/src/idl.ts:231
Represents an IDL type.
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”T = any
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Type<
T>():Type<T>
Returns
Section titled “Returns”Type<T>
Properties
Section titled “Properties”
abstractreadonlyname:string
Defined in: packages/candid/src/idl.ts:233
typeName
Section titled “typeName”
abstractreadonlytypeName:IdlTypeName
Defined in: packages/candid/src/idl.ts:232
Methods
Section titled “Methods”_buildTypeTableImpl()
Section titled “_buildTypeTableImpl()”
abstractprotected_buildTypeTableImpl(typeTable):void
Defined in: packages/candid/src/idl.ts:275
Parameters
Section titled “Parameters”typeTable
Section titled “typeTable”TypeTable
Returns
Section titled “Returns”void
accept()
Section titled “accept()”
abstractaccept<D,R>(v,d):R
Defined in: packages/candid/src/idl.ts:234
Type Parameters
Section titled “Type Parameters”D
R
Parameters
Section titled “Parameters”Visitor<D, R>
D
Returns
Section titled “Returns”R
buildTypeTable()
Section titled “buildTypeTable()”buildTypeTable(
typeTable):void
Defined in: packages/candid/src/idl.ts:246
Parameters
Section titled “Parameters”typeTable
Section titled “typeTable”TypeTable
Returns
Section titled “Returns”void
checkType()
Section titled “checkType()”
abstractcheckType(t):Type
Defined in: packages/candid/src/idl.ts:271
Parameters
Section titled “Parameters”Type
Returns
Section titled “Returns”Type
covariant()
Section titled “covariant()”
abstractcovariant(x):x is T
Defined in: packages/candid/src/idl.ts:256
Assert that JavaScript’s x is the proper type represented by this
Type.
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”x is T
decodeValue()
Section titled “decodeValue()”
abstractdecodeValue(x,t):T
Defined in: packages/candid/src/idl.ts:273
Parameters
Section titled “Parameters”Type
Returns
Section titled “Returns”T
display()
Section titled “display()”display():
string
Defined in: packages/candid/src/idl.ts:237
Returns
Section titled “Returns”string
encodeType()
Section titled “encodeType()”
abstractencodeType(typeTable):Uint8Array
Defined in: packages/candid/src/idl.ts:269
Implement I in the IDL spec.
Encode this type for the type table.
Parameters
Section titled “Parameters”typeTable
Section titled “typeTable”TypeTable
Returns
Section titled “Returns”Uint8Array
encodeValue()
Section titled “encodeValue()”
abstractencodeValue(x):Uint8Array
Defined in: packages/candid/src/idl.ts:263
Internal
Encode the value. This needs to be public because it is used by encodeValue() from different types.
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”Uint8Array
valueToString()
Section titled “valueToString()”valueToString(
x):string
Defined in: packages/candid/src/idl.ts:241
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”string