Interface IForgeClientOptions

interface IForgeClientOptions {
    allowBots?: boolean;
    allowedMentions?: MessageMentionOptions;
    closeTimeout?: number;
    commands?: string;
    disableConsoleErrors?: boolean;
    enforceNonce?: boolean;
    events?: (keyof ClientEvents)[];
    extensions?: ForgeExtension[];
    failIfNotExists?: boolean;
    functions?: string;
    intents: BitFieldResolvable<"Guilds" | "GuildMembers" | "GuildModeration" | "GuildBans" | "GuildExpressions" | "GuildEmojisAndStickers" | "GuildIntegrations" | "GuildWebhooks" | "GuildInvites" | "GuildVoiceStates" | "GuildPresences" | "GuildMessages" | "GuildMessageReactions" | "GuildMessageTyping" | "DirectMessages" | "DirectMessageReactions" | "DirectMessageTyping" | "MessageContent" | "GuildScheduledEvents" | "AutoModerationConfiguration" | "AutoModerationExecution" | "GuildMessagePolls" | "DirectMessagePolls", number>;
    jsonTransformer?: ((obj) => unknown);
    logLevel?: LogPriority;
    makeCache?: CacheFactory;
    mobile?: boolean;
    optionalGuildID?: boolean;
    partials?: readonly Partials[];
    prefixCaseInsensitive?: boolean;
    prefixes: IExtendedCompilationResult[];
    presence?: PresenceData;
    respondOnEdit?: number | boolean;
    rest?: Partial<RESTOptions>;
    restrictions?: IRestrictions;
    shardCount?: number;
    shards?: number | readonly number[] | "auto";
    sweepers?: SweeperOptions;
    token?: string;
    trackers?: ITrackers;
    useInviteSystem?: boolean;
    waitGuildTimeout?: number;
    ws?: WebSocketOptions;
}

Hierarchy

Properties

allowBots? allowedMentions? closeTimeout? commands? disableConsoleErrors? enforceNonce? events? extensions? failIfNotExists? functions? intents jsonTransformer? logLevel? makeCache? mobile? optionalGuildID? partials? prefixCaseInsensitive? prefixes presence? respondOnEdit? rest? restrictions? shardCount? shards? sweepers? token? trackers? useInviteSystem? waitGuildTimeout? ws?

Properties

Optional allowBots

allowBots?: boolean

Allows the bot to execute events triggered by other bots (and itself)

Optional allowedMentions

allowedMentions?: MessageMentionOptions

Optional closeTimeout

closeTimeout?: number

Optional commands

commands?: string

Specifies a folder (path) to load all commands from it

Optional disableConsoleErrors

disableConsoleErrors?: boolean

Optional enforceNonce

enforceNonce?: boolean

Optional events

events?: (keyof ClientEvents)[]

The discord.js events our bot will use

Optional extensions

extensions?: ForgeExtension[]

Optional failIfNotExists

failIfNotExists?: boolean

Optional functions

functions?: string

intents

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

Optional jsonTransformer

jsonTransformer?: ((obj) => unknown)

Type declaration

    • (obj): unknown

    • Parameters

      • obj: unknown

      Returns unknown

Optional logLevel

logLevel?: LogPriority

Specifies the logs to be received

Optional makeCache

makeCache?: CacheFactory

Optional mobile

mobile?: boolean

This will connect the client to Discord with the mobile status

Optional optionalGuildID

optionalGuildID?: boolean

Deprecated

Does not work

Optional partials

partials?: readonly Partials[]

Optional prefixCaseInsensitive

prefixCaseInsensitive?: boolean

Whether prefixes should be case-insensitive, this only affects letters

prefixes

prefixes: IExtendedCompilationResult[]

Optional presence

presence?: PresenceData

Optional respondOnEdit

respondOnEdit?: number | boolean

Allows the bot to re-use messages that were edited to find possibly command calls. If a number is passed, it's treated as the amount of milliseconds that can pass before the message becomes completely unusable.

Optional rest

rest?: Partial<RESTOptions>

Optional restrictions

restrictions?: IRestrictions

Optional shardCount

shardCount?: number

Optional shards

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

Optional sweepers

sweepers?: SweeperOptions

Optional token

token?: string

Optional trackers

trackers?: ITrackers

Optional useInviteSystem

useInviteSystem?: boolean

Deprecated

use trackers: { invites: true } instead

Optional waitGuildTimeout

waitGuildTimeout?: number

Optional ws

ws?: WebSocketOptions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc