Class TupleClass<T>

Represents Tuple, a syntactic sugar for Record.

param components

Type Parameters

T extends any[]

Hierarchy

RecordClass
- TupleClass

Index

Constructors

constructor

Properties

Accessors

name

Methods

Constructors

constructor

new TupleClass<T>(_components: Type<any>[]): TupleClass<T>

Overrides RecordClass.constructor
- Defined in packages/candid/src/idl.ts:1091
Type Parameters
- T extends any[]
Parameters
- _components: Type<any>[]
Returns TupleClass<T>

Properties

Protected Readonly _components

_components: Type<any>[]

Protected Readonly _fields

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

Accessors

name

get name(): string

Inherited from RecordClass.name
- Defined in packages/candid/src/idl.ts:1067
Returns string

Methods

_buildTypeTableImpl

_buildTypeTableImpl(T: TypeTable): void

Inherited from RecordClass._buildTypeTableImpl
- Defined in packages/candid/src/idl.ts:1002
Parameters
- T: TypeTable
Returns void

accept

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

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

buildTypeTable

buildTypeTable(typeTable: TypeTable): void

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

checkType

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

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

covariant

covariant(x: any): x is T

Overrides RecordClass.covariant
- Defined in packages/candid/src/idl.ts:1102
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 RecordClass.decodeValue
- Defined in packages/candid/src/idl.ts:1126
Parameters
- b: PipeArrayBuffer
- t: Type<any>
Returns T

display

display(): string

Overrides RecordClass.display
- Defined in packages/candid/src/idl.ts:1146
Returns string

encodeType

encodeType(typeTable: TypeTable): ArrayBuffer

Inherited from RecordClass.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: any[]): ArrayBuffer

Overrides RecordClass.encodeValue
- Defined in packages/candid/src/idl.ts:1121
Parameters
- x: any[]
Returns ArrayBuffer

tryAsTuple

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

Inherited from RecordClass.tryAsTuple
- Defined in packages/candid/src/idl.ts:964
Returns null | Type<any>[]

valueToString

valueToString(values: any[]): string

Overrides RecordClass.valueToString
- Defined in packages/candid/src/idl.ts:1151
Parameters
- values: any[]
Returns string

Generated using TypeDoc