Module: @sapphire/plugin-subcommands
Namespaces
Enumerations
Classes
Interfaces
- ChatInputSubcommandAcceptedPayload
- ChatInputSubcommandDeniedPayload
- ChatInputSubcommandErrorPayload
- ChatInputSubcommandRunPayload
- ChatInputSubcommandSuccessPayload
- IChatInputSubcommandPayload
- IMessageSubcommandPayload
- MessageSubcommandAcceptedPayload
- MessageSubcommandDeniedPayload
- MessageSubcommandErrorPayload
- MessageSubcommandNoMatchContext
- MessageSubcommandRunPayload
- MessageSubcommandSuccessPayload
- SubcommandMappingGroup
- SubcommandMappingMethod
- SubcommandOptions
Type Aliases
ChatInputCommandSubcommandMappingMethod
Ƭ ChatInputCommandSubcommandMappingMethod: Omit
<SubcommandMappingMethod
, "chatInputRun"
> & Required
<Pick
<SubcommandMappingMethod
, "chatInputRun"
>>
Defined in
projects/plugins/packages/subcommands/src/lib/types/SubcommandMappings.ts:110
MessageSubcommandMappingMethod
Ƭ MessageSubcommandMappingMethod: Omit
<SubcommandMappingMethod
, "messageRun"
> & Required
<Pick
<SubcommandMappingMethod
, "messageRun"
>>
Defined in
projects/plugins/packages/subcommands/src/lib/types/SubcommandMappings.ts:108
SubcommandMapping
Ƭ SubcommandMapping: SubcommandMappingMethod
| SubcommandMappingGroup
Defined in
projects/plugins/packages/subcommands/src/lib/types/SubcommandMappings.ts:3
SubcommandMappingArray
Ƭ SubcommandMappingArray: SubcommandMapping
[]
Defined in
projects/plugins/packages/subcommands/src/lib/types/SubcommandMappings.ts:5
Variables
SubcommandPluginEvents
• Const
SubcommandPluginEvents: Object
Type declaration
Name | Type |
---|---|
ChatInputSubcommandDenied | "chatInputSubcommandDenied" |
ChatInputSubcommandError | "chatInputSubcommandError" |
ChatInputSubcommandRun | "chatInputSubcommandRun" |
ChatInputSubcommandSuccess | "chatInputSubcommandSuccess" |
MessageSubcommandDenied | "messageSubcommandDenied" |
MessageSubcommandError | "messageSubcommandError" |
MessageSubcommandRun | "messageSubcommandRun" |
MessageSubcommandSuccess | "messageSubcommandSuccess" |
SubcommandMappingIsMissingChatInputCommandHandler | "subcommandMappingIsMissingChatInputCommandHandler" |
SubcommandMappingIsMissingMessageCommandHandler | "subcommandMappingIsMissingMessageCommandHandler" |
Defined in
projects/plugins/packages/subcommands/src/lib/types/Events.ts:6
SubcommandPreconditions
• Const
SubcommandPreconditions: Object
The preconditions specific to subcommands
Since
5.1.0
Type declaration
Name | Type |
---|---|
PluginSubcommandCooldown | typeof PluginPrecondition |
Defined in
projects/plugins/packages/subcommands/src/index.ts:47
projects/plugins/packages/subcommands/src/index.ts:55
version
• Const
version: string
= '[VI]{{inject}}[/VI]'
The @sapphire/plugin-subcommands version that you are currently using. An example use of this is showing it of in a bot information command.
Note to Sapphire developers: This needs to explicitly be string
so it is not typed as the string that gets replaced by esbuild
Defined in
projects/plugins/packages/subcommands/src/index.ts:67
Functions
loadListeners
▸ loadListeners(): void
Returns
void
Defined in
projects/plugins/packages/subcommands/src/listeners/_load.ts:7
loadPreconditions
▸ loadPreconditions(): void
Returns
void
Defined in
projects/plugins/packages/subcommands/src/preconditions/_load.ts:4