Class ConstructType<T>`Abstract`

Represents an IDL type.

Type Parameters

T = any

Hierarchy (View Summary)

types.IDL.Type<T>
- ConstructType

Index

Constructors

Properties

Methods

accept display valueToString buildTypeTable covariant encodeValue decodeValue _buildTypeTableImpl checkType encodeType

Constructors

constructor

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

Properties

`Abstract` `Readonly`typeName

typeName: IdlTypeName

`Abstract` `Readonly`name

name: string

Methods

`Abstract`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
Inherited from Type.accept
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:69

display

display(): string
Returns string
Inherited from Type.display
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:70

valueToString

valueToString(x: T): string
Parameters
- x: T
Returns string
Inherited from Type.valueToString
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:71

buildTypeTable

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

`Abstract`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
Inherited from Type.covariant
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:77

`Abstract`encodeValue

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

`Abstract`decodeValue

decodeValue(x: utils.candid.PipeArrayBuffer, t: types.IDL.Type): T
Parameters
- x: utils.candid.PipeArrayBuffer
- t: types.IDL.Type
Returns T
Inherited from Type.decodeValue
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:90

`Protected` `Abstract`_buildTypeTableImpl

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

checkType

checkType(t: types.IDL.Type): types.IDL.ConstructType<T>
Parameters
- t: types.IDL.Type
Returns types.IDL.ConstructType<T>
Overrides Type.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>
Overrides Type.encodeType
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:99