CommandDefinition
Defined in: packages/core/src/commands.ts:215
The definition command() takes.
Type Parameters
Section titled “Type Parameters”M extends OptionMap
Properties
Section titled “Properties”description
Section titled “description”description:
string
Defined in: packages/core/src/commands.ts:219
1-100 characters.
guildOnly?
Section titled “guildOnly?”
optionalguildOnly?: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 _.
optionalnsfw?:boolean
Defined in: packages/core/src/commands.ts:225
options?
Section titled “options?”
optionaloptions?:M
Defined in: packages/core/src/commands.ts:220
permissions?
Section titled “permissions?”
optionalpermissions?: readonlyPermissionName[]
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.
prefix?
Section titled “prefix?”
optionalprefix?:boolean| {aliases?: readonlystring[]; }
Defined in: packages/core/src/commands.ts:227
Answer !name args too, with the same options; { aliases } adds other names.
slash?
Section titled “slash?”
optionalslash?:boolean
Defined in: packages/core/src/commands.ts:229
Register it as a slash command (default true); false makes a prefix-only command.
Methods
Section titled “Methods”run(
context):unknown
Defined in: packages/core/src/commands.ts:230
Parameters
Section titled “Parameters”context
Section titled “context”Returns
Section titled “Returns”unknown