Skip to content

CommandDefinition

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

The definition command() takes.

M extends OptionMap

description: string

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

1-100 characters.


optional guildOnly?: boolean

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

Only allow it in servers.


name: string

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

1-32 lowercase letters, digits, - or _.


optional nsfw?: boolean

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


optional options?: M

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


optional permissions?: readonly PermissionName[]

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

Permissions the person needs; checked by Discord for slash commands and by Lunibee for prefix commands. Implies guildOnly.


optional prefix?: boolean | { aliases?: readonly string[]; }

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

Answer !name args too, with the same options; { aliases } adds other names.


optional slash?: boolean

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

Register it as a slash command (default true); false makes a prefix-only command.

run(context): unknown

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

CommandContext<M>

unknown