Class CommandAbstract

constructor

• new Command(): Command

• Returns Command

Optional aliases

arguments

Optional category

The command parent directory.
Copy

Optional channels

Optional clientPermissions

Optional cooldown

0
Copy

Optional description

Readonly Abstract name

subCommands

Optional tags

Optional usage

userinfo
userinfo me
userinfo <ID/Username/Mention of User>
Copy

Optional userPermissions

nameAndAliases

• get nameAndAliases(): string[]

• Returns the names and aliases of this command in an array.

  Returns string[]

subCommandsNamesAndAliases

• get subCommandsNamesAndAliases(): string[]

• Returns the names and aliases of the subCommands of this command in an array flatted.

  Returns string[]

deleteMessage

• deleteMessage(options): undefined | Promise<Message<boolean>> | Timeout

• Deletes a message if deletable.

  Parameters

  • options: DeleteMessageOptions

    The options, see DeleteMessageOptions.

  Returns undefined | Promise<Message<boolean>> | Timeout

  • If not deletable nothing, else the deleted message or the Node.js Timer if a timeout is set.

execute

• execute(ctx): Promise<undefined | CommandError>

• Execute the run method, but perform validations before, prefer using this method in your custom Message Event.

  Parameters

  • ctx: CommandContext

    The CContext.

  Returns Promise<undefined | CommandError>

  • An error related to the command if any, for example : a tag not satisfied.

getCooldown

• getCooldown(from): Cooldown

• Get the actual cooldown of the user for this command plus when command has been executed and how many seconds to wait.

  Parameters

  • from: string | User | GuildMember | Message<boolean>

    Where to get the cooldown from, can be a user/guild/message, see types.

  Returns Cooldown

  • The user's cooldown.

getInvalidPermissions

• getInvalidPermissions(): {
      client: string[];
      user: string[];
  }
• Internal

  Returns the invalid permissions (not presents in Permissions.FLAGS).

  Returns {
      client: string[];
      user: string[];
  }

  • The invalid permissions put in clientPermissions & userPermissions.

  • client: string[]

  • user: string[]

getMissingPermissions

• getMissingPermissions(ctx): MissingPermissions

• Returns the missing permissions from the client & user for a context.

  Parameters

  • ctx: CommandContext

    The context to validate permissions for.

  Returns MissingPermissions

  • The missing permissions.

getMissingTags

• getMissingTags(ctx): Tag[]

• Gives the tags of this command which are not validated by the context.
  i.e. If a command is executed on a guild and the command has the dmOnly Tag, it will be returned.

  Parameters

  • ctx: CommandContext

    The context to test tags from.

  Returns Tag[]

  • Tags that are not validated by the message.

isInCooldown

• isInCooldown(from): boolean

• Returns true if the user is in a cooldown for this command.

  Parameters

  • from: string | User | GuildMember | Message<boolean>

    From where to test if user/guild/message is in a cooldown, see types.

  Returns boolean

  • Is user in a cooldown.

  Remarks

  If cooldown not set, this will always return false.

isInRightChannel

• isInRightChannel(ctx): boolean

• Returns false if channels are defined for this command but the message doesn't come from one of it.

  Parameters

  • ctx: CommandContext

    The context to test where it comes from.

  Returns boolean

  • If it is on a channel required if used.

Optional registerSubCommands

• registerSubCommands(): any

• Override this method to register your subCommands.

  Returns any

Abstract run

• run(ctx): any

• The function to run when executing the command.

  Parameters

  • ctx: CommandContext

    The command context.

  Returns any

  Remarks

  Use the Command#execute method if you want to have a validation before executing the run method.

setCooldown

• setCooldown(from): void

• Put all the required properties in CommandHandler.cooldowns plus the setTimeout to remove the user from the cooldowns.

  Parameters

  • from: string | User | GuildMember | Message<boolean>

    What to use to select the user to set the cooldown from, can be a guild/message/member.

  Returns void

signature

• signature(options?): string

• Get the signature of this command.

  Parameters

  • Optional options: CommandSignatureOptions

    The options for the signature, show the type of the arguments or the default values.

  Returns string

  • The signature of this command or subCommand.

  Example

  // The help command with an optional command commandArgument argument.

  help [command]
  Copy

signatures

• signatures(options?): string

• Returns the signature of the command plus the signature of the subCommands of this command.

  Parameters

  • Optional options: CommandSignatureOptions

    The options for the signature, show the type of the arguments or the default values.

  Returns string

  • The signatures of the command.

  Example

  // The help command with an optional command commandArgument argument and a all subCommand with no arguments.

  help [command]
  help all
  Copy

validate

• validate(ctx): Promise<undefined | CommandErrorBuilder>

• Validate a command, returning an error if any of the validation methods are not valid.

  Parameters

  • ctx: CommandContext

    The CommandContext.

  Returns Promise<undefined | CommandErrorBuilder>

  • The error if any.