Skip to main content

BcsType

@iota/iota-sdk

@iota/iota-sdk / bcs / BcsType

Class: BcsType<T, Input, Name>

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:9

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: sdk/bcs/dist/cjs/bcs-type.d.ts:17

Parameters​

options​

object & BcsTypeOptions<T, Input, Name>

Returns​

BcsType<T, Input, Name>

Properties​

$inferInput​

$inferInput: Input

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:12

$inferType​

$inferType: T

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:11

name​

name: Name

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:13

read​

read: (reader) => T

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:14

Parameters​

reader​

BcsReader

Returns​

T

serializedSize​

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

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:15

Parameters​

value​

Input

options?​

BcsWriterOptions

Returns​

number | null

validate​

validate: (value) => void

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:16

Parameters​

value​

Input

Returns​

void

Methods​

fromBase58()​

fromBase58(b64): T

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:29

Parameters​

b64​

string

Returns​

T

fromBase64()​

fromBase64(b64): T

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:30

Parameters​

b64​

string

Returns​

T

fromHex()​

fromHex(hex): T

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:28

Parameters​

hex​

string

Returns​

T

parse()​

parse(bytes): T

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:27

Parameters​

bytes​

Uint8Array

Returns​

T

serialize()​

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

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:26

Parameters​

value​

Input

options?​

BcsWriterOptions

Returns​

SerializedBcs<T, Input>

transform()​

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

Defined in: sdk/bcs/dist/cjs/bcs-type.d.ts:31

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: sdk/bcs/dist/cjs/bcs-type.d.ts:25

Parameters​

value​

Input

writer​

BcsWriter

Returns​

void