Type

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

Represents an IDL type.

Extended by

• PrimitiveType
• ConstructType
• UnknownClass

Type Parameters

T

T = any

Constructors

Constructor

new Type<T>(): Type<T>

Returns

Type<T>

Properties

name

abstract readonly name: string

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

Methods

_buildTypeTableImpl()

abstract protected _buildTypeTableImpl(typeTable): void

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

Parameters

typeTable

TypeTable

Returns

void

---

accept()

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

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

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

---

buildTypeTable()

buildTypeTable(typeTable): void

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

Parameters

typeTable

TypeTable

Returns

void

---

checkType()

abstract checkType(t): Type

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

Parameters

t

Type

Returns

Type

---

covariant()

abstract covariant(x): x is T

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

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

Parameters

x

any

Returns

x is T

---

decodeValue()

abstract decodeValue(x, t): T

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

Parameters

x

PipeArrayBuffer

t

Type

Returns

T

---

display()

display(): string

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

Returns

string

---

encodeType()

abstract encodeType(typeTable): Uint8Array

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

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

Parameters

typeTable

TypeTable

Returns

Uint8Array

---

encodeValue()

abstract encodeValue(x): Uint8Array

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

Internal

Encode the value. This needs to be public because it is used by encodeValue() from different types.

Parameters

x

T

Returns

Uint8Array

---

valueToString()

valueToString(x): string

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

Parameters

x

T

Returns

string