Class GatewayShard

constructor

• new GatewayShard(token, id, numShards, url, options, logCallback?, logThisArg?): GatewayShard

• Create a gateway shard.

  Parameters

  • token: string

    The bot's token.

  • id: number

    The shard's ID.

  • numShards: number

    The value to pass to num_shards in the identify payload.

  • url: string

    The URL being used to connect to the gateway.

  • options: Required<GatewayOptions> & {
        intents: number;
    }

    Gateway shard options.

  • logCallback: LogCallback = ...

    A callback to be used for logging events internally in the gateway shard.

  • Optional logThisArg: any

    A value to use as this in the logCallback.

  Returns GatewayShard

guilds

heartbeatPing

Readonly id

lastSequence

Readonly numShards

Readonly options

resumeURL

sessionId

state

Readonly system

Readonly url

waitingForGuilds

ws

getPing

• getPing(): Promise<number>

• Gets the shard's ping.

  Returns Promise<number>

  The node's ping in milliseconds.

kill

• kill(reason?, code?): void

• Kills the shard.

  Parameters

  • reason: string = ...

    The reason the shard is being killed. Defaults to "Manual kill".

  • code: number = 1000

    A socket close code to send if the connection is still open. Defaults to 1000.

  Returns void

send

• send(payload): Promise<void>

• Sends a payload to the gateway.

  Parameters

  • payload: GatewaySendPayload

  Returns Promise<void>

spawn

• spawn(): Promise<void>

• Spawns the shard.

  Returns Promise<void>