IDL

Accessors

name

Get Signature

get name(): string

Defined in: packages/core/src/candid/idl.ts:485

Returns

string

Overrides

typeName

Get Signature

get typeName(): IdlTypeName

Defined in: packages/core/src/candid/idl.ts:446

Returns

IdlTypeName

Overrides

Methods

_buildTypeTableImpl()

_buildTypeTableImpl(_typeTable): void

Parameters

_typeTable

TypeTable

Returns

void

Inherited from

accept()

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

Defined in: packages/core/src/candid/idl.ts:454

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Overrides

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

checkType()

checkType(t): Type

Parameters

covariant()

covariant(x): x is boolean

Defined in: packages/core/src/candid/idl.ts:458

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

Parameters

x

any

Returns

x is boolean

Overrides

decodeValue()

decodeValue(b, t): boolean

Defined in: packages/core/src/candid/idl.ts:473

Parameters

b

t

Returns

boolean

Overrides

display()

display(): string

Returns

string

Inherited from

encodeType()

encodeType(): Uint8Array

Defined in: packages/core/src/candid/idl.ts:469

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

Returns

Uint8Array

Overrides

encodeValue()

encodeValue(x): Uint8Array

Defined in: packages/core/src/candid/idl.ts:465

Internal

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

Parameters

x

boolean

Returns

Uint8Array

Overrides

valueToString()

valueToString(x): string

Parameters

x

boolean

Returns

string

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

[hasInstance]()

static [hasInstance](instance): instance is BoolClass

Defined in: packages/core/src/candid/idl.ts:450

Parameters

instance

any

Returns

instance is BoolClass

CandidDecodeError

Defined in: packages/core/src/candid/idl.ts:31

Error thrown when candid decoding fails due to a type mismatch between the expected and received types.

Extends

Error

Constructors

Constructor

new CandidDecodeError(message): CandidDecodeError

Defined in: packages/core/src/candid/idl.ts:34

Parameters

message

string

Returns

CandidDecodeError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

message

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string = 'CandidDecodeError'

Defined in: packages/core/src/candid/idl.ts:32

Overrides

Error.name

stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

Error.prepareStackTrace

`abstract` ConstructType

Defined in: packages/core/src/candid/idl.ts:305

Represents an IDL type.

Extends

Type<T>

Type Parameters

T

T = any

Constructors

Constructor

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

Returns

Type._buildTypeTableImpl

Inherited from

Type.constructor

Properties

name

abstract readonly name: string

Defined in: packages/core/src/candid/idl.ts:247

Inherited from

Type.name

typeName

abstract readonly typeName: IdlTypeName

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

Inherited from

Type.typeName

Methods

_buildTypeTableImpl()

abstract protected _buildTypeTableImpl(typeTable): void

Defined in: packages/core/src/candid/idl.ts:289

Parameters

typeTable

TypeTable

Returns

void

Inherited from

accept()

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

Defined in: packages/core/src/candid/idl.ts:248

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Inherited from

Type.accept

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

Type.buildTypeTable

checkType()

checkType(t): ConstructType<T>

Parameters

t

Returns

Overrides

Type.checkType

covariant()

abstract covariant(x): x is T

Defined in: packages/core/src/candid/idl.ts:270

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/core/src/candid/idl.ts:287

Parameters

x

t

Returns

T

Inherited from

Type.decodeValue

display()

display(): string

Returns

string

Inherited from

Type.display

encodeType()

encodeType(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

encodeValue()

abstract encodeValue(x): Uint8Array

Defined in: packages/core/src/candid/idl.ts:277

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

Parameters

x

T

Returns

string

Inherited from

Type.valueToString

EmptyClass

Defined in: packages/core/src/candid/idl.ts:326

Represents an IDL Empty, a type which has no inhabitants. Since no values exist for this type, it cannot be serialised or deserialised. Result types like Result<Text, Empty> should always succeed.

Extends

PrimitiveType<never>

Constructors

Constructor

new EmptyClass(): EmptyClass

Returns

EmptyClass

Inherited from

Accessors

name

Get Signature

get name(): string

Defined in: packages/core/src/candid/idl.ts:359

Returns

string

Overrides

typeName

Get Signature

get typeName(): IdlTypeName

Defined in: packages/core/src/candid/idl.ts:327

Returns

IdlTypeName

Overrides

Methods

_buildTypeTableImpl()

_buildTypeTableImpl(_typeTable): void

Parameters

_typeTable

TypeTable

Returns

void

Inherited from

accept()

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

Defined in: packages/core/src/candid/idl.ts:335

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Overrides

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

checkType()

checkType(t): Type

Parameters

t

Returns

Inherited from

covariant()

covariant(x): x is never

Defined in: packages/core/src/candid/idl.ts:339

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

Parameters

x

any

Returns

x is never

Overrides

decodeValue()

decodeValue(): never

Defined in: packages/core/src/candid/idl.ts:355

Returns

never

Overrides

display()

display(): string

Returns

string

Inherited from

encodeType()

encodeType(): Uint8Array<ArrayBufferLike>

Defined in: packages/core/src/candid/idl.ts:351

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

Returns

Uint8Array<ArrayBufferLike>

Overrides

encodeValue()

encodeValue(): never

Defined in: packages/core/src/candid/idl.ts:343

Internal

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

Returns

never

Overrides

valueToString()

valueToString(): never

Defined in: packages/core/src/candid/idl.ts:347

Returns

never

Overrides

[hasInstance]()

static [hasInstance](instance): instance is EmptyClass

Defined in: packages/core/src/candid/idl.ts:331

Parameters

instance

any

Returns

instance is EmptyClass

FixedIntClass

Defined in: packages/core/src/candid/idl.ts:782

Represents an IDL fixed-width Int(n)

Extends

PrimitiveType<bigint | number>

Constructors

Constructor

new FixedIntClass(_bits): FixedIntClass

Defined in: packages/core/src/candid/idl.ts:791

Parameters

_bits

number

Returns

Overrides

Properties

_bits

readonly _bits: number

Defined in: packages/core/src/candid/idl.ts:791

Accessors

name

Get Signature

get name(): string

Defined in: packages/core/src/candid/idl.ts:833

Returns

string

Overrides

typeName

Get Signature

get typeName(): IdlTypeName

Defined in: packages/core/src/candid/idl.ts:783

Returns

IdlTypeName

Overrides

Methods

_buildTypeTableImpl()

_buildTypeTableImpl(_typeTable): void

Parameters

_typeTable

TypeTable

Returns

void

Inherited from

accept()

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

Defined in: packages/core/src/candid/idl.ts:795

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Overrides

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

checkType()

checkType(t): Type

Parameters

t

Returns

Inherited from

covariant()

covariant(x): x is bigint

Defined in: packages/core/src/candid/idl.ts:799

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

Parameters

x

any

Returns

x is bigint

Overrides

decodeValue()

decodeValue(b, t): number | bigint

Defined in: packages/core/src/candid/idl.ts:824

Parameters

b

t

Returns

number | bigint

Overrides

display()

display(): string

Returns

string

Inherited from

encodeType()

encodeType(): Uint8Array<ArrayBufferLike>

Defined in: packages/core/src/candid/idl.ts:819

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

Returns

Uint8Array<ArrayBufferLike>

Overrides

encodeValue()

encodeValue(x): Uint8Array<ArrayBufferLike>

Defined in: packages/core/src/candid/idl.ts:815

Internal

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

Parameters

x

number | bigint

Returns

Uint8Array<ArrayBufferLike>

Overrides

valueToString()

valueToString(x): string

Defined in: packages/core/src/candid/idl.ts:837

Parameters

x

number | bigint

Returns

string

Overrides

[hasInstance]()

static [hasInstance](instance): instance is FixedIntClass

Defined in: packages/core/src/candid/idl.ts:787

Parameters

instance

any

Returns

instance is FixedIntClass

FixedNatClass

Defined in: packages/core/src/candid/idl.ts:845

Represents an IDL fixed-width Nat(n)

Extends

PrimitiveType<bigint | number>

Constructors

Constructor

new FixedNatClass(_bits): FixedNatClass

Defined in: packages/core/src/candid/idl.ts:854

Parameters

_bits

number

Returns

Overrides

Properties

_bits

readonly _bits: number

Defined in: packages/core/src/candid/idl.ts:854

Accessors

name

Get Signature

get name(): string

Defined in: packages/core/src/candid/idl.ts:895

Returns

string

Overrides

typeName

Get Signature

get typeName(): IdlTypeName

Defined in: packages/core/src/candid/idl.ts:846

Returns

IdlTypeName

Overrides

Methods

_buildTypeTableImpl()

_buildTypeTableImpl(_typeTable): void

Parameters

_typeTable

TypeTable

Returns

void

Inherited from

accept()

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

Defined in: packages/core/src/candid/idl.ts:858

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Overrides

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

checkType()

checkType(t): Type

Parameters

t

Returns

Inherited from

covariant()

covariant(x): x is bigint

Defined in: packages/core/src/candid/idl.ts:862

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

Parameters

x

any

Returns

x is bigint

Overrides

decodeValue()

decodeValue(b, t): number | bigint

Defined in: packages/core/src/candid/idl.ts:886

Parameters

b

t

Returns

number | bigint

Overrides

display()

display(): string

Returns

string

Inherited from

encodeType()

encodeType(): Uint8Array<ArrayBufferLike>

Defined in: packages/core/src/candid/idl.ts:881

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

Returns

Uint8Array<ArrayBufferLike>

Overrides

encodeValue()

encodeValue(x): Uint8Array<ArrayBufferLike>

Defined in: packages/core/src/candid/idl.ts:877

Internal

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

Parameters

x

number | bigint

Returns

Uint8Array<ArrayBufferLike>

Overrides

valueToString()

valueToString(x): string

Defined in: packages/core/src/candid/idl.ts:899

Parameters

x

number | bigint

Returns

string

Overrides

[hasInstance]()

static [hasInstance](instance): instance is FixedNatClass

Defined in: packages/core/src/candid/idl.ts:850

Parameters

instance

any

Returns

instance is FixedNatClass

FloatClass

Defined in: packages/core/src/candid/idl.ts:718

Represents an IDL Float

Extends

PrimitiveType<number>

Constructors

Constructor

new FloatClass(_bits): FloatClass

Defined in: packages/core/src/candid/idl.ts:727

Parameters

_bits

number

Returns

Overrides

Properties

_bits

readonly _bits: number

Defined in: packages/core/src/candid/idl.ts:727

Accessors

name

Get Signature

get name(): string

Defined in: packages/core/src/candid/idl.ts:770

Returns

string

Overrides

typeName

Get Signature

get typeName(): IdlTypeName

Defined in: packages/core/src/candid/idl.ts:719

Returns

IdlTypeName

Overrides

Methods

_buildTypeTableImpl()

_buildTypeTableImpl(_typeTable): void

Parameters

_typeTable

TypeTable

Returns

void

Inherited from

accept()

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

Defined in: packages/core/src/candid/idl.ts:733

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Overrides

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

checkType()

checkType(t): Type

Parameters

t

Returns

Inherited from

covariant()

covariant(x): x is number

Defined in: packages/core/src/candid/idl.ts:737

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

Parameters

x

any

Returns

x is number

Overrides

decodeValue()

decodeValue(b, t): number

Defined in: packages/core/src/candid/idl.ts:760

Parameters

b

t

Returns

number

Overrides

display()

display(): string

Returns

string

Inherited from

encodeType()

encodeType(): Uint8Array

Defined in: packages/core/src/candid/idl.ts:755

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

Returns

Uint8Array

Overrides

encodeValue()

encodeValue(x): Uint8Array<ArrayBuffer>

Defined in: packages/core/src/candid/idl.ts:744

Internal

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

Parameters

x

number

Returns

Uint8Array<ArrayBuffer>

Overrides

valueToString()

valueToString(x): string

Defined in: packages/core/src/candid/idl.ts:774

Parameters

x

number

Returns

string

Overrides

[hasInstance]()

static [hasInstance](instance): instance is FloatClass

Defined in: packages/core/src/candid/idl.ts:723

Parameters

instance

any

Returns

instance is FloatClass

FuncClass

Defined in: packages/core/src/candid/idl.ts:1785

Represents an IDL function reference.

Param

Argument types.

Param

Return types.

Param

Function annotations.

Extends

ConstructType<[Principal, string]>

Type Parameters

Args

Args extends GenericIdlFuncArgs = GenericIdlFuncArgs

Rets

Rets extends GenericIdlFuncRets = GenericIdlFuncRets

Constructors

Constructor

new FuncClass<Args, Rets>(argTypes, retTypes, annotations?): FuncClass<Args, Rets>

Defined in: packages/core/src/candid/idl.ts:1804

Parameters

argTypes

Args

retTypes

Rets

annotations?

string[] = []

Returns

FuncClass<Args, Rets>

Overrides

Properties

annotations

annotations: string[] = []

Defined in: packages/core/src/candid/idl.ts:1807

argTypes

argTypes: Args

Defined in: packages/core/src/candid/idl.ts:1805

retTypes

retTypes: Rets

Defined in: packages/core/src/candid/idl.ts:1806

Accessors

name

Get Signature

get name(): string

Defined in: packages/core/src/candid/idl.ts:1874

Returns

string

Overrides

typeName

Get Signature

get typeName(): IdlTypeName

Defined in: packages/core/src/candid/idl.ts:1789

Returns

IdlTypeName

Overrides

Methods

_buildTypeTableImpl()

_buildTypeTableImpl(T): void

Defined in: packages/core/src/candid/idl.ts:1838

Parameters

T

TypeTable

Returns

void

Overrides

accept()

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

Defined in: packages/core/src/candid/idl.ts:1812

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Overrides

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

checkType()

checkType(t): ConstructType<[Principal, string]>

Parameters

t

Returns

ConstructType<[Principal, string]>

Inherited from

covariant()

covariant(x): x is [Principal, string]

Defined in: packages/core/src/candid/idl.ts:1815

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

Parameters

x

any

Returns

x is [Principal, string]

Overrides

decodeValue()

decodeValue(b, t): [Principal, string]

Defined in: packages/core/src/candid/idl.ts:1853

Parameters

b

t

Returns

[Principal, string]

Overrides

display()

display(): string

Defined in: packages/core/src/candid/idl.ts:1885

Returns

string

Overrides

encodeType()

encodeType(typeTable): Uint8Array<ArrayBufferLike>

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

Parameters

typeTable

TypeTable

Returns

Uint8Array<ArrayBufferLike>

Inherited from

encodeValue()

encodeValue(__namedParameters): Uint8Array<ArrayBufferLike>

Defined in: packages/core/src/candid/idl.ts:1828

Internal

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

Parameters

__namedParameters

[Principal, string]

Returns

Uint8Array<ArrayBufferLike>

Overrides

valueToString()

valueToString(__namedParameters): string

Defined in: packages/core/src/candid/idl.ts:1881

Parameters

__namedParameters

[Principal, string]

Returns

string

Overrides

[hasInstance]()

static [hasInstance](instance): instance is FuncClass<GenericIdlFuncArgs, GenericIdlFuncRets>

Defined in: packages/core/src/candid/idl.ts:1793

Parameters

instance

any

Returns

instance is FuncClass<GenericIdlFuncArgs, GenericIdlFuncRets>

argsToString()

static argsToString(types, v): string

Defined in: packages/core/src/candid/idl.ts:1797

Parameters

types

Type<any>[]

v

any[]

Returns

string

IntClass

Defined in: packages/core/src/candid/idl.ts:624

Represents an IDL Int

Extends

PrimitiveType<bigint>

Constructors

Constructor

new IntClass(): IntClass

Returns

IntClass

Inherited from

Accessors

name

Get Signature

get name(): string

Defined in: packages/core/src/candid/idl.ts:659

Returns

string

Overrides

typeName

Get Signature

get typeName(): IdlTypeName

Defined in: packages/core/src/candid/idl.ts:625

Returns

IdlTypeName

Overrides

Methods

_buildTypeTableImpl()

_buildTypeTableImpl(_typeTable): void

Parameters

_typeTable

TypeTable

Returns

void

Inherited from

accept()

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

Defined in: packages/core/src/candid/idl.ts:633

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Overrides

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

checkType()

checkType(t): Type

Parameters

t

Returns

Inherited from

covariant()

covariant(x): x is bigint

Defined in: packages/core/src/candid/idl.ts:637

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

Parameters

x

any

Returns

x is bigint

Overrides

decodeValue()

decodeValue(b, t): bigint

Defined in: packages/core/src/candid/idl.ts:654

Parameters

b

t

Returns

bigint

Overrides

display()

display(): string

Returns

string

Inherited from

encodeType()

encodeType(): Uint8Array<ArrayBufferLike>

Defined in: packages/core/src/candid/idl.ts:650

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

Returns

Uint8Array<ArrayBufferLike>

Overrides

encodeValue()

encodeValue(x): Uint8Array

Defined in: packages/core/src/candid/idl.ts:646

Internal

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

Parameters

x

number | bigint

Returns

Uint8Array

Overrides

valueToString()

valueToString(x): string

Defined in: packages/core/src/candid/idl.ts:663

Parameters

x

bigint

Returns

string

Overrides

[hasInstance]()

static [hasInstance](instance): instance is IntClass

Defined in: packages/core/src/candid/idl.ts:629

Parameters

instance

any

Returns

instance is IntClass

NatClass

Defined in: packages/core/src/candid/idl.ts:671

Represents an IDL Nat

Extends

PrimitiveType<bigint>

Constructors

Constructor

new NatClass(): NatClass

Returns

NatClass

Inherited from

Accessors

name

Get Signature

get name(): string

Defined in: packages/core/src/candid/idl.ts:706

Returns

string

Overrides

typeName

Get Signature

get typeName(): IdlTypeName

Defined in: packages/core/src/candid/idl.ts:672

Returns

IdlTypeName

Overrides

Methods

_buildTypeTableImpl()

_buildTypeTableImpl(_typeTable): void

Parameters

_typeTable

TypeTable

Returns

void

Inherited from

accept()

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

Defined in: packages/core/src/candid/idl.ts:680

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Overrides

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

checkType()

checkType(t): Type

Parameters

t

Returns

Inherited from

covariant()

covariant(x): x is bigint

Defined in: packages/core/src/candid/idl.ts:684

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

Parameters

x

any

Returns

x is bigint

Overrides

decodeValue()

decodeValue(b, t): bigint

Defined in: packages/core/src/candid/idl.ts:701

Parameters

b

t

Returns

bigint

Overrides

display()

display(): string

Returns

string

Inherited from

encodeType()

encodeType(): Uint8Array<ArrayBufferLike>

Defined in: packages/core/src/candid/idl.ts:697

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

Returns

Uint8Array<ArrayBufferLike>

Overrides

encodeValue()

encodeValue(x): Uint8Array

Defined in: packages/core/src/candid/idl.ts:693

Internal

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

Parameters

x

number | bigint

Returns

Uint8Array

Overrides

valueToString()

valueToString(x): string

Defined in: packages/core/src/candid/idl.ts:710

Parameters

x

bigint

Returns

string

Overrides

[hasInstance]()

static [hasInstance](instance): instance is NatClass

Defined in: packages/core/src/candid/idl.ts:676

Parameters

instance

any

Returns

instance is NatClass

NullClass

Defined in: packages/core/src/candid/idl.ts:493

Represents an IDL Null

Extends

PrimitiveType<null>

Constructors

Constructor

new NullClass(): NullClass

Returns

NullClass

Inherited from

Accessors

name

Get Signature

get name(): string

Defined in: packages/core/src/candid/idl.ts:526

Returns

string

Overrides

typeName

Get Signature

get typeName(): IdlTypeName

Defined in: packages/core/src/candid/idl.ts:494

Returns

IdlTypeName

Overrides

Methods

_buildTypeTableImpl()

_buildTypeTableImpl(_typeTable): void

Parameters

_typeTable

TypeTable

Returns

void

Inherited from

accept()

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

Defined in: packages/core/src/candid/idl.ts:502

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Overrides

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

checkType()

checkType(t): Type

Parameters

t

Returns

Inherited from

covariant()

covariant(x): x is null

Defined in: packages/core/src/candid/idl.ts:506

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

Parameters

x

any

Returns

x is null

Overrides

decodeValue()

decodeValue(_b, t): null

Defined in: packages/core/src/candid/idl.ts:521

Parameters

_b

t

Returns

null

Overrides

display()

display(): string

Returns

string

Inherited from

encodeType()

encodeType(): Uint8Array

Defined in: packages/core/src/candid/idl.ts:517

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

Returns

Uint8Array

Overrides

encodeValue()

encodeValue(): Uint8Array

Defined in: packages/core/src/candid/idl.ts:513

Internal

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

Returns

Uint8Array

Overrides

valueToString()

valueToString(x): string

Parameters

x

null

Returns

string

Inherited from

[hasInstance]()

static [hasInstance](instance): instance is NullClass

Defined in: packages/core/src/candid/idl.ts:498

Parameters

instance

any

Returns

instance is NullClass

OptClass

Defined in: packages/core/src/candid/idl.ts:1120

Represents an IDL Option

Param

Extends

ConstructType<[T] | []>

Type Parameters

T

T

Constructors

Constructor

new OptClass<T>(_type): OptClass<T>

Defined in: packages/core/src/candid/idl.ts:1129

Parameters

_type

Type<T>

Returns

OptClass<T>

Overrides

Properties

_type

_type: Type<T>

Defined in: packages/core/src/candid/idl.ts:1129

Accessors

name

Get Signature

get name(): string

Defined in: packages/core/src/candid/idl.ts:1237

Returns

string

Overrides

typeName

Get Signature

get typeName(): IdlTypeName

Defined in: packages/core/src/candid/idl.ts:1121

Returns

IdlTypeName

Overrides

Methods

_buildTypeTableImpl()

_buildTypeTableImpl(typeTable): void

Defined in: packages/core/src/candid/idl.ts:1158

Parameters

typeTable

TypeTable

Returns

void

Overrides

accept()

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

Defined in: packages/core/src/candid/idl.ts:1133

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Overrides

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

checkType()

checkType(t): ConstructType<[] | [T]>

Parameters

t

Returns

ConstructType<[] | [T]>

Inherited from

covariant()

covariant(x): x is [] | [T]

Defined in: packages/core/src/candid/idl.ts:1137

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

Parameters

x

any

Returns

x is [] | [T]

Overrides

decodeValue()

decodeValue(b, t): [] | [T]

Defined in: packages/core/src/candid/idl.ts:1166

Parameters

b

t

Returns

[] | [T]

Overrides

display()

display(): string

Defined in: packages/core/src/candid/idl.ts:1241

Returns

string

Overrides

encodeType()

encodeType(typeTable): Uint8Array<ArrayBufferLike>

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

Parameters

typeTable

TypeTable

Returns

Uint8Array<ArrayBufferLike>

Inherited from

encodeValue()

encodeValue(x): Uint8Array

Defined in: packages/core/src/candid/idl.ts:1151

Internal

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

Parameters

x

[] | [T]

Returns

Uint8Array

Overrides

valueToString()

valueToString(x): string

Defined in: packages/core/src/candid/idl.ts:1245

Parameters

x

[] | [T]

Returns

string

Overrides

[hasInstance]()

static [hasInstance]<T>(instance): instance is OptClass<T>

Defined in: packages/core/src/candid/idl.ts:1125

Type Parameters

T

T

Parameters

instance

any

Returns

instance is OptClass<T>

`abstract` PrimitiveType

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

Represents an IDL type.

Extends

Type<T>

Extended by

EmptyClass
BoolClass
NullClass
ReservedClass
TextClass
IntClass
NatClass
FloatClass
FixedIntClass
FixedNatClass
PrincipalClass

Type Parameters

T

T = any

Constructors

Constructor

new PrimitiveType<T>(): PrimitiveType<T>

Returns

PrimitiveType<T>

Inherited from

Type.constructor

Properties

name

abstract readonly name: string

Defined in: packages/core/src/candid/idl.ts:247

Inherited from

Type.name

typeName

abstract readonly typeName: IdlTypeName

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

Inherited from

Type.typeName

Methods

_buildTypeTableImpl()

_buildTypeTableImpl(_typeTable): void

Type._buildTypeTableImpl

Parameters

_typeTable

TypeTable

Returns

void

Overrides

accept()

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

Defined in: packages/core/src/candid/idl.ts:248

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Inherited from

Type.accept

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

Type.buildTypeTable

checkType()

checkType(t): Type

Parameters

t

Returns

Overrides

Type.checkType

covariant()

abstract covariant(x): x is T

Defined in: packages/core/src/candid/idl.ts:270

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/core/src/candid/idl.ts:287

Parameters

x

t

Returns

T

Inherited from

Type.decodeValue

display()

display(): string

Returns

string

Inherited from

Type.display

encodeType()

abstract encodeType(typeTable): Uint8Array

Defined in: packages/core/src/candid/idl.ts:283

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

Parameters

typeTable

TypeTable

Returns

Uint8Array

Inherited from

Type.encodeType

encodeValue()

abstract encodeValue(x): Uint8Array

Defined in: packages/core/src/candid/idl.ts:277

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

Parameters

x

T

Returns

string

Inherited from

Type.valueToString

PrincipalClass

Defined in: packages/core/src/candid/idl.ts:1727

Represents an IDL principal reference

Extends

PrimitiveType<Principal>

Constructors

Constructor

new PrincipalClass(): PrincipalClass

Returns

PrincipalClass

Inherited from

Accessors

name

Get Signature

get name(): string

Defined in: packages/core/src/candid/idl.ts:1761

Returns

string

Overrides

typeName

Get Signature

get typeName(): IdlTypeName

Defined in: packages/core/src/candid/idl.ts:1728

Returns

IdlTypeName

Overrides

Methods

_buildTypeTableImpl()

_buildTypeTableImpl(_typeTable): void

Parameters

_typeTable

TypeTable

Returns

void

Inherited from

accept()

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

Defined in: packages/core/src/candid/idl.ts:1736

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Overrides

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

checkType()

checkType(t): Type

Parameters

t

Returns

Inherited from

covariant()

covariant(x): x is Principal

Defined in: packages/core/src/candid/idl.ts:1740

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

Parameters

x

any

Returns

x is Principal

Overrides

decodeValue()

decodeValue(b, t): Principal

Defined in: packages/core/src/candid/idl.ts:1756

Parameters

b

t

Returns

Overrides

display()

display(): string

Returns

string

Inherited from

encodeType()

encodeType(): Uint8Array

Defined in: packages/core/src/candid/idl.ts:1752

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

Returns

Uint8Array

Overrides

encodeValue()

encodeValue(x): Uint8Array

Defined in: packages/core/src/candid/idl.ts:1747

Internal

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

Parameters

x

Returns

Uint8Array

Overrides

valueToString()

valueToString(x): string

Defined in: packages/core/src/candid/idl.ts:1764

Parameters

x

Returns

string

Overrides

[hasInstance]()

static [hasInstance](instance): instance is PrincipalClass

Defined in: packages/core/src/candid/idl.ts:1732

Parameters

instance

any

Returns

instance is PrincipalClass

RecClass

Defined in: packages/core/src/candid/idl.ts:1637

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

Extends

ConstructType<T>

Type Parameters

T

T = any

Constructors

Constructor

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

Returns

RecClass<T>

Inherited from

Accessors

name

Get Signature

get name(): string

Defined in: packages/core/src/candid/idl.ts:1695

Returns

string

Overrides

typeName

Get Signature

get typeName(): IdlTypeName

Defined in: packages/core/src/candid/idl.ts:1638

Returns

IdlTypeName

Overrides

Methods

_buildTypeTableImpl()

_buildTypeTableImpl(typeTable): void

Defined in: packages/core/src/candid/idl.ts:1679

Parameters

typeTable

TypeTable

Returns

void

Overrides

accept()

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

Defined in: packages/core/src/candid/idl.ts:1650

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Overrides

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

checkType()

checkType(t): ConstructType<T>

Parameters

t

Returns

Inherited from

covariant()

covariant(x): x is T

Defined in: packages/core/src/candid/idl.ts:1665

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

Parameters

x

any

Returns

x is T

Overrides

decodeValue()

decodeValue(b, t): T

Defined in: packages/core/src/candid/idl.ts:1688

Parameters

b

t

Returns

T

Overrides

display()

display(): string

Defined in: packages/core/src/candid/idl.ts:1699

Returns

string

Overrides

encodeType()

encodeType(typeTable): Uint8Array<ArrayBufferLike>

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

Parameters

typeTable

TypeTable

Returns

Uint8Array<ArrayBufferLike>

Inherited from

encodeValue()

encodeValue(x): Uint8Array<ArrayBufferLike>

Defined in: packages/core/src/candid/idl.ts:1672

Internal

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

Parameters

x

T

Returns

Uint8Array<ArrayBufferLike>

Overrides

fill()

fill(t): void

Defined in: packages/core/src/candid/idl.ts:1657

Parameters

t

Returns

void

getType()

getType(): ConstructType<T> | undefined

Defined in: packages/core/src/candid/idl.ts:1661

Returns

ConstructType<T> | undefined

valueToString()

valueToString(x): string

Defined in: packages/core/src/candid/idl.ts:1706

Parameters

x

T

Returns

string

Overrides

[hasInstance]()

static [hasInstance](instance): instance is RecClass<any>

Defined in: packages/core/src/candid/idl.ts:1646

Parameters

instance

any

Returns

instance is RecClass<any>

RecordClass

Defined in: packages/core/src/candid/idl.ts:1257

Represents an IDL Record

Param

mapping of function name to Type

Extends

ConstructType<Record<string, any>>

Extended by

TupleClass

Constructors

Constructor

new RecordClass(fields?): RecordClass

Defined in: packages/core/src/candid/idl.ts:1271

Parameters

fields?

Record<string, Type> = {}

Returns

RecordClass

Overrides

Properties

_fields

readonly _fields: [string, Type<any>][]

Defined in: packages/core/src/candid/idl.ts:1269

Accessors

fieldsAsObject

Get Signature

get fieldsAsObject(): Record<number, Type>

Defined in: packages/core/src/candid/idl.ts:1394

Returns

Record<number, Type>

name

Get Signature

get name(): string

Defined in: packages/core/src/candid/idl.ts:1402

Returns

string

Overrides

typeName

Get Signature

get typeName(): IdlTypeName

Defined in: packages/core/src/candid/idl.ts:1258

Returns

IdlTypeName

Overrides

Methods

_buildTypeTableImpl()

_buildTypeTableImpl(T): void

Defined in: packages/core/src/candid/idl.ts:1321

Parameters

T

TypeTable

Returns

void

Overrides

accept()

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

Defined in: packages/core/src/candid/idl.ts:1276

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Overrides

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

checkType()

checkType(t): ConstructType<Record<string, any>>

Parameters

t

Returns

ConstructType<Record<string, any>>

Inherited from

covariant()

covariant(x): x is Record<string, any>

Defined in: packages/core/src/candid/idl.ts:1292

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

Parameters

x

any

Returns

x is Record<string, any>

Overrides

decodeValue()

decodeValue(b, t): Record<string, any>

Defined in: packages/core/src/candid/idl.ts:1332

Parameters

b

t

Returns

Record<string, any>

Overrides

display()

display(): string

Defined in: packages/core/src/candid/idl.ts:1407

Returns

string

Overrides

encodeType()

encodeType(typeTable): Uint8Array<ArrayBufferLike>

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

Parameters

typeTable

TypeTable

Returns

Uint8Array<ArrayBufferLike>

Inherited from

encodeValue()

encodeValue(x): Uint8Array

Defined in: packages/core/src/candid/idl.ts:1315

Internal

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

Parameters

x

Record<string, any>

Returns

Uint8Array

Overrides

tryAsTuple()

tryAsTuple(): Type<any>[] | null

Defined in: packages/core/src/candid/idl.ts:1280

Returns

Type<any>[] | null

valueToString()

valueToString(x): string

Defined in: packages/core/src/candid/idl.ts:1412

Parameters

x

Record<string, any>

Returns

string

Overrides

[hasInstance]()

static [hasInstance](instance): instance is RecordClass

Defined in: packages/core/src/candid/idl.ts:1262

Parameters

instance

any

Returns

instance is RecordClass

ReservedClass

Defined in: packages/core/src/candid/idl.ts:534

Represents an IDL Reserved

Extends

PrimitiveType<any>

Constructors

Constructor

new ReservedClass(): ReservedClass

Returns

ReservedClass

Inherited from

Accessors

name

Get Signature

get name(): string

Defined in: packages/core/src/candid/idl.ts:566

Returns

string

Overrides

typeName

Get Signature

get typeName(): IdlTypeName

Defined in: packages/core/src/candid/idl.ts:535

Returns

IdlTypeName

Overrides

Methods

_buildTypeTableImpl()

_buildTypeTableImpl(_typeTable): void

Parameters

_typeTable

TypeTable

Returns

void

Inherited from

accept()

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

Defined in: packages/core/src/candid/idl.ts:543

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Overrides

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

checkType()

checkType(t): Type

Parameters

t

Returns

Inherited from

covariant()

covariant(_x): _x is any

Defined in: packages/core/src/candid/idl.ts:547

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

Parameters

_x

any

Returns

_x is any

Overrides

decodeValue()

decodeValue(b, t): null

Defined in: packages/core/src/candid/idl.ts:559

Parameters

b

t

Returns

null

Overrides

display()

display(): string

Returns

string

Inherited from

encodeType()

encodeType(): Uint8Array

Defined in: packages/core/src/candid/idl.ts:555

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

Returns

Uint8Array

Overrides

encodeValue()

encodeValue(): Uint8Array

Defined in: packages/core/src/candid/idl.ts:551

Internal

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

Returns

Uint8Array

Overrides

valueToString()

valueToString(x): string

Parameters

x

any

Returns

string

Inherited from

[hasInstance]()

static [hasInstance](instance): instance is ReservedClass

Defined in: packages/core/src/candid/idl.ts:539

Parameters

instance

any

Returns

instance is ReservedClass

ServiceClass

Defined in: packages/core/src/candid/idl.ts:1911

Represents an IDL type.

Extends

ConstructType<Principal>

Type Parameters

K

K extends string = string

Fields

Fields extends GenericIdlServiceFields = GenericIdlServiceFields

Constructors

Constructor

new ServiceClass<K, Fields>(fields): ServiceClass<K, Fields>

Defined in: packages/core/src/candid/idl.ts:1924

Parameters

fields

Fields

Returns

ServiceClass<K, Fields>

Overrides

Properties

_fields

readonly _fields: [K, Fields[K]][]

Defined in: packages/core/src/candid/idl.ts:1923

Accessors

name

Get Signature

get name(): string

Defined in: packages/core/src/candid/idl.ts:1974

Returns

string

Overrides

typeName

Get Signature

get typeName(): IdlTypeName

Defined in: packages/core/src/candid/idl.ts:1915

Returns

IdlTypeName

Overrides

Methods

_buildTypeTableImpl()

_buildTypeTableImpl(T): void

Defined in: packages/core/src/candid/idl.ts:1952

Parameters

T

TypeTable

Returns

void

Overrides

accept()

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

Defined in: packages/core/src/candid/idl.ts:1936

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Overrides

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

checkType()

checkType(t): ConstructType<Principal>

Parameters

t

ConstructType<Principal>

Returns

Inherited from

covariant()

covariant(x): x is Principal

Defined in: packages/core/src/candid/idl.ts:1939

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

Parameters

x

any

Returns

x is Principal

Overrides

decodeValue()

decodeValue(b, t): Principal

Defined in: packages/core/src/candid/idl.ts:1965

Parameters

b

t

Returns

Overrides

display()

display(): string

Returns

string

Inherited from

encodeType()

encodeType(typeTable): Uint8Array<ArrayBufferLike>

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

Parameters

typeTable

TypeTable

Returns

Uint8Array<ArrayBufferLike>

Inherited from

encodeValue()

encodeValue(x): Uint8Array

Defined in: packages/core/src/candid/idl.ts:1946

Internal

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

Parameters

x

Returns

Uint8Array

Overrides

fieldsAsObject()

fieldsAsObject(): Fields

Defined in: packages/core/src/candid/idl.ts:1983

Returns

Fields

valueToString()

valueToString(x): string

Defined in: packages/core/src/candid/idl.ts:1979

Parameters

x

Returns

string

Overrides

[hasInstance]()

static [hasInstance](instance): instance is ServiceClass<string, GenericIdlServiceFields>

Defined in: packages/core/src/candid/idl.ts:1919

Parameters

instance

any

Returns

instance is ServiceClass<string, GenericIdlServiceFields>

TextClass

Defined in: packages/core/src/candid/idl.ts:574

Represents an IDL Text

Extends

PrimitiveType<string>

Constructors

Constructor

new TextClass(): TextClass

Returns

TextClass

Inherited from

Accessors

name

Get Signature

get name(): string

Defined in: packages/core/src/candid/idl.ts:612

Returns

string

Overrides

typeName

Get Signature

get typeName(): IdlTypeName

Defined in: packages/core/src/candid/idl.ts:575

Returns

IdlTypeName

Overrides

Methods

_buildTypeTableImpl()

_buildTypeTableImpl(_typeTable): void

Parameters

_typeTable

TypeTable

Returns

void

Inherited from

accept()

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

Defined in: packages/core/src/candid/idl.ts:583

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Overrides

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

checkType()

checkType(t): Type

Parameters

t

Returns

Inherited from

covariant()

covariant(x): x is string

Defined in: packages/core/src/candid/idl.ts:587

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

Parameters

x

any

Returns

x is string

Overrides

decodeValue()

decodeValue(b, t): string

Defined in: packages/core/src/candid/idl.ts:604

Parameters

b

t

Returns

string

Overrides

display()

display(): string

Returns

string

Inherited from

encodeType()

encodeType(): Uint8Array<ArrayBufferLike>

Defined in: packages/core/src/candid/idl.ts:600

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

Returns

Uint8Array<ArrayBufferLike>

Overrides

encodeValue()

encodeValue(x): Uint8Array<ArrayBufferLike>

Defined in: packages/core/src/candid/idl.ts:594

Internal

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

Parameters

x

string

Returns

Uint8Array<ArrayBufferLike>

Overrides

valueToString()

valueToString(x): string

Defined in: packages/core/src/candid/idl.ts:616

Parameters

x

string

Returns

string

Overrides

RecordClass.constructor

[hasInstance]()

static [hasInstance](instance): instance is TextClass

Defined in: packages/core/src/candid/idl.ts:579

Parameters

instance

any

Returns

instance is TextClass

TupleClass

Defined in: packages/core/src/candid/idl.ts:1423

Represents Tuple, a syntactic sugar for Record.

Param

Extends

RecordClass

Type Parameters

T

T extends any[]

Constructors

Constructor

new TupleClass<T>(_components): TupleClass<T>

Defined in: packages/core/src/candid/idl.ts:1434

Parameters

_components

Type<any>[]

Returns

TupleClass<T>

Overrides

Properties

_components

protected readonly _components: Type<any>[]

Defined in: packages/core/src/candid/idl.ts:1432

_fields

readonly _fields: [string, Type<any>][]

Defined in: packages/core/src/candid/idl.ts:1269

Inherited from

RecordClass._fields

Accessors

fieldsAsObject

Get Signature

get fieldsAsObject(): Record<number, Type>

Defined in: packages/core/src/candid/idl.ts:1394

Returns

Record<number, Type>

Inherited from

RecordClass.fieldsAsObject

name

Get Signature

get name(): string

Defined in: packages/core/src/candid/idl.ts:1402

Returns

string

Inherited from

RecordClass.name

typeName

Get Signature

get typeName(): IdlTypeName

Defined in: packages/core/src/candid/idl.ts:1424

Returns

IdlTypeName

Overrides

RecordClass.typeName

Methods

_buildTypeTableImpl()

_buildTypeTableImpl(T): void

Defined in: packages/core/src/candid/idl.ts:1321

Parameters

T

TypeTable

Returns

void

Inherited from

RecordClass._buildTypeTableImpl

accept()

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

Defined in: packages/core/src/candid/idl.ts:1441

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Overrides

RecordClass.accept

buildTypeTable()

buildTypeTable(typeTable): void

RecordClass.buildTypeTable

Parameters

typeTable

TypeTable

Returns

void

Inherited from

checkType()

checkType(t): ConstructType<Record<string, any>>

Parameters

t

RecordClass.checkType

Returns

ConstructType<Record<string, any>>

Inherited from

covariant()

covariant(x): x is T

Defined in: packages/core/src/candid/idl.ts:1445

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

Parameters

x

any

Returns

x is T

Overrides

RecordClass.covariant

decodeValue()

decodeValue(b, t): T

Defined in: packages/core/src/candid/idl.ts:1472

Parameters

b

t

RecordClass.decodeValue

Returns

T

Overrides

display()

display(): string

Defined in: packages/core/src/candid/idl.ts:1494

Returns

string

Overrides

RecordClass.display

encodeType()

encodeType(typeTable): Uint8Array<ArrayBufferLike>

RecordClass.encodeType

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

Parameters

typeTable

TypeTable

Returns

Uint8Array<ArrayBufferLike>

Inherited from

encodeValue()

encodeValue(x): Uint8Array

Defined in: packages/core/src/candid/idl.ts:1467

Internal

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

Parameters

x

any[]

Returns

Uint8Array

Overrides

RecordClass.encodeValue

tryAsTuple()

tryAsTuple(): Type<any>[] | null

Defined in: packages/core/src/candid/idl.ts:1280

Returns

Type<any>[] | null

Inherited from

RecordClass.tryAsTuple

valueToString()

valueToString(values): string

Defined in: packages/core/src/candid/idl.ts:1499

Parameters

values

any[]

Returns

string

Overrides

RecordClass.valueToString

[hasInstance]()

static [hasInstance]<T>(instance): instance is TupleClass<T>

Defined in: packages/core/src/candid/idl.ts:1428

Type Parameters

T

T extends any[]

Parameters

instance

any

Returns

instance is TupleClass<T>

Overrides

RecordClass.[hasInstance]

`abstract` Type

Defined in: packages/core/src/candid/idl.ts:245

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/core/src/candid/idl.ts:247

typeName

abstract readonly typeName: IdlTypeName

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

Methods

_buildTypeTableImpl()

abstract protected _buildTypeTableImpl(typeTable): void

Defined in: packages/core/src/candid/idl.ts:289

Parameters

typeTable

TypeTable

Returns

void

accept()

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

Defined in: packages/core/src/candid/idl.ts:248

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

checkType()

abstract checkType(t): Type

Defined in: packages/core/src/candid/idl.ts:285

Parameters

t

Returns

covariant()

abstract covariant(x): x is T

Defined in: packages/core/src/candid/idl.ts:270

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/core/src/candid/idl.ts:287

Parameters

x

t

Returns

T

display()

display(): string

Returns

string

encodeType()

abstract encodeType(typeTable): Uint8Array

Defined in: packages/core/src/candid/idl.ts:283

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/core/src/candid/idl.ts:277

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

Type._buildTypeTableImpl

Parameters

x

T

Returns

string

UnknownClass

Defined in: packages/core/src/candid/idl.ts:371

Represents an IDL Unknown, a placeholder type for deserialization only. When decoding a value as Unknown, all fields will be retained but the names are only available in hashed form. A deserialized unknown will offer it’s actual type by calling the type() function. Unknown cannot be serialized and attempting to do so will throw an error.

Extends

Type

Constructors

Constructor

new UnknownClass(): UnknownClass

Returns

UnknownClass

Inherited from

Type.constructor

Accessors

name

Get Signature

get name(): string

Defined in: packages/core/src/candid/idl.ts:437

Returns

string

Overrides

Type.name

typeName

Get Signature

get typeName(): IdlTypeName

Defined in: packages/core/src/candid/idl.ts:372

Returns

IdlTypeName

Overrides

Type.typeName

Methods

_buildTypeTableImpl()

protected _buildTypeTableImpl(): void

Defined in: packages/core/src/candid/idl.ts:433

Returns

void

Overrides

accept()

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

Defined in: packages/core/src/candid/idl.ts:384

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Overrides

Type.accept

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

Type.buildTypeTable

checkType()

checkType(_t): Type

Defined in: packages/core/src/candid/idl.ts:380

Parameters

_t

Returns

Overrides

Type.checkType

covariant()

covariant(x): x is any

Defined in: packages/core/src/candid/idl.ts:388

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

Parameters

x

any

Returns

x is any

Overrides

Type.covariant

decodeValue()

decodeValue(b, t): any

Defined in: packages/core/src/candid/idl.ts:404

Parameters

b

t

Returns

any

Overrides

Type.decodeValue

display()

display(): string

Returns

string

Inherited from

Type.display

encodeType()

encodeType(): never

Defined in: packages/core/src/candid/idl.ts:400

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

Returns

never

Overrides

Type.encodeType

encodeValue()

encodeValue(): never

Defined in: packages/core/src/candid/idl.ts:392

Internal

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

Returns

never

Overrides

Type.encodeValue

valueToString()

valueToString(): never

Defined in: packages/core/src/candid/idl.ts:396

Returns

never

Overrides

Type.valueToString

[hasInstance]()

static [hasInstance](instance): instance is UnknownClass

Defined in: packages/core/src/candid/idl.ts:376

Parameters

instance

any

Returns

instance is UnknownClass

VariantClass

Defined in: packages/core/src/candid/idl.ts:1509

Represents an IDL Variant

Param

mapping of function name to Type

Extends

ConstructType<Record<string, any>>

Constructors

Constructor

new VariantClass(fields?): VariantClass

Defined in: packages/core/src/candid/idl.ts:1520

Parameters

fields?

Record<string, Type> = {}

Returns

VariantClass

Overrides

Properties

_fields

readonly _fields: [string, Type<any>][]

Defined in: packages/core/src/candid/idl.ts:1518

Accessors

alternativesAsObject

Get Signature

get alternativesAsObject(): Record<number, Type>

Defined in: packages/core/src/candid/idl.ts:1624

Returns

Record<number, Type>

name

Get Signature

get name(): string

Defined in: packages/core/src/candid/idl.ts:1598

Returns

string

Overrides

typeName

Get Signature

get typeName(): IdlTypeName

Defined in: packages/core/src/candid/idl.ts:1510

Returns

IdlTypeName

Overrides

Methods

_buildTypeTableImpl()

_buildTypeTableImpl(typeTable): void

Defined in: packages/core/src/candid/idl.ts:1564

Parameters

typeTable

TypeTable

Returns

void

Overrides

accept()

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

Defined in: packages/core/src/candid/idl.ts:1525

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Overrides

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

checkType()

checkType(t): ConstructType<Record<string, any>>

Parameters

t

Returns

ConstructType<Record<string, any>>

Inherited from

covariant()

covariant(x): x is Record<string, any>

Defined in: packages/core/src/candid/idl.ts:1529

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

Parameters

x

any

Returns

x is Record<string, any>

Overrides

decodeValue()

decodeValue(b, t): object

Defined in: packages/core/src/candid/idl.ts:1576

Parameters

b

t

Returns

object

Overrides

display()

display(): string

Defined in: packages/core/src/candid/idl.ts:1603

Returns

string

Overrides

encodeType()

encodeType(typeTable): Uint8Array<ArrayBufferLike>

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

Parameters

typeTable

TypeTable

Returns

Uint8Array<ArrayBufferLike>

Inherited from

encodeValue()

encodeValue(x): Uint8Array<ArrayBufferLike>

Defined in: packages/core/src/candid/idl.ts:1550

Internal

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

Parameters

x

Record<string, any>

Returns

Uint8Array<ArrayBufferLike>

Overrides

valueToString()

valueToString(x): string

Defined in: packages/core/src/candid/idl.ts:1610

Parameters

x

Record<string, any>

Returns

string

Overrides

[hasInstance]()

static [hasInstance](instance): instance is VariantClass

Defined in: packages/core/src/candid/idl.ts:1514

Parameters

instance

any

Returns

instance is VariantClass

VecClass

Defined in: packages/core/src/candid/idl.ts:911

Represents an IDL Array

Arrays of fixed-sized nat/int type (e.g. nat8), are encoded from and decoded to TypedArrays (e.g. Uint8Array). Arrays of float or other non-primitive types are encoded/decoded as untyped array in Javascript.

Param

Extends

ConstructType<T[]>

Type Parameters

T

T

Constructors

Constructor

new VecClass<T>(_type): VecClass<T>

Defined in: packages/core/src/candid/idl.ts:928

Parameters

_type

Type<T>

Returns

VecClass<T>

Overrides

Properties

_type

_type: Type<T>

Defined in: packages/core/src/candid/idl.ts:928

Accessors

name

Get Signature

get name(): string

Defined in: packages/core/src/candid/idl.ts:1102

Returns

string

Overrides

typeName

Get Signature

get typeName(): IdlTypeName

Defined in: packages/core/src/candid/idl.ts:912

Returns

IdlTypeName

Overrides

Methods

_buildTypeTableImpl()

_buildTypeTableImpl(typeTable): void

Defined in: packages/core/src/candid/idl.ts:1021

Parameters

typeTable

TypeTable

Returns

void

Overrides

accept()

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

Defined in: packages/core/src/candid/idl.ts:935

Type Parameters

D

D

R

R

Parameters

v

Visitor<D, R>

d

D

Returns

R

Overrides

buildTypeTable()

buildTypeTable(typeTable): void

Parameters

typeTable

TypeTable

Returns

void

Inherited from

checkType()

checkType(t): ConstructType<T[]>

Parameters

t

Returns

ConstructType<T[]>

Inherited from

covariant()

covariant(x): x is T[]

Defined in: packages/core/src/candid/idl.ts:939

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

Parameters

x

any

Returns

x is T[]

Overrides

decodeValue()

decodeValue(b, t): T[]

Defined in: packages/core/src/candid/idl.ts:1029

Parameters

b

t

Returns

T[]

Overrides

display()

display(): string

Defined in: packages/core/src/candid/idl.ts:1106

Returns

string

Overrides

encodeType()

encodeType(typeTable): Uint8Array<ArrayBufferLike>

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

Parameters

typeTable

TypeTable

Returns

Uint8Array<ArrayBufferLike>

Inherited from

encodeValue()

encodeValue(x): Uint8Array

Defined in: packages/core/src/candid/idl.ts:968

Internal

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

Parameters

x

T[]

Returns

Uint8Array

Overrides

valueToString()

valueToString(x): string

Defined in: packages/core/src/candid/idl.ts:1110

Parameters

x

T[]

Returns

string

Overrides

[hasInstance]()

static [hasInstance]<T>(instance): instance is VecClass<T>

Defined in: packages/core/src/candid/idl.ts:916

Type Parameters

T

T

Parameters

instance

any

Returns

instance is VecClass<T>

`abstract` Visitor

Defined in: packages/core/src/candid/idl.ts:144

Extended by

Render

Type Parameters

D

D

R

R

Constructors

Constructor

new Visitor<D, R>(): Visitor<D, R>

Returns

Visitor<D, R>

Methods

visitBool()

visitBool(t, data): R

Defined in: packages/core/src/candid/idl.ts:154

Parameters

t

BoolClass

data

D

Returns

R

visitConstruct()

visitConstruct<T>(t, data): R

Defined in: packages/core/src/candid/idl.ts:188

Type Parameters

T

T

Parameters

t

data

D

Returns

R

visitEmpty()

visitEmpty(t, data): R

Defined in: packages/core/src/candid/idl.ts:151

Parameters

t

EmptyClass

data

D

Returns

R

visitFixedInt()

visitFixedInt(t, data): R

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

Parameters

t

data

D

Returns

R

visitFixedNat()

visitFixedNat(t, data): R

Defined in: packages/core/src/candid/idl.ts:181

Parameters

t

data

D

Returns

R

visitFloat()

visitFloat(t, data): R

Defined in: packages/core/src/candid/idl.ts:175

Parameters

t

data

D

Returns

R

visitFunc()

visitFunc(t, data): R

Defined in: packages/core/src/candid/idl.ts:210

Parameters

t

FuncClass

data

D

Returns

R

visitInt()

visitInt(t, data): R

Defined in: packages/core/src/candid/idl.ts:169

Parameters

t

IntClass

data

D

Returns

R

visitNat()

visitNat(t, data): R

Defined in: packages/core/src/candid/idl.ts:172

Parameters

t

NatClass

data

D

Returns

R

visitNull()

visitNull(t, data): R

Defined in: packages/core/src/candid/idl.ts:157

Parameters

t

NullClass

data

D

Returns

R

visitNumber()

visitNumber<T>(t, data): R

Defined in: packages/core/src/candid/idl.ts:166

Type Parameters

T

T

Parameters

t

PrimitiveType<T>

data

D

Returns

R

visitOpt()

visitOpt<T>(t, _ty, data): R

Defined in: packages/core/src/candid/idl.ts:194

Type Parameters

T

T

Parameters

t

OptClass<T>

_ty

Type<T>

data

D

Returns

R

visitPrimitive()

visitPrimitive<T>(t, data): R

Defined in: packages/core/src/candid/idl.ts:148

Type Parameters

T

T

Parameters

t

PrimitiveType<T>

data

D

Returns

R

visitPrincipal()

visitPrincipal(t, data): R

Defined in: packages/core/src/candid/idl.ts:184

Parameters

t

PrincipalClass

data

D

Returns

R

visitRec()

visitRec<T>(_t, ty, data): R

Defined in: packages/core/src/candid/idl.ts:207

Type Parameters

T

T

Parameters

_t

RecClass<T>

ty

data

D

Returns

R

visitRecord()

visitRecord(t, _fields, data): R

Defined in: packages/core/src/candid/idl.ts:197

Parameters

t

RecordClass

_fields

[string, Type<any>][]

data

D

Returns

R

visitReserved()

visitReserved(t, data): R

Defined in: packages/core/src/candid/idl.ts:160

Parameters

t

ReservedClass

data

D

Returns

R

visitService()

visitService(t, data): R

Defined in: packages/core/src/candid/idl.ts:213

Parameters

t

ServiceClass

data

D

Returns

R

visitText()

visitText(t, data): R

Defined in: packages/core/src/candid/idl.ts:163

Parameters

t

TextClass

data

D

Returns

R

visitTuple()

visitTuple<T>(t, components, data): R

Defined in: packages/core/src/candid/idl.ts:200

Type Parameters

T

T extends any[]

Parameters

t

TupleClass<T>

components

Type<any>[]

data

D

Returns

R

visitType()

visitType<T>(_t, _data): R

Defined in: packages/core/src/candid/idl.ts:145

Type Parameters

T

T

Parameters

_t

Type<T>

_data

D

Returns

R

visitVariant()

visitVariant(t, _fields, data): R

Defined in: packages/core/src/candid/idl.ts:204

Parameters

t

VariantClass

_fields

[string, Type<any>][]

data

D

Returns

R

visitVec()

visitVec<T>(t, _ty, data): R

Defined in: packages/core/src/candid/idl.ts:191

Type Parameters

T

T

Parameters

t

VecClass<T>

_ty

Type<T>

data

D

Returns

R

Type Aliases

GenericIdlFuncArgs

GenericIdlFuncArgs = [Type, ...Type[]] | []

Defined in: packages/core/src/candid/idl.ts:1772

The generic type of the arguments of an IDL Function.

GenericIdlFuncRets

GenericIdlFuncRets = [Type, ...Type[]] | []

Defined in: packages/core/src/candid/idl.ts:1777

The generic type of the return values of an IDL Function.

GenericIdlServiceFields

GenericIdlServiceFields = Record<string, FuncClass>

Defined in: packages/core/src/candid/idl.ts:1909

The generic type of the fields of an IDL Service.

InterfaceFactory

InterfaceFactory = (idl) => ServiceClass

Defined in: packages/core/src/candid/idl.ts:2307

An Interface Factory, normally provided by a Candid code generation.

Parameters

idl

IDL

{ Bool: BoolClass; Empty: EmptyClass; Float32: FloatClass; Float64: FloatClass; Func: typeof Func; Int: IntClass; Int16: FixedIntClass; Int32: FixedIntClass; Int64: FixedIntClass; Int8: FixedIntClass; Nat: NatClass; Nat16: FixedNatClass; Nat32: FixedNatClass; Nat64: FixedNatClass; Nat8: FixedNatClass; Null: NullClass; Opt: typeof Opt; Principal: PrincipalClass; Rec: typeof Rec; Record: typeof Record; Reserved: ReservedClass; Text: TextClass; Tuple: typeof Tuple; Unknown: UnknownClass; Variant: typeof Variant; Vec: typeof Vec; Service: ServiceClass; }

IDL.Bool

BoolClass

IDL.Empty

EmptyClass

IDL.Float32

IDL.Float64

IDL.Func

typeof Func

IDL.Int

IntClass

IDL.Int16

IDL.Int32

IDL.Int64

IDL.Int8

IDL.Nat

NatClass

IDL.Nat16

IDL.Nat32

IDL.Nat64

IDL.Nat8

IDL.Null

NullClass

IDL.Opt

typeof Opt

IDL.Principal

PrincipalClass

IDL.Rec

typeof Rec

IDL.Record

typeof Record

IDL.Reserved

ReservedClass

IDL.Text

TextClass

IDL.Tuple

typeof Tuple

IDL.Unknown

UnknownClass

IDL.Variant

typeof Variant

IDL.Vec

typeof Vec

IDL.Service

Returns

ServiceClass

Variables

Bool

const Bool: BoolClass

Defined in: packages/core/src/candid/idl.ts:2352

Empty

const Empty: EmptyClass

Defined in: packages/core/src/candid/idl.ts:2346

Float32

const Float32: FloatClass

Defined in: packages/core/src/candid/idl.ts:2358

Float64

const Float64: FloatClass

Defined in: packages/core/src/candid/idl.ts:2359

Int

const Int: IntClass

Defined in: packages/core/src/candid/idl.ts:2355

Int16

const Int16: FixedIntClass

Defined in: packages/core/src/candid/idl.ts:2362

Int32

const Int32: FixedIntClass

Defined in: packages/core/src/candid/idl.ts:2363

Int64

const Int64: FixedIntClass

Defined in: packages/core/src/candid/idl.ts:2364

Int8

const Int8: FixedIntClass

Defined in: packages/core/src/candid/idl.ts:2361

Nat

const Nat: NatClass

Defined in: packages/core/src/candid/idl.ts:2356

Nat16

const Nat16: FixedNatClass

Defined in: packages/core/src/candid/idl.ts:2367

Nat32

const Nat32: FixedNatClass

Defined in: packages/core/src/candid/idl.ts:2368

Nat64

const Nat64: FixedNatClass

Defined in: packages/core/src/candid/idl.ts:2369

Nat8

const Nat8: FixedNatClass

Defined in: packages/core/src/candid/idl.ts:2366

Null

const Null: NullClass

Defined in: packages/core/src/candid/idl.ts:2353

Principal

const Principal: PrincipalClass

Defined in: packages/core/src/candid/idl.ts:2371

Reserved

const Reserved: ReservedClass

Defined in: packages/core/src/candid/idl.ts:2347

Text

const Text: TextClass

Defined in: packages/core/src/candid/idl.ts:2354

Unknown

const Unknown: UnknownClass

Defined in: packages/core/src/candid/idl.ts:2351

Client-only type for deserializing unknown data. Not supported by Candid, and its use is discouraged.

Functions

decode()

decode(retTypes, bytes): JsonValue[]

Defined in: packages/core/src/candid/idl.ts:2046

Decode a binary value

Parameters

retTypes

Type<any>[]

Types expected in the buffer.

bytes

Uint8Array

hex-encoded string, or buffer.

Returns

JsonValue[]

Value deserialised to JS type

encode()

encode(argTypes, args): Uint8Array

Defined in: packages/core/src/candid/idl.ts:2013

Encode a array of values

Parameters

argTypes

Type<any>[]

array of Types

args

any[]

array of values

Returns

Uint8Array

serialised value

Func()

Func<Args, Ret>(args, ret, annotations?): FuncClass<Args, Ret>

Defined in: packages/core/src/candid/idl.ts:2429

Type Parameters

Args

Args extends GenericIdlFuncArgs = GenericIdlFuncArgs

Ret

Ret extends GenericIdlFuncRets = GenericIdlFuncRets

Parameters

args

Args

array of IDL Types

ret

Ret

array of IDL Types

annotations?

string[] = []

array of strings, [] by default

Returns

FuncClass<Args, Ret>

new FuncClass

Opt()

Opt<T>(t): OptClass<T>

Defined in: packages/core/src/candid/idl.ts:2394

Type Parameters

T

T

Parameters

t

Type<T>

IDL Type

Returns

OptClass<T>

OptClass of Type

Rec()

Rec(): RecClass

Defined in: packages/core/src/candid/idl.ts:2418

Returns

RecClass

new RecClass

Record()

Record(t): RecordClass

Defined in: packages/core/src/candid/idl.ts:2402

Parameters

t

Record<string, Type>

Record of string and IDL Type

Returns

RecordClass

RecordClass of string and Type

resetSubtypeCache()

resetSubtypeCache(): void

Defined in: packages/core/src/candid/idl.ts:2508

Resets the global subtyping cache

Returns

void

Service()

Service<K, Fields>(t): ServiceClass<K, Fields>

Defined in: packages/core/src/candid/idl.ts:2441

Type Parameters

K

K extends string = string

Fields

Fields extends GenericIdlServiceFields = GenericIdlServiceFields

Parameters

t

Fields

Record of string and FuncClass

Returns

ServiceClass<K, Fields>

ServiceClass

subtype()

subtype(t1, t2): boolean

Defined in: packages/core/src/candid/idl.ts:2535

Subtyping on Candid types t1 <: t2 (Exported for testing)

Parameters

t1

The potential subtype

t2