Options
All
  • Public
  • Public/Protected
  • All
Menu

Module commands

Index

Functions

Const decode

  • decode(parsedMsg: any, version: "1.0" | "1.1" | "1.2"): DecodeResponse
  • Parameters

    • parsedMsg: any
    • version: "1.0" | "1.1" | "1.2"

    Returns DecodeResponse

Const decodeId

  • decodeId(data: any): string
  • Parameters

    • data: any

    Returns string

Const decodeRecord

  • decodeRecord(proto: Proto, data: any): Record<string, any>
  • Parameters

    Returns Record<string, any>

Const decodeWithOptions

  • decodeWithOptions(parsedMsg: any, cmdType: undefined | CommandType, options: DecodeOptions, version: "1.0" | "1.1" | "1.2"): any
  • Parameters

    Returns any

Const hasSessionDisconnectError

  • hasSessionDisconnectError(msg: Record<string, any>): boolean
  • Parameters

    • msg: Record<string, any>

    Returns boolean

Const makeEmptySessionMessage

  • makeEmptySessionMessage(proto: Proto, bufferOptions: Record<string, string>, sessionOptions: USPSession, version: "1.0" | "1.1" | "1.2", useSession: boolean): any
  • Parameters

    • proto: Proto
    • bufferOptions: Record<string, string>
    • sessionOptions: USPSession
    • version: "1.0" | "1.1" | "1.2"
    • useSession: boolean

    Returns any

Const makeEncode

  • makeEncode(bufferOptions: Record<string, string>, useSession: boolean): (proto: Proto, command: CommandType, version: "1.0" | "1.1" | "1.2", args: Record<string, any>, sessionOptions: USPSession) => [string, any, null | string]
  • Parameters

    • bufferOptions: Record<string, string>
    • useSession: boolean

    Returns (proto: Proto, command: CommandType, version: "1.0" | "1.1" | "1.2", args: Record<string, any>, sessionOptions: USPSession) => [string, any, null | string]

      • (proto: Proto, command: CommandType, version: "1.0" | "1.1" | "1.2", args: Record<string, any>, sessionOptions: USPSession): [string, any, null | string]
      • Parameters

        Returns [string, any, null | string]

Const makeRecipes

  • Parameters

    Returns any

Const makeSession

  • makeSession(sessionId: null | number): USPSession
  • Parameters

    • sessionId: null | number

    Returns USPSession

Const msgLacksPayload

  • msgLacksPayload(msg: Record<string, any>): boolean
  • Parameters

    • msg: Record<string, any>

    Returns boolean

Const readMsg

  • readMsg(proto: Proto, decodedRecord: any, convertedDecodedRecord: BaseRecord): [Record<string, any>, unknown, boolean]
  • Parameters

    Returns [Record<string, any>, unknown, boolean]

Const readRecord

  • Parameters

    Returns [any, BaseRecord]

Generated using TypeDoc