Class RecClass<T>

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

Type Parameters

T = any

Hierarchy

ConstructType<T>
- RecClass

Index

Constructors

constructor

Properties

Accessors

name

Methods

Constructors

constructor

new RecClass<T>(): RecClass<T>

Inherited from ConstructType.constructor
Type Parameters
- T = any
Returns RecClass<T>

Properties

Private _id

_id: number = ...

Private _type

_type: undefined | ConstructType<T> = undefined

Static Private _counter

_counter: number = 0

Accessors

name

get name(): string

Overrides ConstructType.name
- Defined in packages/candid/src/idl.ts:1316
Returns string

Methods

_buildTypeTableImpl

_buildTypeTableImpl(typeTable: TypeTable): void

Overrides ConstructType._buildTypeTableImpl
- Defined in packages/candid/src/idl.ts:1300
Parameters
- typeTable: TypeTable
Returns void

accept

accept<D, R>(v: Visitor<D, R>, d: D): R

Overrides ConstructType.accept
- Defined in packages/candid/src/idl.ts:1273
Type Parameters
- D
- R
Parameters
- v: Visitor<D, R>
- d: D
Returns R

buildTypeTable

buildTypeTable(typeTable: TypeTable): void

Inherited from ConstructType.buildTypeTable
- Defined in packages/candid/src/idl.ts:192
Parameters
- typeTable: TypeTable
Returns void

checkType

checkType(t: Type<any>): ConstructType<T>

Inherited from ConstructType.checkType
- Defined in packages/candid/src/idl.ts:238
Parameters
- t: Type<any>
Returns ConstructType<T>

covariant

covariant(x: any): x is T

Overrides ConstructType.covariant
- Defined in packages/candid/src/idl.ts:1288
Assert that JavaScript's x is the proper type represented by this Type.

Parameters
- x: any
Returns x is T

decodeValue

decodeValue(b: PipeArrayBuffer, t: Type<any>): T

Overrides ConstructType.decodeValue
- Defined in packages/candid/src/idl.ts:1309
Parameters
- b: PipeArrayBuffer
- t: Type<any>
Returns T

display

display(): string

Overrides ConstructType.display
- Defined in packages/candid/src/idl.ts:1320
Returns string

encodeType

encodeType(typeTable: TypeTable): ArrayBuffer

Inherited from ConstructType.encodeType
- Defined in packages/candid/src/idl.ts:248
Implement I in the IDL spec. Encode this type for the type table.

Parameters
- typeTable: TypeTable
Returns ArrayBuffer

encodeValue

encodeValue(x: T): ArrayBuffer

Overrides ConstructType.encodeValue
- Defined in packages/candid/src/idl.ts:1293
Parameters
- x: T
Returns ArrayBuffer

fill

fill(t: ConstructType<T>): void

- Defined in packages/candid/src/idl.ts:1280
Parameters
- t: ConstructType<T>
Returns void

getType

getType(): undefined | ConstructType<T>

- Defined in packages/candid/src/idl.ts:1284
Returns undefined | ConstructType<T>

valueToString

valueToString(x: T): string

Overrides ConstructType.valueToString
- Defined in packages/candid/src/idl.ts:1327
Parameters
- x: T
Returns string

Generated using TypeDoc