Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Serializer

Hierarchy

  • Serializer

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

coder

coder: DataCoder

Private compressionLengthThreshold

compressionLengthThreshold: number = 1024

Private Readonly options

options: SerializerPacketOptions

Private schemes

schemes: SerializerSchemes = {}

Readonly version

version: number = 3

Methods

deserialize

  • deserialize<T>(buf: Buffer | Uint8Array): T

Private makePacket

  • makePacket(config: SerializerPacketOptions, data: Buffer | Uint8Array, schema?: null | number): Buffer

  • Parameters

    • config: SerializerPacketOptions
    • data: Buffer | Uint8Array
    • schema: null | number = null

    Returns Buffer

registerSchema

  • registerSchema<T>(id: number, fields: T): void

serialize

  • serialize<T>(payload: T, schemaIdOrSchemaObject?: SerializerSchemaIdOrSchemaObject): Buffer

  • Type parameters

    • T: object = {}

    Parameters

    • payload: T
    • schemaIdOrSchemaObject: SerializerSchemaIdOrSchemaObject = null

    Returns Buffer

unregisterSchema

  • unregisterSchema(id: number): void

use

  • use(id: number, detector: Function, encode: (arg: any) => any, decode: (arg: any) => any): void

  • Parameters

    • id: number
    • detector: Function
    • encode: (arg: any) => any
        • (arg: any): any

        • Parameters

          • arg: any

          Returns any

    • decode: (arg: any) => any
        • (arg: any): any

        • Parameters

          • arg: any

          Returns any

    Returns void

Generated using TypeDoc