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

Type ParameterDefault type
T extends readonly BcsType<any>[]-
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

ParameterType
__namedParametersBcsTupleOptions<T, Name>

Returns

BcsTuple<T, Name>

Overrides

BcsType.constructor

Properties

PropertyTypeInherited from
$inferType{ -readonly [K in string | number | symbol]: T[K] extends BcsType<T, any, string> ? T : never }BcsType.$inferType
$inferInput{ [K in string | number | symbol]: T[K] extends BcsType<any, T, string> ? T : never }BcsType.$inferInput
nameNameBcsType.name
read(reader) => { -readonly [K in string | number | symbol]: T[K] extends BcsType<T, any, string> ? T : never }BcsType.read
serializedSize(value, options?) => number | nullBcsType.serializedSize
validate(value) => voidBcsType.validate

Methods

write()

write(value, writer): void;

Parameters

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

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

ParameterType
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

ParameterType
bytesUint8Array

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

ParameterType
hexstring

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

ParameterType
b64string

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

ParameterType
b64string

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

Type ParameterDefault type
T2{ -readonly [K in string | number | symbol]: T[K] extends BcsType<T, any, string> ? T : never }
Input2{ [K in string | number | symbol]: T[K] extends BcsType<any, T, string> ? T : never }
NewName extends stringName

Parameters

ParameterType
__namedParametersobject & BcsTypeOptions<T2, Input2, NewName>

Returns

BcsType<T2, Input2, NewName>

Inherited from

BcsType.transform