ConstructType

Defined in: packages/candid/src/idl.ts:292

Represents an IDL type.

Extends

• Type<T>

Extended by

• VecClass
• OptClass
• RecordClass
• VariantClass
• RecClass
• FuncClass
• ServiceClass

Type Parameters

T

T = any

Constructors

Constructor

new ConstructType<T>(): ConstructType<T>

Returns

ConstructType<T>

Inherited from

Type.constructor

Properties

name

abstract readonly name: string

Defined in: packages/candid/src/idl.ts:233

Inherited from

Type.name

---

typeName

abstract readonly typeName: IdlTypeName

Defined in: packages/candid/src/idl.ts:232

Inherited from

Type.typeName

Methods

_buildTypeTableImpl()

abstract protected _buildTypeTableImpl(typeTable): void

Defined in: packages/candid/src/idl.ts:275

Parameters

typeTable

TypeTable

Returns

void

Inherited from

Type._buildTypeTableImpl

---

accept()

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

Defined in: packages/candid/src/idl.ts:234

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Inherited from

Type.accept

---

buildTypeTable()

buildTypeTable(typeTable): void

Defined in: packages/candid/src/idl.ts:246

Parameters

typeTable

TypeTable

Returns

void

Inherited from

Type.buildTypeTable

---

checkType()

checkType(t): ConstructType<T>

Defined in: packages/candid/src/idl.ts:293

Parameters

t

Type

Returns

ConstructType<T>

Overrides

Type.checkType

---

covariant()

abstract covariant(x): x is T

Defined in: packages/candid/src/idl.ts:256

Assert that JavaScript’s x is the proper type represented by this Type.

Parameters

x

any

Returns

x is T

Inherited from

Type.covariant

---

decodeValue()

abstract decodeValue(x, t): T

Defined in: packages/candid/src/idl.ts:273

Parameters

x

PipeArrayBuffer

t

Type

Returns

T

Inherited from

Type.decodeValue

---

display()

display(): string

Defined in: packages/candid/src/idl.ts:237

Returns

string

Inherited from

Type.display

---

encodeType()

encodeType(typeTable): Uint8Array<ArrayBufferLike>

Defined in: packages/candid/src/idl.ts:303

Implement I in the IDL spec. Encode this type for the type table.

Parameters

typeTable

TypeTable

Returns

Uint8Array<ArrayBufferLike>

Overrides

Type.encodeType

---

encodeValue()

abstract encodeValue(x): Uint8Array

Defined in: packages/candid/src/idl.ts:263

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

---

valueToString()

valueToString(x): string

Defined in: packages/candid/src/idl.ts:241

Parameters

x

T

Returns

string

Inherited from

Type.valueToString