Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KlasaClientOptions

Hierarchy

Index

Properties

Optional cache

cache: Partial<ClientCacheOptions>

Optional commands

The command handler options

default

{}

Optional console

console: ConsoleOptions

Config options to pass to the client console

default

{}

Optional consoleEvents

consoleEvents: ConsoleEvents

Config options to pass to console events

Optional language

language: undefined | string

The default language Klasa should opt-in for the commands

default

'en-US'

Optional owners

owners: string[]

The discord user id for the users the bot should respect as the owner (gotten from Discord api if not provided)

Optional permissionLevels

permissionLevels: undefined | ((permissionLevels: PermissionLevels) => PermissionLevels)

The permission levels to use with this bot

Optional pieces

pieces: Partial<ClientPieceOptions>

Optional production

production: undefined | false | true

Whether the bot should handle unhandled promise rejections automatically (handles when false) (also can be configured with process.env.NODE_ENV)

Optional providers

The provider options

default

{}

Optional readyMessage

readyMessage: string | ((client: Client) => string)

The ready message to be passed throughout Klasa's ready event

default

client => Successfully initialized. Ready to serve ${client.guilds.size} guilds.

rest

rest: Partial<RESTOptions>

Optional schedule

schedule: ScheduleOptions

The options for the internal clock module that runs Schedule

default

{}

Optional settings

settings: SettingsOptions

The settings options

default

{}

Optional ws

ws: Partial<WSOptions>

Generated using TypeDoc