mirror of
https://github.com/swc-project/swc.git
synced 2024-12-21 04:32:01 +03:00
30 lines
1.4 KiB
TypeScript
30 lines
1.4 KiB
TypeScript
|
// Loaded from https://deno.land/x/discordeno@11.0.0-rc.2/src/ws/start_gateway_options.ts
|
||
|
|
||
|
|
||
|
import { DiscordGatewayIntents } from "../types/gateway/gateway_intents.ts";
|
||
|
|
||
|
export interface StartGatewayOptions {
|
||
|
/** The bot token. */
|
||
|
token: string;
|
||
|
/** Whether or not to use compression for gateway payloads. */
|
||
|
compress?: boolean;
|
||
|
/** The intents you would like to enable. */
|
||
|
intents: (DiscordGatewayIntents | keyof typeof DiscordGatewayIntents)[];
|
||
|
/** The max amount of shards used for identifying. This can be useful for zero-downtime updates or resharding. */
|
||
|
maxShards?: number;
|
||
|
/** The first shard Id for this group of shards. */
|
||
|
firstShardId: number;
|
||
|
/** The last shard Id for this group. If none is provided, it will default to loading all shards. */
|
||
|
lastShardId?: number;
|
||
|
/** The url to forward all payloads to. */
|
||
|
url: string;
|
||
|
/** The amount of shards per cluster. By default this is 25. Use this to spread the load from shards to different CPU cores. */
|
||
|
shardsPerCluster?: number;
|
||
|
/** The maximum amount of clusters available. By default this is 4. Another way to think of cluster is how many CPU cores does your server/machine have. */
|
||
|
maxClusters?: number;
|
||
|
/** Whether or not you want to allow automated sharding. By default this is true. */
|
||
|
reshard?: boolean;
|
||
|
/** The authorization key that the bot http server will expect. */
|
||
|
secretKey: string;
|
||
|
}
|