Serialize and deserialize data
Hierarchy
SerialBuffer
Constructors
constructor
⊕ new SerialBuffer(__namedParameters?: object): SerialBuffer
Defined in eosjs2-serialize.ts:110
Parameters:
| Param | Type | Default value | Description |
|---|---|---|---|
Default value __namedParameters |
object |
{} as{ textEncoder?: TextEncoder, textDecoder?: TextDecoder, array?: Uint8Array } | `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 eosjs2-serialize.ts:104
Data in serialized (binary) form
length
● length: number
Defined in eosjs2-serialize.ts:101
Amount of valid data in array
readPos
● readPos: number = 0
Defined in eosjs2-serialize.ts:107
Current position while reading (deserializing)
textDecoder
● textDecoder: TextDecoder
Defined in eosjs2-serialize.ts:110
textEncoder
● textEncoder: TextEncoder
Defined in eosjs2-serialize.ts:109
Methods
asUint8Array
▸ asUint8Array(): Uint8Array
Defined in eosjs2-serialize.ts:151
Return data with excess storage trimmed away
Returns: Uint8Array
get
▸ get(): number
Defined in eosjs2-serialize.ts:168
Get a single byte
Returns: number
getAsset
▸ getAsset(): string
Defined in eosjs2-serialize.ts:467
Get an asset
Returns: string
getBytes
▸ getBytes(): Uint8Array
Defined in eosjs2-serialize.ts:367
Get length-prefixed binary data
Returns: Uint8Array
getFloat32
▸ getFloat32(): number
Defined in eosjs2-serialize.ts:286
Get a float32
Returns: number
getFloat64
▸ getFloat64(): number
Defined in eosjs2-serialize.ts:296
Get a float64
Returns: number
getName
▸ getName(): string
Defined in eosjs2-serialize.ts:332
Get a name
Returns: string
getPrivateKey
▸ getPrivateKey(): string
Defined in eosjs2-serialize.ts:499
Get a private key
Returns: string
getPublicKey
▸ getPublicKey(): string
Defined in eosjs2-serialize.ts:485
Get a public key
Returns: string
getSignature
▸ getSignature(): string
Defined in eosjs2-serialize.ts:513
Get a signature
Returns: string
getString
▸ getString(): string
Defined in eosjs2-serialize.ts:377
Get a string
Returns: string
getSymbol
▸ getSymbol(): object
Defined in eosjs2-serialize.ts:418
Get a symbol
Returns: object
getSymbolCode
▸ getSymbolCode(): string
Defined in eosjs2-serialize.ts:395
Get a symbol_code. Unlike symbol, symbol_code doesn't include a precision.
Returns: string
getUint16
▸ getUint16(): number
Defined in eosjs2-serialize.ts:199
Get a uint16
Returns: number
getUint32
▸ getUint32(): number
Defined in eosjs2-serialize.ts:212
Get a uint32
Returns: number
getUint64AsNumber
▸ getUint64AsNumber(): number
Defined in eosjs2-serialize.ts:231
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 eosjs2-serialize.ts:184
Get len bytes
Parameters:
| Param | Type |
|---|---|
| len | number |
Returns: Uint8Array
getVarint32
▸ getVarint32(): number
Defined in eosjs2-serialize.ts:271
Get a varint32
Returns: number
getVaruint32
▸ getVaruint32(): number
Defined in eosjs2-serialize.ts:251
Get a varuint32
Returns: number
haveReadData
▸ haveReadData(): boolean
Defined in eosjs2-serialize.ts:141
Is there data available to read?
Returns: boolean
push
▸ push(...v: number[]): void
Defined in eosjs2-serialize.ts:163
Append bytes
Parameters:
| Param | Type |
|---|---|
Rest v |
number[] |
Returns: void
pushArray
▸ pushArray(v: number[] | Uint8Array): void
Defined in eosjs2-serialize.ts:156
Append bytes
Parameters:
| Param | Type |
|---|---|
| v | number[] | Uint8Array |
Returns: void
pushAsset
▸ pushAsset(s: string): void
Defined in eosjs2-serialize.ts:432
Append an asset
Parameters:
| Param | Type |
|---|---|
| s | string |
Returns: void
pushBytes
▸ pushBytes(v: number[] | Uint8Array): void
Defined in eosjs2-serialize.ts:361
Append length-prefixed binary data
Parameters:
| Param | Type |
|---|---|
| v | number[] | Uint8Array |
Returns: void
pushFloat32
▸ pushFloat32(v: number): void
Defined in eosjs2-serialize.ts:281
Append a float32
Parameters:
| Param | Type |
|---|---|
| v | number |
Returns: void
pushFloat64
▸ pushFloat64(v: number): void
Defined in eosjs2-serialize.ts:291
Append a float64
Parameters:
| Param | Type |
|---|---|
| v | number |
Returns: void
pushName
▸ pushName(s: string): void
Defined in eosjs2-serialize.ts:301
Append a name
Parameters:
| Param | Type |
|---|---|
| s | string |
Returns: void
pushNumberAsUint64
▸ pushNumberAsUint64(v: number): void
Defined in eosjs2-serialize.ts:222
Append a uint64. Caution: number only has 53 bits of precision
Parameters:
| Param | Type |
|---|---|
| v | number |
Returns: void
pushPrivateKey
▸ pushPrivateKey(s: string): void
Defined in eosjs2-serialize.ts:492
Append a private key
Parameters:
| Param | Type |
|---|---|
| s | string |
Returns: void
pushPublicKey
▸ pushPublicKey(s: string): void
Defined in eosjs2-serialize.ts:478
Append a public key
Parameters:
| Param | Type |
|---|---|
| s | string |
Returns: void
pushSignature
▸ pushSignature(s: string): void
Defined in eosjs2-serialize.ts:506
Append a signature
Parameters:
| Param | Type |
|---|---|
| s | string |
Returns: void
pushString
▸ pushString(v: string): void
Defined in eosjs2-serialize.ts:372
Append a string
Parameters:
| Param | Type |
|---|---|
| v | string |
Returns: void
pushSymbol
▸ pushSymbol(__namedParameters: object): void
Defined in eosjs2-serialize.ts:408
Append a symbol
Parameters:
| Param | Type |
|---|---|
| __namedParameters | object |
Returns: void
pushSymbolCode
▸ pushSymbolCode(name: string): void
Defined in eosjs2-serialize.ts:382
Append a symbol_code. Unlike symbol, symbol_code doesn't include a precision.
Parameters:
| Param | Type |
|---|---|
| name | string |
Returns: void
pushUint16
▸ pushUint16(v: number): void
Defined in eosjs2-serialize.ts:194
Append a uint16
Parameters:
| Param | Type |
|---|---|
| v | number |
Returns: void
pushUint32
▸ pushUint32(v: number): void
Defined in eosjs2-serialize.ts:207
Append a uint32
Parameters:
| Param | Type |
|---|---|
| v | number |
Returns: void
pushUint8ArrayChecked
▸ pushUint8ArrayChecked(v: Uint8Array, len: number): void
Defined in eosjs2-serialize.ts:176
Append bytes in v. Throws if len doesn't match v.length
Parameters:
| Param | Type |
|---|---|
| v | Uint8Array |
| len | number |
Returns: void
pushVarint32
▸ pushVarint32(v: number): void
Defined in eosjs2-serialize.ts:266
Append a varint32
Parameters:
| Param | Type |
|---|---|
| v | number |
Returns: void
pushVaruint32
▸ pushVaruint32(v: number): void
Defined in eosjs2-serialize.ts:238
Append a varuint32
Parameters:
| Param | Type |
|---|---|
| v | number |
Returns: void
reserve
▸ reserve(size: number): void
Defined in eosjs2-serialize.ts:127
Resize array if needed to have at least size bytes free
Parameters:
| Param | Type |
|---|---|
| size | number |
Returns: void
restartRead
▸ restartRead(): void
Defined in eosjs2-serialize.ts:146
Restart reading from the beginning
Returns: void