Preview environment

interface WebSocketManagerOptions

export interface WebSocketManagerOptions extends OptionalWebSocketManagerOptions, RequiredWebSocketManagerOptions

compression : CompressionMethod | null = null (no compression)

The compression method to use

Inherited from: OptionalWebSocketManagerOptions

encoding : Encoding = 'json'

The encoding to use

Inherited from: OptionalWebSocketManagerOptions

handshakeTimeout : number | null

How long to wait for a shard to connect before giving up

Inherited from: OptionalWebSocketManagerOptions

helloTimeout : number | null

How long to wait for a shard's HELLO packet before giving up

Inherited from: OptionalWebSocketManagerOptions

identifyProperties : GatewayIdentifyProperties

Properties to send to the gateway when identifying

Inherited from: OptionalWebSocketManagerOptions

initialPresence : GatewayPresenceUpdateData | null

Initial presence data to send to the gateway when identifying

Inherited from: OptionalWebSocketManagerOptions

intents : GatewayIntentBits | 0

The intents to request

Inherited from: RequiredWebSocketManagerOptions

largeThreshold : number | null

Value between 50 and 250, total number of members where the gateway will stop sending offline members in the guild member list

Inherited from: OptionalWebSocketManagerOptions

readyTimeout : number | null

How long to wait for a shard's READY packet before giving up

Inherited from: OptionalWebSocketManagerOptions

rest : REST

The REST instance to use for fetching gateway information

Inherited from: RequiredWebSocketManagerOptions

shardCount : number | null

The total number of shards across all WebsocketManagers you intend to instantiate. Use null to use Discord's recommended shard count

Inherited from: OptionalWebSocketManagerOptions

shardIds : number[] | ShardRange | null

The ids of the shards this WebSocketManager should manage. Use null to simply spawn 0 through shardCount - 1

Inherited from: OptionalWebSocketManagerOptions

token : string

The token to use for identifying with the gateway

Inherited from: RequiredWebSocketManagerOptions

version : string = '10'

The gateway version to use

Inherited from: OptionalWebSocketManagerOptions

buildIdentifyThrottler(
manager: WebSocketManager
) : Awaitable<IIdentifyThrottler>

Builds an identify throttler to use for this manager's shards

Inherited from: OptionalWebSocketManagerOptions

buildStrategy(
manager: WebSocketManager
) : IShardingStrategy

Builds the strategy to use for sharding

Examples:
const manager = new WebSocketManager({
 token: process.env.DISCORD_TOKEN,
 intents: 0, // for no intents
 rest,
 buildStrategy: (manager) => new WorkerShardingStrategy(manager, { shardsPerWorker: 2 }),
});

Inherited from: OptionalWebSocketManagerOptions

retrieveSessionInfo(
shardId: number
) : Awaitable<SessionInfo | null>

Function used to retrieve session information (and attempt to resume) for a given shard

Examples:
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
  },
});

Inherited from: OptionalWebSocketManagerOptions

updateSessionInfo(
shardId: number
sessionInfo: SessionInfo | null
) : Awaitable<void>

Function used to store session information for a given shard

Inherited from: OptionalWebSocketManagerOptions