Class: BcsEnum<T, Name>

Extends

• BcsType<EnumOutputShape<{ [K in keyof T]: T[K] extends BcsType<infer U, any> ? U : true }>, EnumInputShape<{ [K in keyof T]: T[K] extends BcsType<any, infer U, any> ? U : boolean | object | null }>, Name>

Type Parameters

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

Constructors

Constructor

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

Parameters

Parameter	Type
__namedParameters	BcsEnumOptions<T, Name>

Returns

BcsEnum<T, Name>

Overrides

BcsType.constructor

Properties

Property	Type	Inherited from
$inferType	EnumOutputShape	BcsType.$inferType
$inferInput	EnumInputShape	BcsType.$inferInput
name	Name	BcsType.name
read	(reader) => EnumOutputShape	BcsType.read
serializedSize	(value, options?) => number | null	BcsType.serializedSize
validate	(value) => void	BcsType.validate

Methods

write()

write(value, writer): void;

Parameters

Parameter	Type
value	EnumInputShape
writer	BcsWriter

Returns

void

Inherited from

BcsType.write

---

serialize()

serialize(value, options?): SerializedBcs<EnumOutputShape<{ [K in string | number | symbol]: T[K] extends BcsType<U, any, string> ? U : true }, Extract<keyof T, string>, { [K in string | number | symbol]: T[K] extends BcsType<U, any, string> ? U : true }[keyof T] extends Type ? Type extends BcsType<U, U, string> ? U : never : never>, EnumInputShape<{ [K in string | number | symbol]: T[K] extends BcsType<any, U, any> ? U : boolean | object | null }>>;

Parameters

Parameter	Type
value	EnumInputShape
options?	BcsWriterOptions

Returns

SerializedBcs<EnumOutputShape<{ [K in string | number | symbol]: T[K] extends BcsType<U, any, string> ? U : true }, Extract<keyof T, string>, { [K in string | number | symbol]: T[K] extends BcsType<U, any, string> ? U : true }[keyof T] extends Type ? Type extends BcsType<U, U, string> ? U : never : never>, EnumInputShape<{ [K in string | number | symbol]: T[K] extends BcsType<any, U, any> ? U : boolean | object | null }>>

Inherited from

BcsType.serialize

---

parse()

parse(bytes): EnumOutputShape;

Parameters

Parameter	Type
bytes	Uint8Array

Returns

EnumOutputShape

Inherited from

BcsType.parse

---

fromHex()

fromHex(hex): EnumOutputShape;

Parameters

Parameter	Type
hex	string

Returns

EnumOutputShape

Inherited from

BcsType.fromHex

---

fromBase58()

fromBase58(b64): EnumOutputShape;

Parameters

Parameter	Type
b64	string

Returns

EnumOutputShape

Inherited from

BcsType.fromBase58

---

fromBase64()

fromBase64(b64): EnumOutputShape;

Parameters

Parameter	Type
b64	string

Returns

EnumOutputShape

Inherited from

BcsType.fromBase64

---

transform()

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

Type Parameters

Type Parameter	Default type
T2	EnumOutputShape<{ [K in string | number | symbol]: T[K] extends BcsType<U, any, string> ? U : true }, Extract<keyof T, string>, { [K in string | number | symbol]: T[K] extends BcsType<U, any, string> ? U : true }[keyof T] extends Type ? Type extends BcsType<U, U, string> ? U : never : never>
Input2	EnumInputShape<{ [K in string | number | symbol]: T[K] extends BcsType<any, U, any> ? U : boolean | object | null }>
NewName extends string	Name

Parameters

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

Returns

BcsType<T2, Input2, NewName>

Inherited from

BcsType.transform