@coconut-xr/xserialization v0.0.6

@coconut-xr/xserialization

fast and efficient js data serialization

Features

• preserves referential integrity
• can serialize recursive data structures
• 0 dependencies
• true to js (supports null, undefined, NaN, ...)
• custom data types

API

type SerializationOptions = {
  custom?: {
    isCustom(data: any): boolean;
    /**
     * custom serilization function
     * @param serialize allows to serialize any value inside the custom serialization function
     * @returns the data type of the serialized value
     */
    serialize(writer: Writer, data: any, serialize: (data: any) => void): number;
    /**
     * custom deserialization function
     */
    deserialize(reader: Reader, dataType: number, deserialize: () => any): any;
  };
};
function serializeInto(writer: Writer, data: any, options: SerializationOptions = {}): void;
function deserializeFrom(reader: Reader, options: SerializationOptions = {}): any;

Usage

const value = "test";
const writer = new Writer();
serializeInto(writer, value);
const buffer = writer.finishReference();
const reader = new Reader();
reader.start(buffer);
const result = deserializeInto(reader);
reader.finish();
console.log(result);

Why so complex, you might ask?

Using this design reader and writer can be reused and serializeInto can be called multiple times to write into the same buffer.

Data Types

Achknowledgement

xserialization builds on the structure and idea of msgpack but focusses solely on js data.