Interface ClientOptions

interface ClientOptions {
    allowedMentions?: MessageMentionOptions;
    botGuilds?: IGuild[];
    botId?: string;
    closeTimeout?: number;
    enforceNonce?: boolean;
    failIfNotExists?: boolean;
    guards?: GuardFunction[];
    intents: BitFieldResolvable<
        | "Guilds"
        | "GuildMembers"
        | "GuildModeration"
        | "GuildBans"
        | "GuildEmojisAndStickers"
        | "GuildIntegrations"
        | "GuildWebhooks"
        | "GuildInvites"
        | "GuildVoiceStates"
        | "GuildPresences"
        | "GuildMessages"
        | "GuildMessageReactions"
        | "GuildMessageTyping"
        | "DirectMessages"
        | "DirectMessageReactions"
        | "DirectMessageTyping"
        | "MessageContent"
        | "GuildScheduledEvents"
        | "AutoModerationConfiguration"
        | "AutoModerationExecution"
        | "GuildMessagePolls"
        | "DirectMessagePolls", number>;
    jsonTransformer?: ((obj: unknown) => unknown);
    logger?: ILogger;
    makeCache?: CacheFactory;
    partials?: readonly Partials[];
    presence?: PresenceData;
    rest?: Partial<RESTOptions>;
    shardCount?: number;
    shards?: number | readonly number[] | "auto";
    silent?: boolean;
    simpleCommand?: SimpleCommandConfig;
    sweepers?: SweeperOptions;
    waitGuildTimeout?: number;
    ws?: WebSocketOptions;
}

Hierarchy

  • ClientOptions
    • ClientOptions

Properties

allowedMentions? botGuilds? botId? closeTimeout? enforceNonce? failIfNotExists? guards? intents jsonTransformer? logger? makeCache? partials? presence? rest? shardCount? shards? silent? simpleCommand? sweepers? waitGuildTimeout? ws?

Properties

OptionalallowedMentions

allowedMentions?: MessageMentionOptions

OptionalbotGuilds

botGuilds?: IGuild[]

Set the guilds globally for application commands

OptionalbotId

botId?: string

Specify bot id (added for multiple bot support)

OptionalcloseTimeout

closeTimeout?: number

OptionalenforceNonce

enforceNonce?: boolean

OptionalfailIfNotExists

failIfNotExists?: boolean

Optionalguards

guards?: GuardFunction[]

The global guards

intents

intents: BitFieldResolvable<
    | "Guilds"
    | "GuildMembers"
    | "GuildModeration"
    | "GuildBans"
    | "GuildEmojisAndStickers"
    | "GuildIntegrations"
    | "GuildWebhooks"
    | "GuildInvites"
    | "GuildVoiceStates"
    | "GuildPresences"
    | "GuildMessages"
    | "GuildMessageReactions"
    | "GuildMessageTyping"
    | "DirectMessages"
    | "DirectMessageReactions"
    | "DirectMessageTyping"
    | "MessageContent"
    | "GuildScheduledEvents"
    | "AutoModerationConfiguration"
    | "AutoModerationExecution"
    | "GuildMessagePolls"
    | "DirectMessagePolls", number>

OptionaljsonTransformer

jsonTransformer?: ((obj: unknown) => unknown)

Optionallogger

logger?: ILogger

Set custom logger implementation

OptionalmakeCache

makeCache?: CacheFactory

Optionalpartials

partials?: readonly Partials[]

Optionalpresence

presence?: PresenceData

Optionalrest

rest?: Partial<RESTOptions>

OptionalshardCount

shardCount?: number

Optionalshards

shards?: number | readonly number[] | "auto"

Optionalsilent

silent?: boolean

Do not log anything

OptionalsimpleCommand

simpleCommand?: SimpleCommandConfig

simple command related customization

Optionalsweepers

sweepers?: SweeperOptions

OptionalwaitGuildTimeout

waitGuildTimeout?: number

Optionalws

ws?: WebSocketOptions

Settings

Member Visibility

On This Page

Properties