Interface ChatInputCommandInterface

Represents the structure of a chat input command.

Hierarchy

CommandInterface
- ChatInputCommandInterface

Index

Properties

category? data disabled? execute metadata?

Properties

`Optional` category

category?: string

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

data

data: SlashCommandBuilder | SlashCommandSubcommandsOnlyBuilder | Omit<SlashCommandBuilder, "addSubcommand" | "addSubcommandGroup">

The slash command data of this command.

`Optional` disabled

disabled?: boolean

Whether the command should be ignored or not.

execute

execute: ((this: ChatInputCommand, interaction: ChatInputCommandInteraction<CacheType>) => unknown)

Type declaration

- (this: ChatInputCommand, interaction: ChatInputCommandInteraction<CacheType>): unknown
- The function to run when the command is triggered.
  Parameters
  - this: ChatInputCommand
  - interaction: ChatInputCommandInteraction<CacheType>
    
    The interaction that triggered the command.
  Returns unknown

`Optional` metadata

metadata?: unknown

Additional metadata associated with the command.

Generated using TypeDoc