Skip to content

Command

Defined in: packages/core/src/commands.ts:234

A command made by command.

M extends OptionMap = OptionMap

readonly description: string

Defined in: packages/core/src/commands.ts:236


readonly guildOnly: boolean

Defined in: packages/core/src/commands.ts:239


readonly name: string

Defined in: packages/core/src/commands.ts:235


readonly nsfw: boolean

Defined in: packages/core/src/commands.ts:240


readonly options: M

Defined in: packages/core/src/commands.ts:237


readonly permissions: readonly PermissionName[]

Defined in: packages/core/src/commands.ts:238


readonly prefix: false | { aliases: readonly string[]; }

Defined in: packages/core/src/commands.ts:244

Whether it answers a prefix, and under which other names.


readonly slash: boolean

Defined in: packages/core/src/commands.ts:242

Whether it is registered as a slash command.

run(context): unknown

Defined in: packages/core/src/commands.ts:245

CommandContext<M>

unknown


toJSON(): Record<string, unknown>

Defined in: packages/core/src/commands.ts:247

The slash command as Discord expects it.

Record<string, unknown>


usage(prefix): string

Defined in: packages/core/src/commands.ts:249

The usage line of the prefix form, such as !timeout <user> [minutes] [reason…].

string

string