Interface IShardingStrategy

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

Hierarchy

IShardingStrategy

Implemented by

Index

Methods

connect destroy fetchStatus send spawn

Methods

connect

connect(): Awaitable<void>
Initializes all the shards

Returns Awaitable<void>
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:109

destroy

destroy(options?): Awaitable<void>
Destroys all the shards
Parameters
- Optional options: Omit<WebSocketShardDestroyOptions, "recover">
Returns Awaitable<void>
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:113

fetchStatus

fetchStatus(): Awaitable<Collection<number, WebSocketShardStatus>>
Fetches the status of all the shards

Returns Awaitable<Collection<number, WebSocketShardStatus>>
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:117

send

send(shardId, payload): Awaitable<void>
Sends a payload to a shard
Parameters
- shardId: number
- payload: GatewaySendPayload
Returns Awaitable<void>
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:121

spawn

spawn(shardIds): Awaitable<void>
Spawns all the shards
Parameters
- shardIds: number[]
Returns Awaitable<void>
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:125

Generated using TypeDoc