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

Properties​

aliases​

• aliases: readonly string[]

Inherited from​

Command.aliases

Defined in​

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

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

detailedDescription​

• detailedDescription: DetailedDescriptionCommand

Inherited from​

Command.detailedDescription

Defined in​

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

enabled​

• enabled: boolean

Inherited from​

Command.enabled

Defined in​

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

fullCategory​

• Readonly fullCategory: readonly string[]

Inherited from​

Command.fullCategory

Defined in​

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

lexer​

• Private lexer: Lexer

Inherited from​

Command.lexer

Defined in​

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

location​

• Readonly location: PieceLocation

Inherited from​

Command.location

Defined in​

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

matchFullName​

• Readonly matchFullName: boolean

Defined in​

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

name​

• Readonly name: string

Inherited from​

Command.name

Defined in​

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

options​

• Readonly options: PatternCommandOptions

Inherited from​

Command.options

Defined in​

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

preconditions​

• preconditions: PreconditionContainerArray

Inherited from​

Command.preconditions

Defined in​

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

store​

• Readonly store: Store<Piece<PieceOptions>>

Inherited from​

Command.store

Defined in​

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

strategy​

• strategy: UnorderedStrategy

Inherited from​

Command.strategy

Defined in​

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

typing​

• typing: boolean

Inherited from​

Command.typing

Defined in​

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

Accessors​

category​

• get category(): null | string

Returns​

null | string

Inherited from​

Command.category

Defined in​

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

container​

• get container(): Container

Returns​

Container

Inherited from​

Command.container

Defined in​

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

parentCategory​

• get parentCategory(): null | string

Returns​

null | string

Inherited from​

Command.parentCategory

Defined in​

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

subCategory​

• get subCategory(): null | string

Returns​

null | string

Inherited from​

Command.subCategory

Defined in​

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

Methods​

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

onLoad​

▸ onLoad(): unknown

Returns​

unknown

Inherited from​

Command.onLoad

Defined in​

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

onUnload​

▸ onUnload(): unknown

Returns​

unknown

Inherited from​

Command.onUnload

Defined in​

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

parseConstructorPreConditions​

▸ Protected parseConstructorPreConditions(options): void

Parameters​

NameTypeDescription
optionsCommandOptions

Returns​

void

Inherited from​

Command.parseConstructorPreConditions

Defined in​

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

parseConstructorPreConditionsCooldown​

▸ Protected parseConstructorPreConditionsCooldown(options): void

Parameters​

NameTypeDescription
optionsCommandOptions

Returns​

void

Inherited from​

Command.parseConstructorPreConditionsCooldown

Defined in​

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

parseConstructorPreConditionsNsfw​

▸ Protected parseConstructorPreConditionsNsfw(options): void

Parameters​

NameTypeDescription
optionsCommandOptions

Returns​

void

Inherited from​

Command.parseConstructorPreConditionsNsfw

Defined in​

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

parseConstructorPreConditionsRequiredClientPermissions​

▸ Protected parseConstructorPreConditionsRequiredClientPermissions(options): void

Parameters​

NameTypeDescription
optionsCommandOptions

Returns​

void

Inherited from​

Command.parseConstructorPreConditionsRequiredClientPermissions

Defined in​

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

parseConstructorPreConditionsRequiredUserPermissions​

▸ Protected parseConstructorPreConditionsRequiredUserPermissions(options): void

Parameters​

NameTypeDescription
optionsCommandOptions

Returns​

void

Inherited from​

Command.parseConstructorPreConditionsRequiredUserPermissions

Defined in​

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

parseConstructorPreConditionsRunIn​

▸ Protected parseConstructorPreConditionsRunIn(options): void

Parameters​

NameTypeDescription
optionsCommandOptions

Returns​

void

Inherited from​

Command.parseConstructorPreConditionsRunIn

Defined in​

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

preParse​

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

Parameters​

NameTypeDescription
messageMessage<boolean>
parametersstring
contextCommandContext

Returns​

Awaitable<Args>

Inherited from​

Command.preParse

Defined in​

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

reload​

▸ reload(): Promise<void>

Returns​

Promise<void>

Inherited from​

Command.reload

Defined in​

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

run​

▸ Optional run(message, args, context): unknown

Parameters​

NameTypeDescription
messageMessage<boolean>
argsArgs
contextCommandContext-

Returns​

unknown

Inherited from​

Command.run

Defined in​

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

toJSON​

▸ toJSON(): CommandJSON

Returns​

CommandJSON

Inherited from​

Command.toJSON

Defined in​

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

unload​

▸ unload(): Promise<void>

Returns​

Promise<void>

Inherited from​

Command.unload

Defined in​

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