Interface: SubcommandOptions
Extends
Options
Properties
aliases?
readonlyoptionalaliases: readonlystring[]
The aliases for the piece.
Default
[]
Inherited from
Command.Options.aliases
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:861
cooldownDelay?
optionalcooldownDelay:number
The time in milliseconds for the cooldown entries to reset, if set to a non-zero value alongside CommandOptions.cooldownLimit, the Cooldown precondition will be added to the list.
Since
2.0.0
Default
0
Inherited from
Command.Options.cooldownDelay
Defined in
node_modules/@sapphire/framework/dist/esm/index.d.mts:1232
cooldownFilteredUsers?
optionalcooldownFilteredUsers:string[]
The users that are exempt from the Cooldown precondition. Use this to filter out someone like a bot owner
Since
2.0.0
Default
undefined
Inherited from
Command.Options.cooldownFilteredUsers
Defined in
node_modules/@sapphire/framework/dist/esm/index.d.mts:1245
cooldownLimit?
optionalcooldownLimit:number
The amount of entries the cooldown can have before filling up, if set to a non-zero value alongside CommandOptions.cooldownDelay, the Cooldown precondition will be added to the list.
Since
2.0.0
Default
1
Inherited from
Command.Options.cooldownLimit
Defined in
node_modules/@sapphire/framework/dist/esm/index.d.mts:1226
cooldownScope?
optionalcooldownScope:BucketScope
The scope of the cooldown entries.
Since
2.0.0
Default
BucketScope.User
Inherited from
Command.Options.cooldownScope
Defined in
node_modules/@sapphire/framework/dist/esm/index.d.mts:1238
description?
optionaldescription:string
The description for the command.
Since
1.0.0
Default
''
Inherited from
Command.Options.description
Defined in
node_modules/@sapphire/framework/dist/esm/index.d.mts:1175
detailedDescription?
optionaldetailedDescription:DetailedDescriptionCommand
The detailed description for the command.
Since
1.0.0
Default
''
Inherited from
Command.Options.detailedDescription
Defined in
node_modules/@sapphire/framework/dist/esm/index.d.mts:1181
enabled?
readonlyoptionalenabled:boolean
Whether or not the piece should be enabled. If set to false, the piece will be unloaded.
Default
true
Inherited from
Command.Options.enabled
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:204
flags?
optionalflags:boolean| readonlystring[]
The accepted flags. Flags are key-only identifiers that can be placed anywhere in the command. Two different types are accepted:
- An array of strings, e.g. [
silent]. - A boolean defining whether the strategy should accept all keys (
true) or none at all (false).
Default
[]
Inherited from
Command.Options.flags
Defined in
node_modules/@sapphire/framework/dist/esm/index.d.mts:266
fullCategory?
optionalfullCategory:string[]
The full category path for the command
Since
2.0.0
Default
'An array of folder names that lead back to the folder that is registered for in the commands store'
Example
// Given a file named `ping.js` at the path of `commands/General/ping.js`
['General']
// Given a file named `info.js` at the path of `commands/General/About/info.js`
['General', 'About']
Inherited from
Command.Options.fullCategory
Defined in
node_modules/@sapphire/framework/dist/esm/index.d.mts:1195
generateDashLessAliases?
optionalgenerateDashLessAliases:boolean
Whether to add aliases for subcommands with dashes in them
When this option is enabled and the subcommand implements messageRun, dashless aliases will be added.
For subcommands groups both the group itself and all subcommands within the group will have dashless aliases added.
Since
3.0.0
Default
false
Overrides
Command.Options.generateDashLessAliases
Defined in
projects/plugins/packages/subcommands/src/lib/Subcommand.ts:577
generateUnderscoreLessAliases?
optionalgenerateUnderscoreLessAliases:boolean
Whether to add aliases for commands with underscores in them
Since
3.0.0
Default
false
Inherited from
Command.Options.generateUnderscoreLessAliases
Defined in
node_modules/@sapphire/framework/dist/esm/index.d.mts:1169
name?
readonlyoptionalname:string
The name for the piece.
Default
''
Inherited from
Command.Options.name
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:199
nsfw?
optionalnsfw:boolean
Sets whether the command should be treated as NSFW. If set to true, the NSFW precondition will be added to the list.
Since
2.0.0
Default
false
Inherited from
Command.Options.nsfw
Defined in
node_modules/@sapphire/framework/dist/esm/index.d.mts:1220
options?
optionaloptions:boolean| readonlystring[]
The accepted options. Options are key-value identifiers that can be placed anywhere in the command. Two different types are accepted:
- An array of strings, e.g. [
silent]. - A boolean defining whether the strategy should accept all keys (
true) or none at all (false).
Default
[]
Inherited from
Command.Options.options
Defined in
node_modules/@sapphire/framework/dist/esm/index.d.mts:273
preconditions?
optionalpreconditions: readonlyPreconditionEntryResolvable[]
The Preconditions to be run, accepts an array of their names.
Seealso
PreconditionContainerArray
Since
1.0.0
Default
[]
Inherited from
Command.Options.preconditions
Defined in
node_modules/@sapphire/framework/dist/esm/index.d.mts:1202
prefixes?
optionalprefixes:string[]
The prefixes for both flags and options.
Default
['--', '-', '—']
Inherited from
Command.Options.prefixes
Defined in
node_modules/@sapphire/framework/dist/esm/index.d.mts:278
quotes?
optionalquotes: [string,string][]
The quotes accepted by this command, pass [] to disable them.
Since
1.0.0
Default
[
['"', '"'], // Double quotes
['“', '”'], // Fancy quotes (on iOS)
['「', '」'] // Corner brackets (CJK)
['«', '»'] // French quotes (guillemets)
]
Inherited from
Command.Options.quotes
Defined in
node_modules/@sapphire/framework/dist/esm/index.d.mts:1214
requiredClientPermissions?
optionalrequiredClientPermissions:PermissionResolvable
The required permissions for the client.
Since
2.0.0
Default
0
Inherited from
Command.Options.requiredClientPermissions
Defined in
node_modules/@sapphire/framework/dist/esm/index.d.mts:1251
requiredUserPermissions?
optionalrequiredUserPermissions:PermissionResolvable
The required permissions for the user.
Since
2.0.0
Default
0
Inherited from
Command.Options.requiredUserPermissions
Defined in
node_modules/@sapphire/framework/dist/esm/index.d.mts:1257
runIn?
optionalrunIn:CommandRunInUnion|CommandSpecificRunIn
The channels the command should run in. If set to null, no precondition entry will be added.
Some optimizations are applied when given an array to reduce the amount of preconditions run
(e.g. 'GUILD_TEXT' and 'GUILD_NEWS' becomes 'GUILD_ANY', and if both 'DM' and 'GUILD_ANY' are defined,
then no precondition entry is added as it runs in all channels).
This can be both CommandRunInUnion which will have the same precondition apply to all the types of commands, or you can use CommandSpecificRunIn to apply different preconditions to different types of commands.
Since
2.0.0
Default
null
Inherited from
Command.Options.runIn
Defined in
node_modules/@sapphire/framework/dist/esm/index.d.mts:1269
separators?
optionalseparators:string[]
The flag separators.
Default
['=', ':']
Inherited from
Command.Options.separators
Defined in
node_modules/@sapphire/framework/dist/esm/index.d.mts:283
subcommands?
optionalsubcommands:SubcommandMappingArray
Defined in
projects/plugins/packages/subcommands/src/lib/Subcommand.ts:566
typing?
optionaltyping:boolean
If SapphireClient.typing is true, this option will override it. Otherwise, this option has no effect - you may call Channel#sendTyping` in the run method if you want specific commands to display the typing status.
Default
true
Inherited from
Command.Options.typing
Defined in
node_modules/@sapphire/framework/dist/esm/index.d.mts:1275