Interface OverrideOptions

interface OverrideOptions {
    appendQuery?: boolean;
    gatewayURLIsResumeURL?: boolean;
    timeBetweenShardConnects?: number;
    getBot?(): Promise<GetBotGatewayResponse>;
    resumeURL?(shard, totalShards): Promise<string>;
    url?(shard, totalShards): Promise<string>;
}

Properties

appendQuery? gatewayURLIsResumeURL? timeBetweenShardConnects?

Methods

getBot? resumeURL? url?

Properties

Optional appendQuery

appendQuery?: boolean

If the compression/version information should be appended to the query.

Default Value

true if getBot and url are undefined, false otherwise

Optional gatewayURLIsResumeURL

gatewayURLIsResumeURL?: boolean

If the gateway url should be used for resuming.

Default Value

false if getBot or url are present, true otherwise

Optional timeBetweenShardConnects

timeBetweenShardConnects?: number

The amount time in milliseconds to wait between shard connects. Discord only allows one connection per 5 seconds.

Default Value

5000

Methods

Optional getBot

Optional resumeURL

Optional url

  • url(shard, totalShards): Promise<string>

  • Replaces the gateway url shards connect to. This WILL be called multiple times if you have more than one shard, be sure to cache its results if you do anythng that isn't quickly repeatable.

    Parameters

    • shard: Shard
    • totalShards: number

    Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

appendQuerygatewayURLIsResumeURLtimeBetweenShardConnectsgetBotresumeURLurl