Interface CreateWebSocketManagerOptions

Make all properties in T optional

interface CreateWebSocketManagerOptions {
    buildIdentifyThrottler?: (
        manager: WebSocketManager,
    ) => Awaitable<IIdentifyThrottler>;
    buildStrategy?: (manager: WebSocketManager) => IShardingStrategy;
    compression?: null | ZlibStream;
    encoding?: JSON;
    handshakeTimeout?: null | number;
    helloTimeout?: null | number;
    identifyProperties?: GatewayIdentifyProperties;
    initialPresence?: null | GatewayPresenceUpdateData;
    intents: 0 | GatewayIntentBits;
    largeThreshold?: null | number;
    readyTimeout?: null | number;
    rest: REST;
    retrieveSessionInfo?: (shardId: number) => Awaitable<null | SessionInfo>;
    shardCount?: null | number;
    shardIds?: null | number[] | ShardRange;
    token: string;
    updateSessionInfo?: (
        shardId: number,
        sessionInfo: null | SessionInfo,
    ) => Awaitable<void>;
    version?: string;
}

Hierarchy (View Summary)

Properties

buildIdentifyThrottler? buildStrategy? compression? encoding? handshakeTimeout? helloTimeout? identifyProperties? initialPresence? intents largeThreshold? readyTimeout? rest retrieveSessionInfo? shardCount? shardIds? token updateSessionInfo? version?

Properties

OptionalbuildIdentifyThrottler

buildIdentifyThrottler?: (
    manager: WebSocketManager,
) => Awaitable<IIdentifyThrottler>

Type declaration

OptionalbuildStrategy

buildStrategy?: (manager: WebSocketManager) => IShardingStrategy

Type declaration

    • (manager: WebSocketManager): IShardingStrategy

    • Builds the strategy to use for sharding

      Parameters

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

Optionalcompression

compression?: null | ZlibStream

The compression method to use

Default Value

null (no compression)

Optionalencoding

encoding?: JSON

The encoding to use

Default Value

'json'

OptionalhandshakeTimeout

handshakeTimeout?: null | number

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

OptionalhelloTimeout

helloTimeout?: null | number

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

OptionalidentifyProperties

identifyProperties?: GatewayIdentifyProperties

Properties to send to the gateway when identifying

OptionalinitialPresence

initialPresence?: null | GatewayPresenceUpdateData

Initial presence data to send to the gateway when identifying

intents

intents: 0 | GatewayIntentBits

The intents to request

OptionallargeThreshold

largeThreshold?: null | number

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

OptionalreadyTimeout

readyTimeout?: null | number

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

rest

rest: REST

The REST instance to use for fetching gateway information

OptionalretrieveSessionInfo

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

Type declaration

    • (shardId: number): 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
        },
      });

OptionalshardCount

shardCount?: null | number

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

OptionalshardIds

shardIds?: null | number[] | ShardRange

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

Example

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

Example

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

token

token: string

The token to use for identifying with the gateway

OptionalupdateSessionInfo

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

Type declaration

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

    • Function used to store session information for a given shard

      Parameters

      Returns Awaitable<void>

Optionalversion

version?: string

The gateway version to use

Default Value

'10'

Settings

Member Visibility

On This Page

Properties