VarStringSerializer | NULS JS - API Reference

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

Hierarchy

VarStringSerializer

Index

Properties

DEFAULT_ENCODING

Methods

Properties

Static DEFAULT_ENCODING

DEFAULT_ENCODING: string = "utf8"

Methods

Static read

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

- Defined in packages/core/utils/serialize/varString.ts:45
Reads a varString 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 IVarStringOutput

Static size

size(data: string): number

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

Parameters
- data: string
Returns number

the bytes size of a serialized VarString

Static write

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

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

Parameters
- data: string
  
  String to be written to buf
- buf: Buffer
  
  Buffer object where the string 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