Interface GatewayOptions

interface GatewayOptions {
    autoReconnect?: boolean;
    compress?: boolean | "zlib-stream" | "zstd-stream";
    concurrency?: number | "auto";
    connectionProperties?: {
        browser?: string;
        device?: string;
        os?: string;
    };
    connectionTimeout?: number;
    dispatcher?: DispatcherOptions;
    firstShardID?: number;
    getAllUsers?: boolean;
    guildCreateTimeout?: number;
    intents?: number | (number | "GUILDS" | "GUILD_MEMBERS" | "GUILD_MODERATION" | "GUILD_EMOJIS_AND_STICKERS" | "GUILD_INTEGRATIONS" | "GUILD_WEBHOOKS" | "GUILD_INVITES" | "GUILD_VOICE_STATES" | "GUILD_PRESENCES" | "GUILD_MESSAGES" | "GUILD_MESSAGE_REACTIONS" | "GUILD_MESSAGE_TYPING" | "DIRECT_MESSAGES" | "DIRECT_MESSAGE_REACTIONS" | "DIRECT_MESSAGE_TYPING" | "MESSAGE_CONTENT" | "GUILD_SCHEDULED_EVENTS" | "AUTO_MODERATION_CONFIGURATION" | "AUTO_MODERATION_EXECUTION" | "GUILD_MESSAGE_POLLS" | "DIRECT_MESSAGE_POLLS" | "ALL" | "ALL_NON_PRIVILEGED")[];
    largeThreshold?: number;
    lastShardID?: number;
    lookupDisallowedIntents?: boolean;
    maxReconnectAttempts?: number;
    maxResumeAttempts?: number;
    maxShards?: number | "auto";
    override?: OverrideOptions;
    presence?: UpdatePresenceOptions;
    reconnectDelay?: ReconnectDelayFunction;
    removeDisallowedIntents?: boolean;
    seedVoiceConnections?: boolean;
    shardIDs?: number[];
    ws?: ClientOptions;
}

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

Optional autoReconnect

autoReconnect?: boolean

If dropped connections should be automatically reconnected.

Default Value

true

Optional compress

compress?: boolean | "zlib-stream" | "zstd-stream"

If packets to and from Discord should be compressed.

Note

true is the same as zlib-stream. This behavior is deprecated.

Default Value

false

Optional concurrency

concurrency?: number | "auto"

The concurrency for shard connections. If you don't know what this is, don't mess with it. Only bots in >150,000 servers can use any non-default value.

Default Value

1

Optional connectionProperties

connectionProperties?: {
    browser?: string;
    device?: string;
    os?: string;
}

The properties used when identifying.

Type declaration

  • Optional browser?: string

    The browser of the client. For example, "Discord Android" or "Discord iOS" to show as mobile.

    Default Value

    Oceanic
  • Optional device?: string

    The device of the client.

    Default Value

    Oceanic
  • Optional os?: string

    The operating system of the client.

    Default Value

    process.platform()

Optional connectionTimeout

connectionTimeout?: number

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

Default Value

30000

Optional dispatcher

dispatcher?: DispatcherOptions

The options for the dispatcher, which handles events.

Optional firstShardID

firstShardID?: number

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

Default Value

0

Optional getAllUsers

getAllUsers?: boolean

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

Default Value

false

Optional guildCreateTimeout

guildCreateTimeout?: number

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

Default Value

2000

Optional intents

intents?: number | (number | "GUILDS" | "GUILD_MEMBERS" | "GUILD_MODERATION" | "GUILD_EMOJIS_AND_STICKERS" | "GUILD_INTEGRATIONS" | "GUILD_WEBHOOKS" | "GUILD_INVITES" | "GUILD_VOICE_STATES" | "GUILD_PRESENCES" | "GUILD_MESSAGES" | "GUILD_MESSAGE_REACTIONS" | "GUILD_MESSAGE_TYPING" | "DIRECT_MESSAGES" | "DIRECT_MESSAGE_REACTIONS" | "DIRECT_MESSAGE_TYPING" | "MESSAGE_CONTENT" | "GUILD_SCHEDULED_EVENTS" | "AUTO_MODERATION_CONFIGURATION" | "AUTO_MODERATION_EXECUTION" | "GUILD_MESSAGE_POLLS" | "DIRECT_MESSAGE_POLLS" | "ALL" | "ALL_NON_PRIVILEGED")[]

The intents to use. Either a number, array of intent names, array of numbers, or "ALL"/"ALL_NON_PRIVILEGED". All non privileged intents are used by default.

Default Value

{@link Constants~AllNonPrivilegedIntents | All Non Privileged Intents}

Optional largeThreshold

largeThreshold?: number

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

Default Value

250

Optional lastShardID

lastShardID?: number

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

Default Value

maxShards - 1

Optional 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

Optional maxReconnectAttempts

maxReconnectAttempts?: number

The maximum number of attempts to reconnect.

Default Value

Infinity

Optional maxResumeAttempts

maxResumeAttempts?: number

The maximum number of attempts to resume a lost connection.

Default Value

10

Optional maxShards

maxShards?: number | "auto"

The total number of shards across all running clients. Limit the number of shards per client via firstShardID & lastShardID.

Default Value

1

Optional override

override?: OverrideOptions

Options for overriding default gateway behavior.

Optional presence

presence?: UpdatePresenceOptions

The initial presence to use when connecting.

Optional reconnectDelay

reconnectDelay?: ReconnectDelayFunction

A function to calculate the delay between reconnect attempts.

Default Value

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

Optional 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

Optional seedVoiceConnections

seedVoiceConnections?: boolean

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

Default Value

false

Optional 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

Optional ws

ws?: ClientOptions

The options to pass to constructed websockets.

Settings

Member Visibility

Theme

On This Page

autoReconnectcompressconcurrencyconnectionPropertiesconnectionTimeoutdispatcherfirstShardIDgetAllUsersguildCreateTimeoutintentslargeThresholdlastShardIDlookupDisallowedIntentsmaxReconnectAttemptsmaxResumeAttemptsmaxShardsoverridepresencereconnectDelayremoveDisallowedIntentsseedVoiceConnectionsshardIDsws