Interface ShardManagerInstanceOptions

interface ShardManagerInstanceOptions {
    autoReconnect: boolean;
    compress: false | "zlib-stream" | "zstd-stream";
    concurrency: number;
    connectionProperties: Required<undefined | {
        browser?: string;
        device?: string;
        os?: string;
    }>;
    connectionTimeout: number;
    dispatcher: DispatcherInstanceOptions;
    firstShardID: number;
    getAllUsers: boolean;
    guildCreateTimeout: number;
    intents: number;
    largeThreshold: number;
    lastShardID: number;
    lookupDisallowedIntents: boolean;
    maxReconnectAttempts: number;
    maxResumeAttempts: number;
    maxShards: number;
    override: Omit<OverrideOptions, "appendQuery" | "gatewayURLIsResumeURL" | "timeBetweenShardConnects"> & Required<Pick<OverrideOptions, "appendQuery" | "gatewayURLIsResumeURL" | "timeBetweenShardConnects">>;
    presence: Required<UpdatePresenceOptions>;
    reconnectDelay: ReconnectDelayFunction;
    removeDisallowedIntents: boolean;
    seedVoiceConnections: boolean;
    shardIDs: number[];
    ws: ClientOptions;
}

Hierarchy

  • Required<Omit<GatewayOptions, "concurrency" | "connectionProperties" | "intents" | "maxShards" | "presence" | "dispatcher" | "compress">>
    • ShardManagerInstanceOptions

Properties

autoReconnect compress concurrency connectionProperties connectionTimeout dispatcher firstShardID getAllUsers guildCreateTimeout intents largeThreshold lastShardID lookupDisallowedIntents maxReconnectAttempts maxResumeAttempts maxShards override presence reconnectDelay removeDisallowedIntents seedVoiceConnections shardIDs ws

Properties

autoReconnect

autoReconnect: boolean

If dropped connections should be automatically reconnected.

Default Value

true

compress

compress: false | "zlib-stream" | "zstd-stream"

concurrency

concurrency: number

connectionProperties

connectionProperties: Required<undefined | {
    browser?: string;
    device?: string;
    os?: string;
}>

connectionTimeout

connectionTimeout: number

The maximum amount of time in milliseconds to wait for a connection to be established.

Default Value

30000

dispatcher

dispatcher: DispatcherInstanceOptions

firstShardID

firstShardID: number

The ID of the first shard to run for this client. Mutually exclusive with shardIDs.

Default Value

0

getAllUsers

getAllUsers: boolean

If the members of all guilds should be requested. Requires the GUILD_MEMBERS intent.

Default Value

false

guildCreateTimeout

guildCreateTimeout: number

The time in milliseconds after which the client will consider all guilds to have been received.

Default Value

2000

intents

intents: number

largeThreshold

largeThreshold: number

The threshold at which guilds are considered "large" (after which offline members will not be loaded).

Default Value

250

lastShardID

lastShardID: number

The ID of the last shard to run for this client. Mutually exclusive with shardIDs.

Default Value

maxShards - 1

lookupDisallowedIntents

lookupDisallowedIntents: boolean

If upon recieving a disconnect for disallowed intents, we should request the application's flags and list the privileged intents that are missing in the error. This requires making a request to /applications/@me.

Default Value

false

maxReconnectAttempts

maxReconnectAttempts: number

The maximum number of attempts to reconnect.

Default Value

Infinity

maxResumeAttempts

maxResumeAttempts: number

The maximum number of attempts to resume a lost connection.

Default Value

10

maxShards

maxShards: number

override

override: Omit<OverrideOptions, "appendQuery" | "gatewayURLIsResumeURL" | "timeBetweenShardConnects"> & Required<Pick<OverrideOptions, "appendQuery" | "gatewayURLIsResumeURL" | "timeBetweenShardConnects">>

presence

presence: Required<UpdatePresenceOptions>

reconnectDelay

reconnectDelay: ReconnectDelayFunction

A function to calculate the delay between reconnect attempts.

Default Value

(lastDelay, attempts) => Math.pow(attempts + 1, 0.7) * 20000

removeDisallowedIntents

removeDisallowedIntents: boolean

If a check should be made before connecting, which will remove any disallowed intents. This requires making a request to /applications/@me. Any removed intents will be emitted via the warn event.

Default Value

false

seedVoiceConnections

seedVoiceConnections: boolean

If existing voice connections should be populated. This will disconnect connections from other sessions.

Default Value

false

shardIDs

shardIDs: number[]

An array of shard IDs to run for this client. Mutually exclusive with firstShardID & lastShardID. An array of shard IDs to run for this client. Mutually exclusive with firstShardID & lastShardID.

Default Value

based on firstShardID & lastShardID

ws

ws: ClientOptions

The options to pass to constructed websockets.

Settings

Member Visibility

Theme

On This Page

autoReconnectcompressconcurrencyconnectionPropertiesconnectionTimeoutdispatcherfirstShardIDgetAllUsersguildCreateTimeoutintentslargeThresholdlastShardIDlookupDisallowedIntentsmaxReconnectAttemptsmaxResumeAttemptsmaxShardsoverridepresencereconnectDelayremoveDisallowedIntentsseedVoiceConnectionsshardIDsws