Interface Transcoder

Transcoders provide functionality for converting values passed to and from the SDK to byte arrays and flags data that can be stored to the server.

interface Transcoder {
decode(bytes: Buffer, flags: number): any;
encode(value: any): [Buffer, number];
}

Implemented by

Index

Methods

Methods

decode

decode(bytes: Buffer, flags: number): any
Decodes a buffer and flags tuple back to the original type of the document.
Parameters
- bytes: Buffer
  The bytes that were previously encoded.
- flags: number
  The flags associated with the data.
Returns any
- Defined in lib/transcoders.ts:36

encode

encode(value: any): [Buffer, number]
Encodes the specified value, returning a buffer and flags that are stored to the server and later used for decoding.
Parameters
- value: any
  The value to encode.
Returns [Buffer, number]
- Defined in lib/transcoders.ts:27