Class Ribbon

emitter

lastDisconnectReason

StaticBATCH_TIMEOUT

StaticCACHE_MAXSIZE

Static ReadonlyCLOSE_CODES

StaticCODEC_FLAGS

StaticFLAGS

StaticSLOW_CODEC_THRESHOLD

fasterPing

• set fasterPing(value: boolean): void

  Used in the Game class to detect disconnects faster, don't touch.

  Parameters

  • value: boolean

  Returns void

ping

• get ping(): number

  The last ping time, in ms

  Returns number

spool

• get spool(): { endpoint: string; host: string }

  Ribbon spool information, useful for logging

  Returns { endpoint: string; host: string }

clone

• clone(): Promise<Classes.Ribbon>

  Clones a ribbon. Used internally by Client.reconnect.

  Returns Promise<Classes.Ribbon>

destroy

• destroy(): Promise<void>

  Closes and cleans up the ribbon, called automatically by client.destroy()

  Returns Promise<void>

disconnect

• disconnect(): void

  Automatically disconnect the ribbon's connection. It will attempt to automatically reconnect.

  Returns void

emit

• emit<
      T extends
          | (keyof Client)
          | (keyof Social)
          | (keyof Room)
          | (keyof Game)
          | "config.handling",
  >(
      event: T,
      ...data: Types.Events.out.all[T] extends void
          ? []
          : [Types.Events.out.all[T]],
  ): void

  Type Parameters

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

  Parameters

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

  Returns void

log

• log(
      msg: string,
      __namedParameters?: { force: boolean; level: "error" | "info" | "warning" },
  ): void

  Parameters

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

  Returns void

open

• open(): void

  Returns void

snapshot

• snapshot(): RibbonSnapshot

  Returns RibbonSnapshot

Staticcreate

• create(
      __namedParameters: {
          debug?: boolean;
          handling: Handling;
          logging?: LoggingLevel;
          spooling?: boolean;
          token: string;
          transport?: "json" | "binary";
          userAgent: string;
          verbose?: boolean;
      },
  ): Promise<Classes.Ribbon>

  Parameters

  • __namedParameters: {
        debug?: boolean;
        handling: Handling;
        logging?: LoggingLevel;
        spooling?: boolean;
        token: string;
        transport?: "json" | "binary";
        userAgent: string;
        verbose?: boolean;
    }

    • Optionaldebug?: boolean

    • handling: Handling

    • Optionallogging?: LoggingLevel

    • Optionalspooling?: boolean

    • token: string

    • Optionaltransport?: "json" | "binary"

    • userAgent: string

    • Optionalverbose?: boolean

      Deprecated

      • use logging instead

  Returns Promise<Classes.Ribbon>

StaticfromSnapshot

• fromSnapshot(snapshot: RibbonSnapshot): Promise<Classes.Ribbon>

  Parameters

  • snapshot: RibbonSnapshot

  Returns Promise<Classes.Ribbon>