VarByteSerializer | NULS JS - API Reference

Class to handle the protocol VarByte type http://dev.nuls.io/protocol/index.html#VarByte

Hierarchy

VarByteSerializer
- TxDataDataSerializer

Index

Methods

Methods

Static read

read(buf: Buffer, offset: number): IVarByteOutput

- Defined in packages/core/utils/serialize/varByte.ts:47
Reads a varByte from buf at the specified offset

Parameters
- buf: Buffer
  
  Buffer object from where the bytes will be read
- offset: number
  
  Number of bytes to skip before starting to read
Returns IVarByteOutput

Static size

size(data: Buffer): number

- Defined in packages/core/utils/serialize/varByte.ts:33
Size of the serialized data

Parameters
- data: Buffer
Returns number

the bytes size of a serialized VarByte

Static write

write(data: Buffer, buf: Buffer, offset: number): number

- Defined in packages/core/utils/serialize/varByte.ts:63
Writes data to buf at the specified offset

Parameters
- data: Buffer
  
  Buffer of bytes to be written to buf
- buf: Buffer
  
  Buffer object where the bytes will be written
- offset: number
  
  Number of bytes to skip before starting to write.
Returns number

Offset plus the number of bytes that has been written