Class: PatternCommand

@sapphire/plugin-pattern-commands.PatternCommand

Hierarchy

• Command<Args, Options>

  ↳ PatternCommand

Constructors

constructor

• new PatternCommand(context, options): PatternCommand

Parameters

Name	Type
context	LoaderContext
options	PatternCommandOptions

Returns

PatternCommand

Overrides

Command&lt;Args, PatternCommand.Options&gt;.constructor

Defined in

projects/plugins/packages/pattern-commands/src/lib/structures/PatternCommand.ts:8

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

---

chance

• Readonly chance: number

Defined in

projects/plugins/packages/pattern-commands/src/lib/structures/PatternCommand.ts:5

---

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

---

matchFullName

• Readonly matchFullName: boolean

Defined in

projects/plugins/packages/pattern-commands/src/lib/structures/PatternCommand.ts:7

---

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: PatternCommandOptions

The raw options passed to this Piece

Inherited from

Command.options

Defined in

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

---

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

---

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

---

weight

• Readonly weight: number

Defined in

projects/plugins/packages/pattern-commands/src/lib/structures/PatternCommand.ts:6

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

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

Name	Type	Description
interaction	AutocompleteInteraction<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): unknown

Executes the application command's logic.

Parameters

Name	Type	Description
interaction	ChatInputCommandInteraction<CacheType>	The interaction that triggered the command.
context	ChatInputCommandContext	The chat input command run context.

Returns

unknown

Inherited from

Command.chatInputRun

Defined in

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

---

contextMenuRun

▸ contextMenuRun(interaction, context): unknown

Executes the context menu's logic.

Parameters

Name	Type	Description
interaction	ContextMenuCommandInteraction<CacheType>	The interaction that triggered the command.
context	ContextMenuCommandContext	The 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<Args>

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

Parameters

Name	Type	Description
message	Message<boolean>	The message that triggered the command.
parameters	string	The raw parameters as a single string.
context	MessageCommandContext	The command-context used in this execution.

Returns

Awaitable<Args>

Inherited from

Command.messagePreParse

Defined in

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

---

messageRun

▸ messageRun(message): unknown

Executes the pattern command's logic.

Parameters

Name	Type	Description
message	Message<boolean>	The message that triggered the pattern command.

Returns

unknown

Overrides

Command.messageRun

Defined in

projects/plugins/packages/pattern-commands/src/lib/structures/PatternCommand.ts:29

---

onLoad

▸ onLoad(): unknown

Per-piece listener that is called when the piece is loaded into the store. Useful to set-up asynchronous initialization tasks.

Returns

unknown

Inherited from

Command.onLoad

Defined in

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

---

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

Name	Type	Description
options	CommandOptions	The 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

Name	Type	Description
options	CommandOptions	The 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

Name	Type	Description
options	CommandOptions	The 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

Name	Type	Description
options	CommandOptions	The 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

Name	Type	Description
options	CommandOptions	The 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

Name	Type	Description
options	CommandOptions	The 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

Name	Type	Description
registry	ApplicationCommandRegistry	This 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

Name	Type	Description
types	CommandRunInUnion	The 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

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

Returns

this is ChatInputCommand

Inherited from

Command.supportsChatInputCommands

Defined in

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

---

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(): this is MessageCommand

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

Returns

this is MessageCommand

Inherited from

Command.supportsMessageCommands

Defined in

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

---

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

Name	Type
types	CommandRunInUnion | CommandSpecificRunIn

Returns

types is CommandSpecificRunIn

Inherited from

Command.runInTypeIsSpecificsObject

Defined in

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