BcsTuple

@iota/iota-sdk

---

@iota/iota-sdk / bcs / BcsTuple

Class: BcsTuple<T, Name>

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:118

Extends

• BcsType<{ -readonly [K in keyof T]: T[K] extends BcsType<infer T, any> ? T : never }, { [K in keyof T]: T[K] extends BcsType<any, infer T> ? T : never }, Name>

Type Parameters

T

T extends readonly BcsType<any>[]

Name

Name extends string = `(${JoinString<{ [K in keyof T]: T[K] extends BcsType<any, any, infer T> ? T : never }, ", ">})`

Constructors

Constructor

new BcsTuple<T, Name>(__namedParameters): BcsTuple<T, Name>

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:125

Parameters

__namedParameters

BcsTupleOptions<T, Name>

Returns

BcsTuple<T, Name>

Overrides

BcsType.constructor

Properties

$inferInput

$inferInput: { [K in string | number | symbol]: T[K] extends BcsType<any, T, string> ? T : never }

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:12

Inherited from

BcsType.$inferInput

---

$inferType

$inferType: { -readonly [K in string | number | symbol]: T[K] extends BcsType<T, any, string> ? T : never }

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:11

Inherited from

BcsType.$inferType

---

name

name: Name

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:13

Inherited from

BcsType.name

---

read

read: (reader) => { -readonly [K in string | number | symbol]: T[K] extends BcsType<T, any, string> ? T : never }

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:14

Parameters

reader

BcsReader

Returns

{ -readonly [K in string | number | symbol]: T[K] extends BcsType<T, any, string> ? T : never }

Inherited from

BcsType.read

---

serializedSize

serializedSize: (value, options?) => number | null

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:15

Parameters

value

{ [K in string | number | symbol]: T[K] extends BcsType<any, T, string> ? T : never }

options?

BcsWriterOptions

Returns

number | null

Inherited from

BcsType.serializedSize

---

validate

validate: (value) => void

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:16

Parameters

value

{ [K in string | number | symbol]: T[K] extends BcsType<any, T, string> ? T : never }

Returns

void

Inherited from

BcsType.validate

Methods

fromBase58()

fromBase58(b64): { -readonly [K in string | number | symbol]: T[K] extends BcsType<T, any, string> ? T : never }

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:29

Parameters

b64

string

Returns

{ -readonly [K in string | number | symbol]: T[K] extends BcsType<T, any, string> ? T : never }

Inherited from

BcsType.fromBase58

---

fromBase64()

fromBase64(b64): { -readonly [K in string | number | symbol]: T[K] extends BcsType<T, any, string> ? T : never }

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:30

Parameters

b64

string

Returns

{ -readonly [K in string | number | symbol]: T[K] extends BcsType<T, any, string> ? T : never }

Inherited from

BcsType.fromBase64

---

fromHex()

fromHex(hex): { -readonly [K in string | number | symbol]: T[K] extends BcsType<T, any, string> ? T : never }

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:28

Parameters

hex

string

Returns

{ -readonly [K in string | number | symbol]: T[K] extends BcsType<T, any, string> ? T : never }

Inherited from

BcsType.fromHex

---

parse()

parse(bytes): { -readonly [K in string | number | symbol]: T[K] extends BcsType<T, any, string> ? T : never }

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:27

Parameters

bytes

Uint8Array

Returns

{ -readonly [K in string | number | symbol]: T[K] extends BcsType<T, any, string> ? T : never }

Inherited from

BcsType.parse

---

serialize()

serialize(value, options?): SerializedBcs<{ -readonly [K in string | number | symbol]: T[K] extends BcsType<T, any, string> ? T : never }, { [K in string | number | symbol]: T[K] extends BcsType<any, T, string> ? T : never }>

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:26

Parameters

value

{ [K in string | number | symbol]: T[K] extends BcsType<any, T, string> ? T : never }

options?

BcsWriterOptions

Returns

SerializedBcs<{ -readonly [K in string | number | symbol]: T[K] extends BcsType<T, any, string> ? T : never }, { [K in string | number | symbol]: T[K] extends BcsType<any, T, string> ? T : never }>

Inherited from

BcsType.serialize

---

transform()

transform<T2, Input2, NewName>(__namedParameters): BcsType<T2, Input2, NewName>

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:31

Type Parameters

T2

T2 = { -readonly [K in string | number | symbol]: T[K] extends BcsType<T, any, string> ? T : never }

Input2

Input2 = { [K in string | number | symbol]: T[K] extends BcsType<any, T, string> ? T : never }

NewName

NewName extends string = Name

Parameters

__namedParameters

object & BcsTypeOptions<T2, Input2, NewName>

Returns

BcsType<T2, Input2, NewName>

Inherited from

BcsType.transform

---

write()

write(value, writer): void

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:25

Parameters

value

{ [K in string | number | symbol]: T[K] extends BcsType<any, T, string> ? T : never }

writer

BcsWriter

Returns

void

Inherited from

BcsType.write