@tryforge/forgescript
    Preparing search index...

    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) => 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

    Index
    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?
    allowBots?: boolean

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

    false
    allowedMentions?: MessageMentionOptions
    closeTimeout?: number
    commands?: string

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

    disableConsoleErrors?: boolean
    enforceNonce?: boolean
    events?: (keyof ClientEvents)[]

    The discord.js events the bot will listen to.

    extensions?: ForgeExtension[]
    failIfNotExists?: boolean
    functions?: string

    Specifies a folder (path) to load all custom functions from it.

    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) => unknown
    logLevel?: LogPriority

    Specifies the logs to be received.

    LogPriority.Medium
    makeCache?: CacheFactory
    mobile?: boolean

    This will connect the client to Discord with the mobile status.

    false
    optionalGuildID?: boolean

    Does not work.

    partials?: readonly Partials[]
    prefixCaseInsensitive?: boolean

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

    false
    prefixes: IExtendedCompilationResult[]
    presence?: PresenceData
    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.

    false
    rest?: Partial<RESTOptions>
    restrictions?: IRestrictions
    shardCount?: number
    shards?: number | readonly number[] | "auto"
    sweepers?: SweeperOptions
    token?: string
    trackers?: ITrackers
    useInviteSystem?: boolean

    Use trackers: { invites: true } instead.

    waitGuildTimeout?: number
    ws?: WebSocketOptions

    Settings
    Member Visibility

    On This Page
    Properties