serialism
    Preparing search index...

    Class Serialism

    Serialism is a library for serializing and deserializing JavaScript values. It supports a wide range of data types, including objects, arrays, and primitive values. It is designed to be fast and efficient, making it suitable for high-performance applications.

    import {Serialism} from 'serialism';
    const serialism = new Serialism();
    const buffer = serialism.serialize({ foo: 'bar' });
    const obj = serialism.deserialize(buffer);
    console.log(obj); // { foo: 'bar' }
    Index

    Constructors

    constructor

    Methods

    deserialize register serialize

    Constructors

    Methods

    • Deserialize a NodeJS.Buffer to a JavaScript value.

      Type Parameters

      • T

      Parameters

      • buffer: Buffer

        The buffer to deserialize.

      Returns T

      The deserialized object.

      Throws an error if the buffer is incompatible or malformed.

      Throws an error if a non-registered class is encountered.

    • Register class constructors for serialization/deserialization.

      Parameters

      • ...classes: (new (...args: never[]) => unknown)[]

        Class constructors

      Returns this

      The Serialism instance for chaining.

      Throws an error if a class is already registered.

      import {Serialism} from 'serialism';
      class MyClass {
        constructor(public name: string) {}
      }
      const serialism = new Serialism();
      serialism.register(MyClass);
      const buffer = serialism.serialize(new MyClass('example'));
      const obj = serialism.deserialize(buffer);
      console.log(obj); // MyClass { name: 'example' }

    • Serialize a JavaScript value.

      Parameters

      • value: unknown

        The value to serialize.

      Returns Buffer

      A Buffer instance containing the serialized data.

      Throws an error if a non-serializable is encountered. This includes non-global symbol, native object, unregistered class, etc)

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods