Class HelpRegularCommand

The default help message. This regular command is part of the misc group.

The help message will look like this: Preview

Hierarchy

Constructors

constructor

Properties

aliases client description embedColor embedThumbnail emoji group groupID guildOnly name nsfw ownerOnly ownerOverride userPermissions

Methods

hasPermission onError prepareFields run

Constructors

constructor

Properties

Readonly aliases

aliases: string[]

Aliases for this command.

Memberof

Command

Default Value

[]

Readonly client

client: ExtendedClient

The client that this command will be used by.

Memberof

Command

Readonly description

description: string

The description of this command.

Memberof

Command

Private Readonly embedColor

embedColor: ColorResolvable

The color of the embed for the help message.

Memberof

HelpRegularCommand

Private Readonly embedThumbnail

embedThumbnail: string

The thumbnail of the embed for the help message.

Memberof

HelpRegularCommand

Readonly emoji

emoji: string

The emoji of this command. This is used by the default HelpSlashCommand.

Memberof

Command

Default Value

🤖

group

group: null | CommandGroup

The group that this command is registered to.

Remarks

This gets initialized on command registration.

Memberof

Command

Readonly groupID

groupID: string

The ID of the group that this command is registered to.

Memberof

Command

Readonly guildOnly

guildOnly: boolean

Whether this command may only be used in a guild.

Memberof

Command

Default Value

false

Readonly name

name: string

The name of this command.

Memberof

Command

Readonly nsfw

nsfw: boolean

Whether this command may only be used in a NSFW channel.

Memberof

Command

Default Value

false

Readonly ownerOnly

ownerOnly: boolean

Whether this command may only be used by the bot's owner.

Memberof

Command

Default Value

false

Readonly ownerOverride

ownerOverride: boolean

Whether the bot's owner can execute this command even if they don't have the required permissions.

Memberof

Command

Default Value

true

Readonly userPermissions

userPermissions: null | PermissionResolvable

The permissions resolvable that defines the permissions that a user requires to execute this command.

Memberof

Command

Default Value

null

Methods

hasPermission

  • Check whether the message author can execute this command.

    Parameters

    • message: Message<boolean>

      The message that triggered this command.

    Returns string | boolean

    true if the user has enough permissions, or a string with the reason why they cannot execute this command.

onError

  • Handle command error.

    Parameters

    • error: unknown

      The error that was thrown inside the command's run method.

    • message: Message<boolean>

      The message that triggered this command.

    Returns Promise<void>

    Emits

    client#commandError

prepareFields

  • Prepare the fields that will be added to the embed based on all the commands registered on the client. The title of the field will be the group's name and the text will be the list of commands.

    Returns EmbedField[]

    An array of objects that contain the field's title and text.

run

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc