RecClass
Defined in: packages/candid/src/idl.ts:1559
Represents a reference to an IDL type, used for defining recursive data types.
Type Parameters
Section titled “Type Parameters”T = any
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RecClass<
T>():RecClass<T>
Returns
Section titled “Returns”RecClass<T>
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get name():
string
Defined in: packages/candid/src/idl.ts:1615
Returns
Section titled “Returns”string
Overrides
Section titled “Overrides”typeName
Section titled “typeName”Get Signature
Section titled “Get Signature”get typeName():
IdlTypeName
Defined in: packages/candid/src/idl.ts:1560
Returns
Section titled “Returns”IdlTypeName
Overrides
Section titled “Overrides”Methods
Section titled “Methods”_buildTypeTableImpl()
Section titled “_buildTypeTableImpl()”_buildTypeTableImpl(
typeTable):void
Defined in: packages/candid/src/idl.ts:1599
Parameters
Section titled “Parameters”typeTable
Section titled “typeTable”TypeTable
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”ConstructType._buildTypeTableImpl
accept()
Section titled “accept()”accept<
D,R>(v,d):R
Defined in: packages/candid/src/idl.ts:1572
Type Parameters
Section titled “Type Parameters”D
R
Parameters
Section titled “Parameters”Visitor<D, R>
D
Returns
Section titled “Returns”R
Overrides
Section titled “Overrides”buildTypeTable()
Section titled “buildTypeTable()”buildTypeTable(
typeTable):void
Defined in: packages/candid/src/idl.ts:217
Parameters
Section titled “Parameters”typeTable
Section titled “typeTable”TypeTable
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”checkType()
Section titled “checkType()”checkType(
t):ConstructType<T>
Defined in: packages/candid/src/idl.ts:264
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”covariant()
Section titled “covariant()”covariant(
x):x is T
Defined in: packages/candid/src/idl.ts:1587
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
Overrides
Section titled “Overrides”decodeValue()
Section titled “decodeValue()”decodeValue(
b,t):T
Defined in: packages/candid/src/idl.ts:1608
Parameters
Section titled “Parameters”Returns
Section titled “Returns”T
Overrides
Section titled “Overrides”display()
Section titled “display()”display():
string
Defined in: packages/candid/src/idl.ts:1619
Returns
Section titled “Returns”string
Overrides
Section titled “Overrides”encodeType()
Section titled “encodeType()”encodeType(
typeTable):Uint8Array<ArrayBufferLike>
Defined in: packages/candid/src/idl.ts:274
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<ArrayBufferLike>
Inherited from
Section titled “Inherited from”encodeValue()
Section titled “encodeValue()”encodeValue(
x):Uint8Array<ArrayBufferLike>
Defined in: packages/candid/src/idl.ts:1592
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<ArrayBufferLike>
Overrides
Section titled “Overrides”fill()
Section titled “fill()”fill(
t):void
Defined in: packages/candid/src/idl.ts:1579
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
getType()
Section titled “getType()”getType():
undefined|ConstructType<T>
Defined in: packages/candid/src/idl.ts:1583
Returns
Section titled “Returns”undefined | ConstructType<T>
valueToString()
Section titled “valueToString()”valueToString(
x):string
Defined in: packages/candid/src/idl.ts:1626
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”string
Overrides
Section titled “Overrides”[hasInstance]()
Section titled “[hasInstance]()”
static[hasInstance](instance):instance is RecClass<any>
Defined in: packages/candid/src/idl.ts:1568
Parameters
Section titled “Parameters”instance
Section titled “instance”any
Returns
Section titled “Returns”instance is RecClass<any>