Class: BcsStruct<T, Name>

Extends

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

Type Parameters

Type Parameter	Default type
T extends Record<string, BcsType<any>>	-
Name extends string	string

Constructors

Constructor

new BcsStruct<T, Name>(__namedParameters): BcsStruct<T, Name>;

Parameters

Parameter	Type
__namedParameters	BcsStructOptions<T, Name>

Returns

BcsStruct<T, Name>

Overrides

BcsType.constructor

Properties

Property	Type	Inherited from
$inferType	{ [K in string | number | symbol]: T[K] extends BcsType<U, any, string> ? U : never }	BcsType.$inferType
$inferInput	{ [K in string | number | symbol]: T[K] extends BcsType<any, U, string> ? U : never }	BcsType.$inferInput
name	Name	BcsType.name
read	(reader) => { [K in string | number | symbol]: T[K] extends BcsType<U, any, string> ? U : never }	BcsType.read
serializedSize	(value, options?) => number | null	BcsType.serializedSize
validate	(value) => void	BcsType.validate

Methods

write()

write(value, writer): void;

Parameters

Parameter	Type
value	{ [K in string | number | symbol]: T[K] extends BcsType<any, U, string> ? U : never }
writer	BcsWriter

Returns

void

Inherited from

BcsType.write

---

serialize()

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

Parameters

Parameter	Type
value	{ [K in string | number | symbol]: T[K] extends BcsType<any, U, string> ? U : never }
options?	BcsWriterOptions

Returns

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

Inherited from

BcsType.serialize

---

parse()

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

Parameters

Parameter	Type
bytes	Uint8Array

Returns

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

Inherited from

BcsType.parse

---

fromHex()

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

Parameters

Parameter	Type
hex	string

Returns

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

Inherited from

BcsType.fromHex

---

fromBase58()

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

Parameters

Parameter	Type
b64	string

Returns

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

Inherited from

BcsType.fromBase58

---

fromBase64()

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

Parameters

Parameter	Type
b64	string

Returns

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

Inherited from

BcsType.fromBase64

---

transform()

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

Type Parameters

Type Parameter	Default type
T2	{ [K in string | number | symbol]: T[K] extends BcsType<U, any, string> ? U : never }
Input2	{ [K in string | number | symbol]: T[K] extends BcsType<any, U, string> ? U : never }
NewName extends string	Name

Parameters

Parameter	Type
__namedParameters	object & BcsTypeOptions<T2, Input2, NewName>

Returns

BcsType<T2, Input2, NewName>

Inherited from

BcsType.transform