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

getEncodingSchema toEncodingData

Methods

getEncodingSchema

  • getEncodingSchema(): Schema

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

    Returns Schema

toEncodingData

  • toEncodingData(): unknown

  • 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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc