Class Ribbon

emitter

handling

verbose

StaticFLAGS

StaticSLOW_CODEC_THRESHOLD

endpoint

• get endpoint(): undefined | string

• Returns undefined | string

connect

• connect(): Promise<void>

• Returns Promise<void>

decode

• decode(data): any

• Parameters

  • data: Buffer

  Returns any

destroy

• destroy(): void

• Returns void

die

• die(permanent?): void

• Parameters

  • permanent: boolean = false

  Returns void

emit

• emit<T>(event, ...data): void

• Type Parameters

  • T extends
        | (keyof Client)
        | (keyof Social)
        | (keyof Room)
        | (keyof Game)
        | "config.handling"

  Parameters

  • event: T
  • Rest...data: Types.Events.out.all[T] extends void
        ? []
        : [Types.Events.out.all[T]]

  Returns void

encode

• encode(msg, data?): string | Buffer

• Parameters

  • msg: string
  • Optionaldata: Record<string, any>

  Returns string | Buffer

log

• log(msg, __namedParameters?): void

• Parameters

  • msg: string
  • __namedParameters: {
        force: boolean;
        level: "error" | "info" | "warning";
    } = ...

    • force: boolean

    • level: "error" | "info" | "warning"

  Returns void

off

• off(event, callback): void

• Parameters

  • event: "send" | "receive"
  • callback: ((message: {
        command: string;
        data?: any;
    }) => void)
    • • (message): void

      • Parameters

        • message: {
              command: string;
              data?: any;
          }

          • command: string

          • Optionaldata?: any

        Returns void

  Returns void

on

• on(event, callback): void

• Parameters

  • event: "send" | "receive"
  • callback: ((message: {
        command: string;
        data?: any;
    }) => void)
    • • (message): void

      • Parameters

        • message: {
              command: string;
              data?: any;
          }

          • command: string

          • Optionaldata?: any

        Returns void

  Returns void