Skip to main content

BcsType

@iota/bcs

@iota/bcs / BcsType

Class: BcsType<T, Input, Name>

Defined in: bcs-type.ts:19

Extended by​

Type Parameters​

T​

T

Input​

Input = T

Name​

Name extends string = string

Constructors​

Constructor​

new BcsType<T, Input, Name>(options): BcsType<T, Input, Name>

Defined in: bcs-type.ts:29

Parameters​

options​

object & BcsTypeOptions<T, Input, Name>

Returns​

BcsType<T, Input, Name>

Properties​

$inferInput​

$inferInput: Input

Defined in: bcs-type.ts:21

$inferType​

$inferType: T

Defined in: bcs-type.ts:20

name​

name: Name

Defined in: bcs-type.ts:22

read​

read: (reader) => T

Defined in: bcs-type.ts:23

Parameters​

reader​

BcsReader

Returns​

T

serializedSize​

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

Defined in: bcs-type.ts:24

Parameters​

value​

Input

options?​

BcsWriterOptions

Returns​

number | null

validate​

validate: (value) => void

Defined in: bcs-type.ts:25

Parameters​

value​

Input

Returns​

void

Methods​

fromBase58()​

fromBase58(b64): T

Defined in: bcs-type.ts:76

Parameters​

b64​

string

Returns​

T

fromBase64()​

fromBase64(b64): T

Defined in: bcs-type.ts:80

Parameters​

b64​

string

Returns​

T

fromHex()​

fromHex(hex): T

Defined in: bcs-type.ts:72

Parameters​

hex​

string

Returns​

T

parse()​

parse(bytes): T

Defined in: bcs-type.ts:67

Parameters​

bytes​

Uint8Array

Returns​

T

serialize()​

serialize(value, options?): SerializedBcs<T, Input>

Defined in: bcs-type.ts:62

Parameters​

value​

Input

options?​

BcsWriterOptions

Returns​

SerializedBcs<T, Input>

transform()​

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

Defined in: bcs-type.ts:84

Type Parameters​

T2​

T2 = T

Input2​

Input2 = Input

NewName​

NewName extends string = Name

Parameters​

__namedParameters​

object & BcsTypeOptions<T2, Input2, NewName>

Returns​

BcsType<T2, Input2, NewName>

write()​

write(value, writer): void

Defined in: bcs-type.ts:57

Parameters​

value​

Input

writer​

BcsWriter

Returns​

void