Skip to main content
Module

x/natico/deps.ts>StartGatewayOptions

A powerful and customizable framework for Discordeno
naticoo/framework
Latest
interface StartGatewayOptions
import { type StartGatewayOptions } from "https://deno.land/x/natico@4.0.0-pre.4/deps.ts";

Properties

token: string

The bot token.

optional
compress: boolean

Whether or not to use compression for gateway payloads.

intents: (GatewayIntents | keyof GatewayIntents)[]

The intents you would like to enable.

optional
maxShards: number

The max amount of shards used for identifying. This can be useful for zero-downtime updates or resharding.

firstShardId: number

The first shard Id for this group of shards.

optional
lastShardId: number

The last shard Id for this group. If none is provided, it will default to loading all shards.

url: string

The url to forward all payloads to.

optional
shardsPerCluster: number

The amount of shards per cluster. By default this is 25. Use this to spread the load from shards to different CPU cores.

optional
maxClusters: 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.

optional
reshard: boolean

Whether or not you want to allow automated sharding. By default this is true.

secretKey: string

The authorization key that the bot http server will expect.