Class RecClass<T>

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

Type Parameters

T = any

Hierarchy (view full)

types.IDL.ConstructType<T>
- RecClass

Index

Constructors

Properties

_counter _id _type

Accessors

Methods

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

Constructors

constructor

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

Properties

`Private` `Static` _counter

_counter: any

`Private` _id

_id: any

`Private` _type

_type: any

Accessors

name

get name(): string
Returns string
Overrides ConstructType.name
- Defined in work/ic-reactor/ic-reactor/.yarn/__virtual__/@dfinity-candid-virtual-71f7e2d478/4/.yarn/berry/cache/@dfinity-candid-npm-2.1.3-42dc934672-10c0.zip/node_modules/@dfinity/candid/lib/cjs/idl.d.ts:321

Methods

buildTypeTable

buildTypeTable(typeTable): void
Parameters
- typeTable: TypeTable
Returns void
Inherited from ConstructType.buildTypeTable
- Defined in work/ic-reactor/ic-reactor/.yarn/__virtual__/@dfinity-candid-virtual-71f7e2d478/4/.yarn/berry/cache/@dfinity-candid-npm-2.1.3-42dc934672-10c0.zip/node_modules/@dfinity/candid/lib/cjs/idl.d.ts:49

checkType

checkType(t): types.IDL.ConstructType<T>
Parameters
- t: types.IDL.Type<any>
Returns types.IDL.ConstructType<T>
Inherited from ConstructType.checkType
- Defined in work/ic-reactor/ic-reactor/.yarn/__virtual__/@dfinity-candid-virtual-71f7e2d478/4/.yarn/berry/cache/@dfinity-candid-npm-2.1.3-42dc934672-10c0.zip/node_modules/@dfinity/candid/lib/cjs/idl.d.ts:75

encodeType

encodeType(typeTable): ArrayBuffer
Implement I in the IDL spec. Encode this type for the type table.
Parameters
- typeTable: TypeTable
Returns ArrayBuffer
Inherited from ConstructType.encodeType
- Defined in work/ic-reactor/ic-reactor/.yarn/__virtual__/@dfinity-candid-virtual-71f7e2d478/4/.yarn/berry/cache/@dfinity-candid-npm-2.1.3-42dc934672-10c0.zip/node_modules/@dfinity/candid/lib/cjs/idl.d.ts:76

accept

accept<D, R>(v, d): R
Type Parameters
- D
- R
Parameters
- v: types.IDL.Visitor<D, R>
- d: D
Returns R
Overrides ConstructType.accept
- Defined in work/ic-reactor/ic-reactor/.yarn/__virtual__/@dfinity-candid-virtual-71f7e2d478/4/.yarn/berry/cache/@dfinity-candid-npm-2.1.3-42dc934672-10c0.zip/node_modules/@dfinity/candid/lib/cjs/idl.d.ts:314

fill

fill(t): void
Parameters
- t: types.IDL.ConstructType<T>
Returns void
- Defined in work/ic-reactor/ic-reactor/.yarn/__virtual__/@dfinity-candid-virtual-71f7e2d478/4/.yarn/berry/cache/@dfinity-candid-npm-2.1.3-42dc934672-10c0.zip/node_modules/@dfinity/candid/lib/cjs/idl.d.ts:315

getType

getType(): undefined | types.IDL.ConstructType<T>
Returns undefined | types.IDL.ConstructType<T>
- Defined in work/ic-reactor/ic-reactor/.yarn/__virtual__/@dfinity-candid-virtual-71f7e2d478/4/.yarn/berry/cache/@dfinity-candid-npm-2.1.3-42dc934672-10c0.zip/node_modules/@dfinity/candid/lib/cjs/idl.d.ts:316

covariant

covariant(x): 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 work/ic-reactor/ic-reactor/.yarn/__virtual__/@dfinity-candid-virtual-71f7e2d478/4/.yarn/berry/cache/@dfinity-candid-npm-2.1.3-42dc934672-10c0.zip/node_modules/@dfinity/candid/lib/cjs/idl.d.ts:317

encodeValue

encodeValue(x): ArrayBuffer
Internal
Encode the value. This needs to be public because it is used by encodeValue() from different types.
Parameters
- x: T
Returns ArrayBuffer
Overrides ConstructType.encodeValue
- Defined in work/ic-reactor/ic-reactor/.yarn/__virtual__/@dfinity-candid-virtual-71f7e2d478/4/.yarn/berry/cache/@dfinity-candid-npm-2.1.3-42dc934672-10c0.zip/node_modules/@dfinity/candid/lib/cjs/idl.d.ts:318

_buildTypeTableImpl

_buildTypeTableImpl(typeTable): void
Parameters
- typeTable: TypeTable
Returns void
Overrides ConstructType._buildTypeTableImpl
- Defined in work/ic-reactor/ic-reactor/.yarn/__virtual__/@dfinity-candid-virtual-71f7e2d478/4/.yarn/berry/cache/@dfinity-candid-npm-2.1.3-42dc934672-10c0.zip/node_modules/@dfinity/candid/lib/cjs/idl.d.ts:319

decodeValue

decodeValue(b, t): T
Parameters
- b: utils.candid.PipeArrayBuffer
- t: types.IDL.Type<any>
Returns T
Overrides ConstructType.decodeValue
- Defined in work/ic-reactor/ic-reactor/.yarn/__virtual__/@dfinity-candid-virtual-71f7e2d478/4/.yarn/berry/cache/@dfinity-candid-npm-2.1.3-42dc934672-10c0.zip/node_modules/@dfinity/candid/lib/cjs/idl.d.ts:320

display

display(): string
Returns string
Overrides ConstructType.display
- Defined in work/ic-reactor/ic-reactor/.yarn/__virtual__/@dfinity-candid-virtual-71f7e2d478/4/.yarn/berry/cache/@dfinity-candid-npm-2.1.3-42dc934672-10c0.zip/node_modules/@dfinity/candid/lib/cjs/idl.d.ts:322

valueToString

valueToString(x): string
Parameters
- x: T
Returns string
Overrides ConstructType.valueToString
- Defined in work/ic-reactor/ic-reactor/.yarn/__virtual__/@dfinity-candid-virtual-71f7e2d478/4/.yarn/berry/cache/@dfinity-candid-npm-2.1.3-42dc934672-10c0.zip/node_modules/@dfinity/candid/lib/cjs/idl.d.ts:323