Serialize and deserialize data

Hierarchy

SerialBuffer

Constructors

constructor

⊕ new SerialBuffer(__namedParameters?: object): SerialBuffer

Defined in eosjs-serialize.ts:118

Parameters:

Default value __namedParameters: object

• array: null if serializing, or binary data to deserialize
• textEncoder: TextEncoder instance to use. Pass in null if running in a browser
• textDecoder: TextDecider instance to use. Pass in null if running in a browser

Returns: SerialBuffer

Properties

array

● array: Uint8Array

Defined in eosjs-serialize.ts:112

Data in serialized (binary) form

length

● length: number

Defined in eosjs-serialize.ts:109

Amount of valid data in array

readPos

● readPos: number = 0

Defined in eosjs-serialize.ts:115

Current position while reading (deserializing)

textDecoder

● textDecoder: TextDecoder

Defined in eosjs-serialize.ts:118

textEncoder

● textEncoder: TextEncoder

Defined in eosjs-serialize.ts:117

Methods

asUint8Array

▸ asUint8Array(): Uint8Array

Defined in eosjs-serialize.ts:159

Return data with excess storage trimmed away

Returns: Uint8Array

get

▸ get(): number

Defined in eosjs-serialize.ts:176

Get a single byte

Returns: number

getAsset

▸ getAsset(): string

Defined in eosjs-serialize.ts:475

Get an asset

Returns: string

getBytes

▸ getBytes(): Uint8Array

Defined in eosjs-serialize.ts:375

Get length-prefixed binary data

Returns: Uint8Array

getFloat32

▸ getFloat32(): number

Defined in eosjs-serialize.ts:294

Get a float32

Returns: number

getFloat64

▸ getFloat64(): number

Defined in eosjs-serialize.ts:304

Get a float64

Returns: number

getName

▸ getName(): string

Defined in eosjs-serialize.ts:340

Get a name

Returns: string

getPrivateKey

▸ getPrivateKey(): string

Defined in eosjs-serialize.ts:507

Get a private key

Returns: string

getPublicKey

▸ getPublicKey(): string

Defined in eosjs-serialize.ts:493

Get a public key

Returns: string

getSignature

▸ getSignature(): string

Defined in eosjs-serialize.ts:521

Get a signature

Returns: string

getString

▸ getString(): string

Defined in eosjs-serialize.ts:385

Get a string

Returns: string

getSymbol

▸ getSymbol(): object

Defined in eosjs-serialize.ts:426

Get a symbol

Returns: object

getSymbolCode

▸ getSymbolCode(): string

Defined in eosjs-serialize.ts:403

Get a symbol_code. Unlike symbol, symbol_code doesn't include a precision.

Returns: string

getUint16

▸ getUint16(): number

Defined in eosjs-serialize.ts:207

Get a uint16

Returns: number

getUint32

▸ getUint32(): number

Defined in eosjs-serialize.ts:220

Get a uint32

Returns: number

getUint64AsNumber

▸ getUint64AsNumber(): number

Defined in eosjs-serialize.ts:239

Get a uint64 as a number. Caution: number only has 53 bits of precision; some values will change. numeric.binaryToDecimal(serialBuffer.getUint8Array(8)) recommended instead

Returns: number

getUint8Array

▸ getUint8Array(len: number): Uint8Array

Defined in eosjs-serialize.ts:192

Get len bytes

Parameters:

Returns: Uint8Array

getVarint32

▸ getVarint32(): number

Defined in eosjs-serialize.ts:279

Get a varint32

Returns: number

getVaruint32

▸ getVaruint32(): number

Defined in eosjs-serialize.ts:259

Get a varuint32

Returns: number

haveReadData

▸ haveReadData(): boolean

Defined in eosjs-serialize.ts:149

Is there data available to read?

Returns: boolean

push

▸ push(...v: number[]): void

Defined in eosjs-serialize.ts:171

Append bytes

Parameters:

Returns: void

pushArray

▸ pushArray(v: number[] | Uint8Array): void

Defined in eosjs-serialize.ts:164

Append bytes

Parameters:

Returns: void

pushAsset

▸ pushAsset(s: string): void

Defined in eosjs-serialize.ts:440

Append an asset

Parameters:

Returns: void

pushBytes

▸ pushBytes(v: number[] | Uint8Array): void

Defined in eosjs-serialize.ts:369

Append length-prefixed binary data

Parameters:

Returns: void

pushFloat32

▸ pushFloat32(v: number): void

Defined in eosjs-serialize.ts:289

Append a float32

Parameters:

Returns: void

pushFloat64

▸ pushFloat64(v: number): void

Defined in eosjs-serialize.ts:299

Append a float64

Parameters:

Returns: void

pushName

▸ pushName(s: string): void

Defined in eosjs-serialize.ts:309

Append a name

Parameters:

Returns: void

pushNumberAsUint64

▸ pushNumberAsUint64(v: number): void

Defined in eosjs-serialize.ts:230

Append a uint64. Caution: number only has 53 bits of precision

Parameters:

Returns: void

pushPrivateKey

▸ pushPrivateKey(s: string): void

Defined in eosjs-serialize.ts:500

Append a private key

Parameters:

Returns: void

pushPublicKey

▸ pushPublicKey(s: string): void

Defined in eosjs-serialize.ts:486

Append a public key

Parameters:

Returns: void

pushSignature

▸ pushSignature(s: string): void

Defined in eosjs-serialize.ts:514

Append a signature

Parameters:

Returns: void

pushString

▸ pushString(v: string): void

Defined in eosjs-serialize.ts:380

Append a string

Parameters:

Returns: void

pushSymbol

▸ pushSymbol(__namedParameters: object): void

Defined in eosjs-serialize.ts:416

Append a symbol

Parameters:

__namedParameters: object

Returns: void

pushSymbolCode

▸ pushSymbolCode(name: string): void

Defined in eosjs-serialize.ts:390

Append a symbol_code. Unlike symbol, symbol_code doesn't include a precision.

Parameters:

Returns: void

pushUint16

▸ pushUint16(v: number): void

Defined in eosjs-serialize.ts:202

Append a uint16

Parameters:

Returns: void

pushUint32

▸ pushUint32(v: number): void

Defined in eosjs-serialize.ts:215

Append a uint32

Parameters:

Returns: void

pushUint8ArrayChecked

▸ pushUint8ArrayChecked(v: Uint8Array, len: number): void

Defined in eosjs-serialize.ts:184

Append bytes in v. Throws if len doesn't match v.length

Parameters:

Returns: void

pushVarint32

▸ pushVarint32(v: number): void

Defined in eosjs-serialize.ts:274

Append a varint32

Parameters:

Returns: void

pushVaruint32

▸ pushVaruint32(v: number): void

Defined in eosjs-serialize.ts:246

Append a varuint32

Parameters:

Returns: void

reserve

▸ reserve(size: number): void

Defined in eosjs-serialize.ts:135

Resize array if needed to have at least size bytes free

Parameters:

Returns: void

restartRead

▸ restartRead(): void

Defined in eosjs-serialize.ts:154

Restart reading from the beginning

Returns: void