Interface IShardingStrategy

Strategies responsible for spawning, initializing connections, destroying shards, and relaying events

interface IShardingStrategy {
    connect(): Awaitable<void>;
    destroy(
        options?: Omit<WebSocketShardDestroyOptions, "recover">,
    ): Awaitable<void>;
    fetchStatus(): Awaitable<Collection<number, WebSocketShardStatus>>;
    send(shardId: number, payload: GatewaySendPayload): Awaitable<void>;
    spawn(shardIds: number[]): Awaitable<void>;
}

Methods

connect destroy fetchStatus send spawn

Methods

connect

  • connect(): Awaitable<void>

    Initializes all the shards

    Returns Awaitable<void>

destroy

fetchStatus

send

spawn

  • spawn(shardIds: number[]): Awaitable<void>

    Spawns all the shards

    Parameters

    • shardIds: number[]

    Returns Awaitable<void>

Settings

Member Visibility

On This Page

Methods