Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BaseBotOptions

Hierarchy

  • BaseBotOptions

Index

Properties

Methods

Properties

cache

cache: false | CacheOptions

Cache options, decide what to cache

cacheControl

cacheControl: CacheControlOptions

Cache control option, to control what properties are cached

clusterStartRetention

clusterStartRetention: number

Amount of time to try asking the cluster to start before giving up and respawning

default

3

intents

intents: number | true | ("GUILDS" | "GUILD_MEMBERS" | "GUILD_BANS" | "GUILD_EMOJIS" | "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")[]

Array of intents to enable if true, enables all, if undefined enables all non-priveleged intents.

shardOffset

shardOffset: number

Amount of shards to add after requesting shards

shards

shards: number | "auto"

Amount of shards to spawn, leave to auto to let Discord decide.

shardsPerCluster

shardsPerCluster: number

Amount of shards per cluster worker.

default

5

spawnTimeout

spawnTimeout: number

Amount of time between when shards are spawned (don't change unless you know what you're doing)

default

5100

token

token: string

Discord Bot Token.

warnings

warnings: { cachedIntents: boolean }

Whether or not to log warnings for certain things

Type declaration

  • cachedIntents: boolean

    Whether or not warn when cache is enabled but it's required intents are not

ws

ws: string

URL for Discord Gateway (leave null for auto)

Methods

log

  • log(msg: string, cluster: Cluster): void

  • Custom logging function (false to disable)

    default

    console.log

    Parameters

    Returns void

Generated using TypeDoc