Skip to main content

Interface: CommandOptions

Hierarchy

  • Options

  • FlagStrategyOptions

    CommandOptions

Properties

aliases

Optional Readonly aliases: readonly string[]

Inherited from

AliasPiece.Options.aliases

Defined in

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


cooldownDelay

Optional cooldownDelay: number

Defined in

projects/framework/src/lib/structures/Command.ts:664


cooldownFilteredUsers

Optional cooldownFilteredUsers: string[]

Defined in

projects/framework/src/lib/structures/Command.ts:679


cooldownLimit

Optional cooldownLimit: number

Defined in

projects/framework/src/lib/structures/Command.ts:657


cooldownScope

Optional cooldownScope: BucketScope

Defined in

projects/framework/src/lib/structures/Command.ts:671


description

Optional description: string

Defined in

projects/framework/src/lib/structures/Command.ts:600


detailedDescription

Optional detailedDescription: DetailedDescriptionCommand

Defined in

projects/framework/src/lib/structures/Command.ts:607


enabled

Optional Readonly enabled: boolean

Inherited from

AliasPiece.Options.enabled

Defined in

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


flags

Optional flags: boolean | readonly string[]

Inherited from

FlagStrategyOptions.flags

Defined in

projects/framework/src/lib/utils/strategies/FlagUnorderedStrategy.ts:14


fullCategory

Optional fullCategory: string[]

Defined in

projects/framework/src/lib/structures/Command.ts:622


generateDashLessAliases

Optional generateDashLessAliases: boolean

Defined in

projects/framework/src/lib/structures/Command.ts:586


generateUnderscoreLessAliases

Optional generateUnderscoreLessAliases: boolean

Defined in

projects/framework/src/lib/structures/Command.ts:593


name

Optional Readonly name: string

Inherited from

AliasPiece.Options.name

Defined in

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


nsfw

Optional nsfw: boolean

Defined in

projects/framework/src/lib/structures/Command.ts:650


options

Optional options: boolean | readonly string[]

Inherited from

FlagStrategyOptions.options

Defined in

projects/framework/src/lib/utils/strategies/FlagUnorderedStrategy.ts:22


preconditions

Optional preconditions: readonly PreconditionEntryResolvable[]

Defined in

projects/framework/src/lib/structures/Command.ts:630


prefixes

Optional prefixes: string[]

Inherited from

FlagStrategyOptions.prefixes

Defined in

projects/framework/src/lib/utils/strategies/FlagUnorderedStrategy.ts:28


quotes

Optional quotes: [string, string][]

Defined in

projects/framework/src/lib/structures/Command.ts:643


requiredClientPermissions

Optional requiredClientPermissions: PermissionResolvable

Defined in

projects/framework/src/lib/structures/Command.ts:686


requiredUserPermissions

Optional requiredUserPermissions: PermissionResolvable

Defined in

projects/framework/src/lib/structures/Command.ts:693


runIn

Optional runIn: null | CommandOptionsRunType | CommandOptionsRunTypeEnum | readonly (CommandOptionsRunType | CommandOptionsRunTypeEnum)[]

Defined in

projects/framework/src/lib/structures/Command.ts:700


separators

Optional separators: string[]

Inherited from

FlagStrategyOptions.separators

Defined in

projects/framework/src/lib/utils/strategies/FlagUnorderedStrategy.ts:34


typing

Optional typing: boolean

Defined in

projects/framework/src/lib/structures/Command.ts:707