Interface Encodable

An interface for objects that can be encoded and decoded to/from msgpack and JSON.

interface Encodable {
    getEncodingSchema(): Schema;
    toEncodingData(): unknown;
}

Implemented by

Methods

  • Get the encoding Schema for this object, used to prepare the encoding data for msgpack and JSON.

    Returns Schema

  • Extract the encoding data for this object. This data, after being prepared by the encoding Schema, can be encoded to msgpack or JSON.

    Returns unknown

Generated using TypeDoc