Class RecClass<T>

Represents a reference to an IDL type, used for defining recursive data types.

Type Parameters

T = any

Hierarchy (View Summary)

types.IDL.ConstructType<T>
- RecClass

Index

Constructors

Accessors

Methods

buildTypeTable checkType encodeType [hasInstance] accept fill getType covariant encodeValue _buildTypeTableImpl decodeValue display valueToString

Constructors

constructor

new RecClass<T = any>(): types.IDL.RecClass<T>
Type Parameters
- T = any
Returns types.IDL.RecClass<T>
Inherited from ConstructType.constructor

Accessors

typeName

get typeName(): IdlTypeName
Returns IdlTypeName
Overrides ConstructType.typeName
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:368

name

get name(): string
Returns string
Overrides ConstructType.name
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:380

Methods

buildTypeTable

buildTypeTable(typeTable: TypeTable): void
Parameters
- typeTable: TypeTable
Returns void
Inherited from ConstructType.buildTypeTable
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:72

checkType

checkType(t: types.IDL.Type): types.IDL.ConstructType<T>
Parameters
- t: types.IDL.Type
Returns types.IDL.ConstructType<T>
Inherited from ConstructType.checkType
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:98

encodeType

encodeType(typeTable: TypeTable): Uint8Array<ArrayBufferLike>
Implement I in the IDL spec. Encode this type for the type table.
Parameters
- typeTable: TypeTable
Returns Uint8Array<ArrayBufferLike>
Inherited from ConstructType.encodeType
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:99

`Static`[hasInstance]

"[hasInstance]"(instance: any): instance is types.IDL.RecClass<any>
Parameters
- instance: any
Returns instance is types.IDL.RecClass<any>
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:372

accept

accept<D, R>(v: types.IDL.Visitor<D, R>, d: D): R
Type Parameters
- D
- R
Parameters
- v: types.IDL.Visitor<D, R>
- d: D
Returns R
Overrides ConstructType.accept
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:373

fill

fill(t: types.IDL.ConstructType<T>): void
Parameters
- t: types.IDL.ConstructType<T>
Returns void
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:374

getType

getType(): undefined | types.IDL.ConstructType<T>
Returns undefined | types.IDL.ConstructType<T>
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:375

covariant

covariant(x: any): x is T
Assert that JavaScript's x is the proper type represented by this Type.
Parameters
- x: any
Returns x is T
Overrides ConstructType.covariant
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:376

encodeValue

encodeValue(x: T): Uint8Array<ArrayBufferLike>
Internal
Encode the value. This needs to be public because it is used by encodeValue() from different types.
Parameters
- x: T
Returns Uint8Array<ArrayBufferLike>
Overrides ConstructType.encodeValue
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:377

_buildTypeTableImpl

_buildTypeTableImpl(typeTable: TypeTable): void
Parameters
- typeTable: TypeTable
Returns void
Overrides ConstructType._buildTypeTableImpl
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:378

decodeValue

decodeValue(b: utils.candid.PipeArrayBuffer, t: types.IDL.Type): T
Parameters
- b: utils.candid.PipeArrayBuffer
- t: types.IDL.Type
Returns T
Overrides ConstructType.decodeValue
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:379

display

display(): string
Returns string
Overrides ConstructType.display
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:381

valueToString

valueToString(x: T): string
Parameters
- x: T
Returns string
Overrides ConstructType.valueToString
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:382