Skip to main content

@sapphire/plugin-subcommands

Namespaces​

NamespaceDescription
Subcommand-
SubcommandPreconditionResolvers-
SubcommandPreconditionsThe preconditions specific to subcommands

Enumerations​

EnumerationDescription
SubcommandCommandPreConditionsThe available command pre-conditions.
SubcommandIdentifiersThe available subcommand pre-conditions.
SubcommandPluginIdentifiers-

Classes​

ClassDescription
PluginSubcommandCooldownPreconditionThe subcommand cooldown precondition. This differs from the cooldown precondition in framework by using a separate bucket as well as resolving the id differently to ensure it is specific to a subcommand.
SubcommandThe class to extends for commands that have subcommands. Specify the subcommands through the Subcommand.Options.subcommands option.

Interfaces​

InterfaceDescription
ChatInputSubcommandAcceptedPayload-
ChatInputSubcommandDeniedPayload-
ChatInputSubcommandErrorPayload-
ChatInputSubcommandRunPayload-
ChatInputSubcommandSuccessPayload-
IChatInputSubcommandPayload-
IMessageSubcommandPayload-
MessageSubcommandAcceptedPayload-
MessageSubcommandDeniedPayload-
MessageSubcommandErrorPayload-
MessageSubcommandNoMatchContext-
MessageSubcommandRunPayload-
MessageSubcommandSuccessPayload-
PluginSubcommandCooldownPreconditionContextThe context for the subcommand cooldown precondition
SubcommandMappingGroup-
SubcommandMappingMethodDescribes how a subcommand method maps to the actual implementation of that subcommand.
SubcommandOptions-

Type Aliases​

Type aliasDescription
ChatInputCommandSubcommandMappingMethod-
MessageSubcommandMappingMethod-
SubcommandMapping-
SubcommandMappingArray-

Variables​

VariableDescription
SubcommandPluginEvents-
SubcommandPreconditionsThe preconditions specific to subcommands
versionThe @sapphire/plugin-subcommands version that you are currently using. An example use of this is showing it of in a bot information command.

Functions​

FunctionDescription
loadListeners-
loadPreconditions-