Class ChameleonGateway

constructor

• new ChameleonGateway(options: ChameleonGatewayOptions): ChameleonGateway

  Parameters

  • options: ChameleonGatewayOptions

  Returns ChameleonGateway

Readonlytoken

Readonlyintents

Readonlyversion

ms

Readonlyencoding

ReadonlylargeThreshold

Optional Readonlyshard

status

pendingPresence

connect

• connect(): void

  Open a new WebSocket connection to the Gateway, if resuming, uses the resume_gateway_url, otherwise uses the base URL

  Returns void

disconnect

• disconnect(code?: number, reason?: string): void

  Gracefully close the connection code 1000/1001 invalidates the session any other code keeps the session alive for resume

  Parameters

  • code: number = 1000
  • Optionalreason: string

  Returns void

send

• send(op: number, d: unknown): void

  Send a payload to the Gateway.

  Parameters

  • op: number
  • d: unknown

  Returns void

updatePresence

• updatePresence(
      options: {
          status?: "idle" | "online" | "dnd" | "invisible" | "offline";
          activities?: { name: string; type: number; url?: string; state?: string }[];
          afk?: boolean;
          since?: number | null;
      },
  ): void

  Update the presence/status for this shard

  Parameters

  • options: {
        status?: "idle" | "online" | "dnd" | "invisible" | "offline";
        activities?: { name: string; type: number; url?: string; state?: string }[];
        afk?: boolean;
        since?: number | null;
    }

  Returns void

requestGuildMembers

• requestGuildMembers(
      options: {
          guildId: string | string[];
          query?: string;
          limit: number;
          presences?: boolean;
          userIds?: string | string[];
          nonce?: string;
      },
  ): void

  request offline/large guild members from the Gateway this is used to lazy-load members into the cache via GUILD_MEMBERS_CHUNK events

  Parameters

  • options: {
        guildId: string | string[];
        query?: string;
        limit: number;
        presences?: boolean;
        userIds?: string | string[];
        nonce?: string;
    }

  Returns void

on

• on<T = unknown>(event: string, listener: (data: T) => void): void

  Register an event listener.

  Type Parameters

  • T = unknown

  Parameters

  • event: string
  • listener: (data: T) => void

  Returns void

removeAllListeners

• removeAllListeners(event?: string): void

  Remove all listeners for a specific event, or all listeners entirely.

  Parameters

  • Optionalevent: string

  Returns void