Class TupleClass<T>

Represents Tuple, a syntactic sugar for Record.

Param: components

Type Parameters

T extends any[]

Hierarchy (View Summary)

types.IDL.RecordClass
- TupleClass

Index

Constructors

Properties

_fields _components

Accessors

fieldsAsObject name typeName

Methods

buildTypeTable checkType encodeType tryAsTuple _buildTypeTableImpl [hasInstance] accept covariant encodeValue decodeValue display valueToString

Constructors

constructor

new TupleClass<T extends any[]>(
_components: types.IDL.Type<any>[],
): types.IDL.TupleClass<T>
Type Parameters
- T extends any[]
Parameters
- _components: types.IDL.Type<any>[]
Returns types.IDL.TupleClass<T>
Overrides RecordClass.constructor
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:334

Properties

`Readonly`_fields

_fields: [string, types.IDL.Type<any>][]

`Protected` `Readonly`_components

_components: types.IDL.Type<any>[]

Accessors

fieldsAsObject

get fieldsAsObject(): Record<number, types.IDL.Type>
Returns Record<number, types.IDL.Type>
Inherited from RecordClass.fieldsAsObject
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:321

name

get name(): string
Returns string
Inherited from RecordClass.name
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:322

typeName

get typeName(): IdlTypeName
Returns IdlTypeName
Overrides RecordClass.typeName
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:331

Methods

buildTypeTable

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

checkType

checkType(t: types.IDL.Type): types.IDL.ConstructType<Record<string, any>>
Parameters
- t: types.IDL.Type
Returns types.IDL.ConstructType<Record<string, any>>
Inherited from RecordClass.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>
Inherited from RecordClass.encodeType
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:99

tryAsTuple

tryAsTuple(): null | types.IDL.Type<any>[]
Returns null | types.IDL.Type<any>[]
Inherited from RecordClass.tryAsTuple
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:316

_buildTypeTableImpl

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

`Static`[hasInstance]

"[hasInstance]"<T extends any[]>(
instance: any,
): instance is types.IDL.TupleClass<T>
Type Parameters
- T extends any[]
Parameters
- instance: any
Returns instance is types.IDL.TupleClass<T>
Overrides RecordClass.[hasInstance]
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:332

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
Overrides RecordClass.accept
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:335

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
Overrides RecordClass.covariant
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:336

encodeValue

encodeValue(x: any[]): Uint8Array
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
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:337

decodeValue

decodeValue(b: utils.candid.PipeArrayBuffer, t: types.IDL.Type): T
Parameters
- b: utils.candid.PipeArrayBuffer
- t: types.IDL.Type
Returns T
Overrides RecordClass.decodeValue
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:338

display

display(): string
Returns string
Overrides RecordClass.display
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:339

valueToString

valueToString(values: any[]): string
Parameters
- values: any[]
Returns string
Overrides RecordClass.valueToString
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:340