Skip to main content

Class: PatternCommand

pattern-commands/src.PatternCommand

Hierarchy​

  • Command<Args, Options>

    ↳ PatternCommand

Constructors​

constructor​

• new PatternCommand(context, options)

Parameters​

NameType
contextPieceContext
optionsPatternCommandOptions

Overrides​

Command<Args, PatternCommand.Options\>.constructor

Defined in​

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

Properties​

aliases​

• aliases: readonly string[]

Inherited from​

Command.aliases

Defined in​

node_modules/@sapphire/pieces/dist/index.d.ts:687

applicationCommandRegistry​

• Readonly applicationCommandRegistry: ApplicationCommandRegistry

Inherited from​

Command.applicationCommandRegistry

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2145

chance​

• Readonly chance: number

Defined in​

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

description​

• description: string

Inherited from​

Command.description

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2110

detailedDescription​

• detailedDescription: DetailedDescriptionCommand

Inherited from​

Command.detailedDescription

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2120

enabled​

• enabled: boolean

Inherited from​

Command.enabled

Defined in​

node_modules/@sapphire/pieces/dist/index.d.ts:450

fullCategory​

• Readonly fullCategory: readonly string[]

Inherited from​

Command.fullCategory

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2129

lexer​

• Private lexer: Lexer

Inherited from​

Command.lexer

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2151

location​

• Readonly location: PieceLocation

Inherited from​

Command.location

Defined in​

node_modules/@sapphire/pieces/dist/index.d.ts:442

matchFullName​

• Readonly matchFullName: boolean

Defined in​

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

name​

• Readonly name: string

Inherited from​

Command.name

Defined in​

node_modules/@sapphire/pieces/dist/index.d.ts:446

options​

• Readonly options: PatternCommandOptions

Inherited from​

Command.options

Defined in​

node_modules/@sapphire/pieces/dist/index.d.ts:454

preconditions​

• preconditions: PreconditionContainerArray

Inherited from​

Command.preconditions

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2115

store​

• store: CommandStore

Inherited from​

Command.store

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2105

strategy​

• strategy: IUnorderedStrategy

Inherited from​

Command.strategy

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2134

typing​

• typing: boolean

Inherited from​

Command.typing

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2140

weight​

• Readonly weight: number

Defined in​

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

Accessors​

category​

• get category(): null | string

Returns​

null | string

Inherited from​

Command.category

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2173

container​

• get container(): Container

Returns​

Container

Inherited from​

Command.container

Defined in​

node_modules/@sapphire/pieces/dist/index.d.ts:460

parentCategory​

• get parentCategory(): null | string

Returns​

null | string

Inherited from​

Command.parentCategory

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2191

subCategory​

• get subCategory(): null | string

Returns​

null | string

Inherited from​

Command.subCategory

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2182

Methods​

autocompleteRun​

▸ Optional autocompleteRun(interaction): unknown

Parameters​

NameTypeDescription
interactionAutocompleteInteraction<CacheType>

Returns​

unknown

Inherited from​

Command.autocompleteRun

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2223

chatInputRun​

▸ Optional chatInputRun(interaction, context): unknown

Parameters​

NameTypeDescription
interactionChatInputCommandInteraction<CacheType>
contextChatInputCommandContext

Returns​

unknown

Inherited from​

Command.chatInputRun

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2204

contextMenuRun​

▸ Optional contextMenuRun(interaction, context): unknown

Parameters​

NameTypeDescription
interactionContextMenuCommandInteraction<CacheType>
contextContextMenuCommandContext

Returns​

unknown

Inherited from​

Command.contextMenuRun

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2210

messagePreParse​

▸ messagePreParse(message, parameters, context): Awaitable<Args>

Parameters​

NameTypeDescription
messageMessage<boolean>
parametersstring
contextMessageCommandContext

Returns​

Awaitable<Args>

Inherited from​

Command.messagePreParse

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2164

messageRun​

▸ Abstract messageRun(message): unknown

Parameters​

NameTypeDescription
messageMessage<boolean>

Returns​

unknown

Overrides​

Command.messageRun

Defined in​

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

onLoad​

▸ onLoad(): unknown

Returns​

unknown

Inherited from​

Command.onLoad

Defined in​

node_modules/@sapphire/pieces/dist/index.d.ts:465

onUnload​

▸ onUnload(): unknown

Returns​

unknown

Inherited from​

Command.onUnload

Defined in​

node_modules/@sapphire/pieces/dist/index.d.ts:470

parseConstructorPreConditions​

▸ Protected parseConstructorPreConditions(options): void

Parameters​

NameTypeDescription
optionsCommandOptions

Returns​

void

Inherited from​

Command.parseConstructorPreConditions

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2258

parseConstructorPreConditionsCooldown​

▸ Protected parseConstructorPreConditionsCooldown(options): void

Parameters​

NameTypeDescription
optionsCommandOptions

Returns​

void

Inherited from​

Command.parseConstructorPreConditionsCooldown

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2288

parseConstructorPreConditionsNsfw​

▸ Protected parseConstructorPreConditionsNsfw(options): void

Parameters​

NameTypeDescription
optionsCommandOptions

Returns​

void

Inherited from​

Command.parseConstructorPreConditionsNsfw

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2263

parseConstructorPreConditionsRequiredClientPermissions​

▸ Protected parseConstructorPreConditionsRequiredClientPermissions(options): void

Parameters​

NameTypeDescription
optionsCommandOptions

Returns​

void

Inherited from​

Command.parseConstructorPreConditionsRequiredClientPermissions

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2276

parseConstructorPreConditionsRequiredUserPermissions​

▸ Protected parseConstructorPreConditionsRequiredUserPermissions(options): void

Parameters​

NameTypeDescription
optionsCommandOptions

Returns​

void

Inherited from​

Command.parseConstructorPreConditionsRequiredUserPermissions

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2282

parseConstructorPreConditionsRunIn​

▸ Protected parseConstructorPreConditionsRunIn(options): void

Parameters​

NameTypeDescription
optionsCommandOptions

Returns​

void

Inherited from​

Command.parseConstructorPreConditionsRunIn

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2270

registerApplicationCommands​

▸ Optional registerApplicationCommands(registry): Awaitable<void>

Parameters​

NameTypeDescription
registryApplicationCommandRegistry

Returns​

Awaitable<void>

Inherited from​

Command.registerApplicationCommands

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2232

reload​

▸ reload(): Promise<void>

Returns​

Promise<void>

Inherited from​

Command.reload

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2249

supportsAutocompleteInteractions​

▸ supportsAutocompleteInteractions(): this is AutocompleteCommand

Returns​

this is AutocompleteCommand

Inherited from​

Command.supportsAutocompleteInteractions

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2248

supportsChatInputCommands​

▸ supportsChatInputCommands(): this is ChatInputCommand

Returns​

this is ChatInputCommand

Inherited from​

Command.supportsChatInputCommands

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2240

supportsContextMenuCommands​

▸ supportsContextMenuCommands(): this is ContextMenuCommand

Returns​

this is ContextMenuCommand

Inherited from​

Command.supportsContextMenuCommands

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2244

supportsMessageCommands​

▸ supportsMessageCommands(): this is MessageCommand

Returns​

this is MessageCommand

Inherited from​

Command.supportsMessageCommands

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2236

toJSON​

▸ toJSON(): CommandJSON

Returns​

CommandJSON

Inherited from​

Command.toJSON

Defined in​

node_modules/@sapphire/framework/dist/index.d.ts:2227

unload​

▸ unload(): Promise<void>

Returns​

Promise<void>

Inherited from​

Command.unload

Defined in​

node_modules/@sapphire/pieces/dist/index.d.ts:474