Skip to main content

Class: BcsTuple<T, Name>

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>

Parameters

__namedParameters

BcsTupleOptions<T, Name>

Returns

BcsTuple<T, Name>

Overrides

BcsType.constructor

Properties

$inferType

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

Inherited from

BcsType.$inferType


$inferInput

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

Inherited from

BcsType.$inferInput


name

name: Name

Inherited from

BcsType.name


read()

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

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

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

Parameters

value

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

Returns

void

Inherited from

BcsType.validate

Methods

write()

write(value, writer): void

Parameters

value

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

writer

BcsWriter

Returns

void

Inherited from

BcsType.write


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 }>

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


parse()

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

Parameters

bytes

Uint8Array

Returns

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

Inherited from

BcsType.parse


fromHex()

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

Parameters

hex

string

Returns

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

Inherited from

BcsType.fromHex


fromBase58()

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

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 }

Parameters

b64

string

Returns

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

Inherited from

BcsType.fromBase64


transform()

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

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