Options
All
  • Public
  • Public/Protected
  • All
Menu

Main library interface.

Hierarchy

  • Serialism

Index

Constructors

Properties

Methods

Constructors

constructor

  • Default constructor.

    Parameters

    • Default value classes: ReadonlyArray<IConstructor> = []

      An array of classes to support, if you (de)serialize a value containing a class not contained here, it will be treated as a plain object.

    Returns Serialism

Properties

classes

classes: ReadonlyArray<IConstructor>

An array of classes to support, if you (de)serialize a value containing a class not contained here, it will be treated as a plain object.

Methods

deserialize

  • deserialize<T>(buffer: Buffer): T
  • Deserialize a NodeJS.Buffer into a JavaScript value.

    Type parameters

    • T

    Parameters

    • buffer: Buffer

      The buffer containing serialized data.

    Returns T

    The deserialized data.

serialize

  • serialize(value: any): Buffer
  • Serialize any JavaScript value.

    Parameters

    • value: any

      A JavaScript value.

    Returns Buffer

    A NodeJS.Buffer object containing the serialized binary data.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc