Command

Specifications

  • Type: Object - {}

  • Valid fields: 8

Fields

Name

Type

Description

Optional

name

string

The name to display in the help command

no

invoke

string[]

Array of strings that can be user to invoke the command

no

description

string

Description to display in the help command

no

usage

string

String containing a short description of a usage for the command, this is automatically appended to the invokes

no, but it can be an empty string

execute

AsyncFunction

Function taking 2 arguments, the Message object and an options object. Returns Promise\. This is executed when the commands is invoked

no

category

string

The category the command should appear in, general, or any name added by addCategory​

no

permissions

string[]

Array of valid Discord permissions that can execute this command, empty means everyone, fallback to empty

yes

omitHelp

boolean

Whether to omit this command from help, fallback to false

yes

Last updated