Skip to main content

Class: Subcommand<PreParseReturn, Options>

@sapphire/plugin-subcommands.Subcommand

The class to extends for commands that have subcommands. Specify the subcommands through the Subcommand.Options.subcommands option.

Note that you should not make all your commands extend this class, only the ones that have subcommands. The reason for this is that this class implements Command.messageRun and Command.chatInputRun which you wouldn't necessarily want to do for commands that don't have subcommands. Furthermore, it also just adds general unnecessary memory overhead.

Type parameters

NameType
PreParseReturnextends Args = Args
Optionsextends Options = Options

Hierarchy

  • Command<PreParseReturn, Options>

    Subcommand

Constructors

constructor

new Subcommand<PreParseReturn, Options>(context, options): Subcommand<PreParseReturn, Options>

Type parameters

NameType
PreParseReturnextends Args = Args
Optionsextends SubcommandOptions = SubcommandOptions

Parameters

NameType
contextLoaderContext
optionsOptions

Returns

Subcommand<PreParseReturn, Options>

Overrides

Command&lt; PreParseReturn, Options &gt;.constructor

Defined in

projects/plugins/packages/subcommands/src/lib/Subcommand.ts:59

Properties

aliases

aliases: readonly string[]

The aliases for the piece.

Inherited from

Command.aliases

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:877


applicationCommandRegistry

Readonly applicationCommandRegistry: ApplicationCommandRegistry

The application command registry associated with this command.

Since

3.0.0

Inherited from

Command.applicationCommandRegistry

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:955


caseInsensitiveSubcommands

caseInsensitiveSubcommands: boolean = false

Whether to use case insensitive subcommands. This is only relevant for message-command styled commands as chat input commands are always lowercase. This can be enabled through clientOptions.caseInsensitiveCommands.

Defined in

projects/plugins/packages/subcommands/src/lib/Subcommand.ts:57


description

description: string

A basic summary about the command

Since

1.0.0

Inherited from

Command.description

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:917


detailedDescription

detailedDescription: DetailedDescriptionCommand

Longer version of command's summary and how to use it

Since

1.0.0

Inherited from

Command.detailedDescription

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:927


enabled

enabled: boolean

Whether or not the piece is enabled.

Inherited from

Command.enabled

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:234


fullCategory

Readonly fullCategory: readonly string[]

The full category for the command, can be overridden by setting the Command.Options.fullCategory option.

If Command.Options.fullCategory is not set, then:

  • If the command is loaded from the file system, then this is the command's location in file system relative to the commands folder. For example, if you have a command located at commands/General/Information/info.ts then this property will be ['General', 'Info'].
  • If the command is virtual, then this will be [].

Since

2.0.0

Inherited from

Command.fullCategory

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:939


lexer

Private lexer: Lexer

The lexer to be used for command parsing

Since

1.0.0

Inherited from

Command.lexer

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:961


location

Readonly location: PieceLocation

The location metadata for the piece's file.

Inherited from

Command.location

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:226


name

Readonly name: string

The name of the piece.

Inherited from

Command.name

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:230


options

Readonly options: Options

The raw options passed to this Piece

Inherited from

Command.options

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:238


parsedSubcommandMappings

parsedSubcommandMappings: SubcommandMappingArray

The parsed subcommand mappings that were provided with the SubcommandOptions.subcommands option. This is built at construction time and is used to determine which subcommand to run.

Defined in

projects/plugins/packages/subcommands/src/lib/Subcommand.ts:51


preconditions

preconditions: PreconditionContainerArray

The preconditions to be run.

Since

1.0.0

Inherited from

Command.preconditions

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:922


store

Readonly store: CommandStore

The store that contains the piece.

Inherited from

Command.store

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:222


strategy

strategy: IUnorderedStrategy

The strategy to use for the lexer.

Since

1.0.0

Inherited from

Command.strategy

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:944


subcommandPreconditions

Readonly subcommandPreconditions: Map<string, PreconditionContainerArray>

The preconditions to be run for each specified subcommand.

Since

4.1.0

Defined in

projects/plugins/packages/subcommands/src/lib/Subcommand.ts:45


typing

typing: boolean

If SapphireClient.typing is true, it can be overridden for a specific command using this property, set via its options. Otherwise, this property will be ignored.

Default

true

Inherited from

Command.typing

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:950

Accessors

category

get category(): null | string

The main category for the command, if any.

This getter retrieves the first value of Command.fullCategory, if it has at least one item, otherwise it returns null.

Returns

null | string

Note

You can set Command.Options.fullCategory to override the built-in category resolution.

Inherited from

Command.category

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:983


container

get container(): Container

A reference to the Container object for ease of use.

Returns

Container

See

container

Inherited from

Command.container

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:244


parentCategory

get parentCategory(): null | string

The parent category for the command.

This getter retrieves the last value of Command.fullCategory, if it has at least one item, otherwise it returns null.

Returns

null | string

Note

You can set Command.Options.fullCategory to override the built-in category resolution.

Inherited from

Command.parentCategory

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:1001


subCategory

get subCategory(): null | string

The sub-category for the command, if any.

This getter retrieves the second value of Command.fullCategory, if it has at least two items, otherwise it returns null.

Returns

null | string

Note

You can set Command.Options.fullCategory to override the built-in category resolution.

Inherited from

Command.subCategory

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:992

Methods

#findSubcommand

#findSubcommand(mappings, expectedName): { defaultMatch: false = false; mapping: SubcommandMappingMethod } | { defaultMatch: true = true; mapping: null | SubcommandMappingMethod = foundDefault }

Parameters

NameType
mappingsSubcommandMappingMethod[]
expectedNamestring

Returns

{ defaultMatch: false = false; mapping: SubcommandMappingMethod } | { defaultMatch: true = true; mapping: null | SubcommandMappingMethod = foundDefault }

Defined in

projects/plugins/packages/subcommands/src/lib/Subcommand.ts:530


#getMessageParametersAsString

#getMessageParametersAsString(args): Promise<Partial<Pick<MessageCommandDeniedPayload, "parameters">>>

Parameters

NameType
argsArgs

Returns

Promise<Partial<Pick<MessageCommandDeniedPayload, "parameters">>>

Defined in

projects/plugins/packages/subcommands/src/lib/Subcommand.ts:387


#handleChatInputInteractionRun

#handleChatInputInteractionRun(interaction, context, subcommand, subcommandGroupName): Promise<void>

Parameters

NameType
interactionInteraction<CacheType>
contextChatInputCommandContext
subcommandSubcommandMappingMethod
subcommandGroupNameundefined | string

Returns

Promise<void>

Defined in

projects/plugins/packages/subcommands/src/lib/Subcommand.ts:467


#handleMessageRun

#handleMessageRun(message, args, context, subcommand, subcommandGroupName): Promise<void>

Parameters

NameType
messageMessage<boolean>
argsArgs
contextMessageCommandContext
subcommandSubcommandMappingMethod
subcommandGroupNameundefined | string

Returns

Promise<void>

Defined in

projects/plugins/packages/subcommands/src/lib/Subcommand.ts:401


#supportsCommandType

#supportsCommandType(commandType): boolean

Parameters

NameType
commandType"chatInputRun" | "messageRun"

Returns

boolean

Defined in

projects/plugins/packages/subcommands/src/lib/Subcommand.ts:548


autocompleteRun

autocompleteRun(interaction): unknown

Executes the autocomplete logic.

tip

You may use this, or alternatively create an InteractionHandler interaction handler to handle autocomplete interactions. Keep in mind that commands take precedence over interaction handlers.

Parameters

NameTypeDescription
interactionAutocompleteInteraction<CacheType>The interaction that triggered the autocomplete.

Returns

unknown

Inherited from

Command.autocompleteRun

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:1033


chatInputRun

chatInputRun(interaction, context): Promise<void>

The method that is ran when a chat input based subcommand is ran.

DO NOT override this in your implementation of a subcommand!

Parameters

NameType
interactionInteraction<CacheType>
contextChatInputCommandContext

Returns

Promise<void>

Overrides

Command.chatInputRun

Defined in

projects/plugins/packages/subcommands/src/lib/Subcommand.ts:350


contextMenuRun

contextMenuRun(interaction, context): unknown

Executes the context menu's logic.

Parameters

NameTypeDescription
interactionContextMenuCommandInteraction<CacheType>The interaction that triggered the command.
contextContextMenuCommandContextThe context menu command run context.

Returns

unknown

Inherited from

Command.contextMenuRun

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:1020


messagePreParse

messagePreParse(message, parameters, context): Awaitable<PreParseReturn>

The message pre-parse method. This method can be overridden by plugins to define their own argument parser.

Parameters

NameTypeDescription
messageMessage<boolean>The message that triggered the command.
parametersstringThe raw parameters as a single string.
contextMessageCommandContextThe command-context used in this execution.

Returns

Awaitable<PreParseReturn>

Inherited from

Command.messagePreParse

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:974


messageRun

messageRun(message, args, context): Promise<void>

The method that is ran when a message-based subcommand is ran.

DO NOT override this in your implementation of a subcommand!

Parameters

NameType
messageMessage<boolean>
argsPreParseReturn
contextMessageCommandContext

Returns

Promise<void>

Overrides

Command.messageRun

Defined in

projects/plugins/packages/subcommands/src/lib/Subcommand.ts:253


onLoad

onLoad(): void

Returns

void

Overrides

Command.onLoad

Defined in

projects/plugins/packages/subcommands/src/lib/Subcommand.ts:221


onUnload

onUnload(): unknown

Per-piece listener that is called when the piece is unloaded from the store. Useful to set-up clean-up tasks.

Returns

unknown

Inherited from

Command.onUnload

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:254


parseConstructorPreConditions

parseConstructorPreConditions(options): void

Parses the command's options and processes them, calling Command#parseConstructorPreConditionsRunIn, Command#parseConstructorPreConditionsNsfw, Command#parseConstructorPreConditionsRequiredClientPermissions, and Command#parseConstructorPreConditionsCooldown.

Parameters

NameTypeDescription
optionsCommandOptionsThe command options given from the constructor.

Returns

void

Since

2.0.0

Inherited from

Command.parseConstructorPreConditions

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:1068


parseConstructorPreConditionsCooldown

parseConstructorPreConditionsCooldown(options): void

Appends the Cooldown precondition when Command.Options.cooldownLimit and Command.Options.cooldownDelay are both non-zero.

Parameters

NameTypeDescription
optionsCommandOptionsThe command options given from the constructor.

Returns

void

Inherited from

Command.parseConstructorPreConditionsCooldown

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:1097


parseConstructorPreConditionsNsfw

parseConstructorPreConditionsNsfw(options): void

Appends the NSFW precondition if Command.Options.nsfw is set to true.

Parameters

NameTypeDescription
optionsCommandOptionsThe command options given from the constructor.

Returns

void

Inherited from

Command.parseConstructorPreConditionsNsfw

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:1073


parseConstructorPreConditionsRequiredClientPermissions

parseConstructorPreConditionsRequiredClientPermissions(options): void

Appends the ClientPermissions precondition when Command.Options.requiredClientPermissions resolves to a non-zero bitfield.

Parameters

NameTypeDescription
optionsCommandOptionsThe command options given from the constructor.

Returns

void

Inherited from

Command.parseConstructorPreConditionsRequiredClientPermissions

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:1085


parseConstructorPreConditionsRequiredUserPermissions

parseConstructorPreConditionsRequiredUserPermissions(options): void

Appends the UserPermissions precondition when Command.Options.requiredUserPermissions resolves to a non-zero bitfield.

Parameters

NameTypeDescription
optionsCommandOptionsThe command options given from the constructor.

Returns

void

Inherited from

Command.parseConstructorPreConditionsRequiredUserPermissions

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:1091


parseConstructorPreConditionsRunIn

parseConstructorPreConditionsRunIn(options): void

Appends the RunIn precondition based on the values passed, defaulting to null, which doesn't add a precondition.

Parameters

NameTypeDescription
optionsCommandOptionsThe command options given from the constructor.

Returns

void

Inherited from

Command.parseConstructorPreConditionsRunIn

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:1079


registerApplicationCommands

registerApplicationCommands(registry): Awaitable<void>

Registers the application commands that should be handled by this command.

Parameters

NameTypeDescription
registryApplicationCommandRegistryThis command's registry

Returns

Awaitable<void>

Inherited from

Command.registerApplicationCommands

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:1042


reload

reload(): Promise<void>

Returns

Promise<void>

Inherited from

Command.reload

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:1059


resolveConstructorPreConditionsRunType

resolveConstructorPreConditionsRunType(types): null | readonly ChannelType[]

Resolves the Command.Options.runIn option into a Command.RunInTypes array.

Parameters

NameTypeDescription
typesCommandRunInUnionThe types to resolve.

Returns

null | readonly ChannelType[]

The resolved types, or null if no types were resolved.

Inherited from

Command.resolveConstructorPreConditionsRunType

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:1103


supportsAutocompleteInteractions

supportsAutocompleteInteractions(): this is AutocompleteCommand

Type-guard that ensures the command supports handling autocomplete interactions by checking if the handler for it is present

Returns

this is AutocompleteCommand

Inherited from

Command.supportsAutocompleteInteractions

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:1058


supportsChatInputCommands

supportsChatInputCommands(): this is ChatInputCommand

Whether this command has chat input subcommands or not

Returns

this is ChatInputCommand

true if this command has chat input subcommands, otherwise false

Overrides

Command.supportsChatInputCommands

Defined in

projects/plugins/packages/subcommands/src/lib/Subcommand.ts:244


supportsContextMenuCommands

supportsContextMenuCommands(): this is ContextMenuCommand

Type-guard that ensures the command supports context menu commands by checking if the handler for it is present

Returns

this is ContextMenuCommand

Inherited from

Command.supportsContextMenuCommands

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:1054


supportsMessageCommands

supportsMessageCommands(): boolean

Whether this command has message-based subcommands or not

Returns

boolean

true if this command has message-based subcommands, otherwise false

Overrides

Command.supportsMessageCommands

Defined in

projects/plugins/packages/subcommands/src/lib/Subcommand.ts:236


toJSON

toJSON(): CommandJSON

Defines the JSON.stringify behavior of the command.

Returns

CommandJSON

Inherited from

Command.toJSON

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:1037


unload

unload(): Promise<void>

Unloads and disables the piece.

Returns

Promise<void>

Inherited from

Command.unload

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:258


runInTypeIsSpecificsObject

runInTypeIsSpecificsObject(types): types is CommandSpecificRunIn

Parameters

NameType
typesCommandRunInUnion | CommandSpecificRunIn

Returns

types is CommandSpecificRunIn

Inherited from

Command.runInTypeIsSpecificsObject

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:1104