The compression method to use
null (no compression)
The encoding to use
'json'
How long to wait for a shard to connect before giving up
How long to wait for a shard's HELLO packet before giving up
Properties to send to the gateway when identifying
Initial presence data to send to the gateway when identifying
The intents to request
Value between 50 and 250, total number of members where the gateway will stop sending offline members in the guild member list
How long to wait for a shard's READY packet before giving up
The REST instance to use for fetching gateway information
The total number of shards across all WebsocketManagers you intend to instantiate.
Use null to use Discord's recommended shard count
The ids of the shards this WebSocketManager should manage.
Use null to simply spawn 0 through shardCount - 1
const manager = new WebSocketManager({
shardIds: [1, 3, 7], // spawns shard 1, 3, and 7, nothing else
});
const manager = new WebSocketManager({
shardIds: {
start: 3,
end: 6,
}, // spawns shards 3, 4, 5, and 6
});
The token to use for identifying with the gateway
The gateway version to use
'10'
Builds an identify throttler to use for this manager's shards
Builds the strategy to use for sharding
const manager = new WebSocketManager({
token: process.env.DISCORD_TOKEN,
intents: 0, // for no intents
rest,
buildStrategy: (manager) => new WorkerShardingStrategy(manager, { shardsPerWorker: 2 }),
});
Function used to retrieve session information (and attempt to resume) for a given shard
const manager = new WebSocketManager({
async retrieveSessionInfo(shardId): Awaitable<SessionInfo | null> {
// Fetch this info from redis or similar
return { sessionId: string, sequence: number };
// Return null if no information is found
},
});
Function used to store session information for a given shard
Generated using TypeDoc
Optional additional configuration for the WebSocketManager