Class SimpleShardingStrategy

Simple strategy that just spawns shards in the current process

Hierarchy

SimpleShardingStrategy

Implements

IShardingStrategy

Index

Constructors

Properties

Methods

connect destroy fetchStatus send spawn

Constructors

constructor

new SimpleShardingStrategy(manager): SimpleShardingStrategy
Parameters
- manager: WebSocketManager
Returns SimpleShardingStrategy
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:146

Properties

`Private` `Readonly` manager

manager: any

`Private` `Readonly` shards

shards: any

Methods

connect

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

Returns Promise<void>
Implementation of IShardingStrategy.connect
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:154

destroy

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

fetchStatus

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

Returns Promise<Collection<number, WebSocketShardStatus>>
Implementation of IShardingStrategy.fetchStatus
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:166

send

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

spawn

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

Generated using TypeDoc