Interface CreateWebSocketManagerOptions

Optional compression

Optional encoding

Optional handshakeTimeout

Optional helloTimeout

Optional identifyProperties

Optional initialPresence

intents

Optional largeThreshold

Optional readyTimeout

rest

Optional shardCount

Optional shardIds

const manager = new WebSocketManager({
  shardIds: [1, 3, 7], // spawns shard 1, 3, and 7, nothing else
});
Copy

const manager = new WebSocketManager({
  shardIds: {
    start: 3,
    end: 6,
  }, // spawns shards 3, 4, 5, and 6
});
Copy

token

Optional version

Optional buildIdentifyThrottler

• buildIdentifyThrottler(manager): Awaitable<IIdentifyThrottler>

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

  Parameters

  • manager: WebSocketManager

  Returns Awaitable<IIdentifyThrottler>

Optional buildStrategy

• buildStrategy(manager): IShardingStrategy

• Builds the strategy to use for sharding

  Parameters

  • manager: WebSocketManager

  Returns IShardingStrategy

  Example

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

Optional retrieveSessionInfo

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

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

  Parameters

  • shardId: number

  Returns Awaitable<null | SessionInfo>

  Example

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

Optional updateSessionInfo

• updateSessionInfo(shardId, sessionInfo): Awaitable<void>

• Function used to store session information for a given shard

  Parameters

  • shardId: number

  • sessionInfo: null | SessionInfo

  Returns Awaitable<void>