Interface ClientOptions

Additional custom client options

interface ClientOptions {
    I18N?: i18n;
    commandUsageChannelId?: null | string;
    debug: ClientDebugOptions;
    defaultCommandThrottling: CommandThrottleOptions;
    defaultLockMemberPermissions: boolean;
    developmentServerId?: string;
    errorChannelId?: null | string;
    extensions?: Record<string, unknown>;
    globalMiddleware?: GlobalMiddlewareOptions;
    internalPermissions: ClientPermissionOptions;
    locales?: ("id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi")[];
    logging?: Omit<LoggerOptions & FileLoggerOptions, "client">;
    pkg?: Record<string, unknown>;
    refuseUnknownCommandInteractions: boolean;
    suppressUnknownInteractionWarning: boolean;
    suppressVanity: boolean;
}

Properties

I18N? commandUsageChannelId? debug defaultCommandThrottling defaultLockMemberPermissions developmentServerId? errorChannelId? extensions? globalMiddleware? internalPermissions locales? logging? pkg? refuseUnknownCommandInteractions suppressUnknownInteractionWarning suppressVanity

Properties

Optional I18N

I18N?: i18n

Optional commandUsageChannelId

commandUsageChannelId?: null | string

debug

debug: ClientDebugOptions

Additional debug options

defaultCommandThrottling

defaultCommandThrottling: CommandThrottleOptions

The default command cooldown for all commands - default config is 2 usages per 5 seconds - short burst protection

defaultLockMemberPermissions

defaultLockMemberPermissions: boolean

If a command has a permission level of Administrator, should we automatically hide that command from normal users, by using #setDefaultMemberPermissions(0) on the command?

Optional developmentServerId

developmentServerId?: string

The id to register development commands to

Optional errorChannelId

errorChannelId?: null | string

Optional extensions

extensions?: Record<string, unknown>

Optional globalMiddleware

globalMiddleware?: GlobalMiddlewareOptions

internalPermissions

internalPermissions: ClientPermissionOptions

Custom permissions for the client

Optional locales

locales?: ("id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi")[]

Optional logging

logging?: Omit<LoggerOptions & FileLoggerOptions, "client">

Optional pkg

pkg?: Record<string, unknown>

refuseUnknownCommandInteractions

refuseUnknownCommandInteractions: boolean

Should we refuse, and reply to, interactions that belong to unknown commands

Default

false

suppressUnknownInteractionWarning

suppressUnknownInteractionWarning: boolean

Should we print information on unknown command interactions, you should enable this if you run multiple processes/clients on the same bot user

Default

true

suppressVanity

suppressVanity: boolean

Whether to suppress the vanity print to console

Settings

Member Visibility

Theme

On This Page

I18NcommandUsageChannelIddebugdefaultCommandThrottlingdefaultLockMemberPermissionsdevelopmentServerIderrorChannelIdextensionsglobalMiddlewareinternalPermissionslocalesloggingpkgrefuseUnknownCommandInteractionssuppressUnknownInteractionWarningsuppressVanity