Class Ribbon

constructor

• new Ribbon(__namedParameters): Classes.Ribbon

• Parameters

  • __namedParameters: {
        api: API;
        codec: Codec;
        handling: Handling;
        spool: Spool;
        spooling?: boolean;
        token: string;
        userAgent: string;
        verbose: boolean;
    }

    • api: API

    • codec: Codec

    • handling: Handling

    • spool: Spool

    • Optionalspooling?: boolean

    • token: string

    • userAgent: string

    • verbose: boolean

  Returns Classes.Ribbon

emitter

StaticBATCH_TIMEOUT

StaticCACHE_MAXSIZE

Static ReadonlyCLOSE_CODES

StaticCODEC_FLAGS

StaticFLAGS

StaticSLOW_CODEC_THRESHOLD

fasterPing

• set fasterPing(value): 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;
  }

  • endpoint: string

  • host: string

clone

• clone(): Promise<Classes.Ribbon>

• Clones a ribbon. Used internally by Client.reconnect.

  Returns Promise<Classes.Ribbon>

destroy

• destroy(): void

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

  Returns void

disconnect

• disconnect(): void

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

  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

log

• log(msg, __namedParameters?): void

• Parameters

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

    • force: boolean

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

  Returns void

Staticcreate

• create(__namedParameters): Promise<Classes.Ribbon>

• Parameters

  • __namedParameters: {
        codec?: Codec;
        handling: Handling;
        spooling?: boolean;
        token: string;
        userAgent: string;
        verbose?: boolean;
    }

    • Optionalcodec?: Codec

    • handling: Handling

    • Optionalspooling?: boolean

    • token: string

    • userAgent: string

    • Optionalverbose?: boolean

  Returns Promise<Classes.Ribbon>