Interface SubCommandOptions

The options for a SubCommand.

interface SubCommandOptions {
    aliases?: string[];
    arguments?: Record<string, Argument<any>>;
    channels?: string[];
    description?: string;
    tags?: ("nsfw" | Tag | "channelOnly" | "dmOnly" | "guildOnly" | "guildOwnerOnly" | "ownerOnly" | "threadOnly" | "check")[];
    usage?: string;
}

Properties

aliases? arguments? channels? description? tags? usage?

Properties

Optional aliases

aliases?: string[]

The aliases of the SubCommand.

Optional arguments

arguments?: Record<string, Argument<any>>

Optional channels

channels?: string[]

The channels where the SubCommand can be executed.

Optional description

description?: string

The description of the SubCommand.

Remarks

If a SubCommand has no description, it will not be shown in the default Help Command.

Optional tags

tags?: ("nsfw" | Tag | "channelOnly" | "dmOnly" | "guildOnly" | "guildOwnerOnly" | "ownerOnly" | "threadOnly" | "check")[]

The tags of the SubCommand.

Optional usage

usage?: string

Examples of usages for the SubCommand.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc