Interface MessageCommandInterface

Represents the structure of a message command.

Hierarchy

  • CommandInterface
    • MessageCommandInterface

Properties

aliases? allowBots? alwaysExecute? category? description? disabled? execute insensitive? metadata? name usage?

Properties

Optional aliases

aliases?: string | string[]

An array of aliases for the command.

Optional allowBots

allowBots?: boolean

Whether the command should allow bots or not.

Optional alwaysExecute

alwaysExecute?: boolean

Whether the command should be executed regardless of the prefix and trigger.

Optional category

category?: string

The category the command belongs to. If not provided the directory name is used.

Optional description

description?: string

A short description of the command.

Optional disabled

disabled?: boolean

Whether the command should be ignored or not.

execute

execute: ((this: MessageCommand, data: MessageCommandData<boolean>, metadata: MessageCommandMetadata) => unknown)

Type declaration

Optional insensitive

insensitive?: boolean

Whether the trigger of the command should be case insensitive or not.

Default Value

true

Optional metadata

metadata?: unknown

Additional metadata associated with the command.

name

name: string

The name of the command.

Optional usage

usage?: string | string[]

A string or an array of strings describing the usage of the command.

Settings

Member Visibility

Theme

Generated using TypeDoc