Class Command

Command part for a module

Hierarchy

Constructors

constructor

Properties

aliases args cooldown description? execute guildOnly id init name ownerOnly permissions? usage?

Constructors

constructor

Properties

aliases

aliases: string[] = []

List of alternative names

args

args: number = 0

Minimum amount of arguments

cooldown

cooldown: number = 0

Minimum time (in seconds) between usages

Optional description

description?: string

Description of the command

execute

execute: ((...args: any[]) => Promise<void>)

Type declaration

    • (...args: any[]): Promise<void>

    • The function when the part is executed

      Parameters

      • Rest ...args: any[]

      Returns Promise<void>

guildOnly

guildOnly: boolean = true

If the command can only be executed in a guild

id

id: string

ID of the part

init

init: undefined | ((artibot: Artibot) => Promise<void>)

The function executed on bot startup

name

name: string

Name of the command

ownerOnly

ownerOnly: boolean = false

If the command can only be executed by the owner of the bot

Optional permissions

permissions?: PermissionResolvable

Required permissions

Optional usage

usage?: string

Help text on how to use the command

Settings

Member Visibility

Theme

Generated using TypeDoc v0.23.28