SubCommand | Advanced Command-Handler

see: https://ayfri.gitbook.io/advanced-command-handler/concepts/commands/subcommands
remarks: This class is not in the SubCommand file because otherwise it won't compile because of circular because of the Command.subCommands property.

Hierarchy

Command
- SubCommand

Index

Properties

Constructors

constructor

Methods

Accessors

Properties

Optional aliases

aliases: string[]

The aliases of the command.

arguments

arguments: Record<string, Argument<any>> = {}

The arguments of the command. You can put your own custom arguments but you must add the type to the argument types.

Optional category

category: string

The category of the command.

defaultvalue: The command parent directory.

Optional channels

channels: (string | TextChannel)[]

The channels where the command should only be executed if used (if using the default message event).

Optional clientPermissions

clientPermissions: string[]

The client permissions needed to run the command (if using the default message event).

defaultvalue: ['SEND_MESSAGES']

Optional cooldown

cooldown: number

The cooldown of the command in seconds.

defaultvalue: 0
remarks: Every cooldown should be saved in CommandHandler.cooldowns.

Optional description

description: string

The description of the command.

Readonly name

name: string

The name of the SubCommand.

Readonly runFunction

runFunction: RunSubCommandFunction

The function executed when the SubCommand is executed.

subCommands

subCommands: SubCommand[] = []

The SubCommands of this command.

remarks: Register SubCommands using the {@link Command#registerSubCommands} method.

Optional tags

tags: string[]

The tags of the command.

remarks: How tags works ?
see: Tag

Optional usage

usage: string

The usage of the command.

example

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

remarks

If no value is set, in most places it will use the result of the {@link Command#signatures} method.

Optional userPermissions

userPermissions: string[]

The user permissions needed to run the command (if using the default message event).

defaultvalue: ['SEND_MESSAGES']

Constructors

constructor

new SubCommand(name: string, options?: SubCommandOptions, runFunction: RunSubCommandFunction): SubCommand

Overrides Command.constructor
- Defined in source/src/classes/commands/Command.ts:572
Creates a new SubCommand.

remarks

Make sure to creates the Subcommands in the {@link Command#registerSubCommands} method.

Parameters
- name: string
  
  The name of the SubCommand.
- options: SubCommandOptions = {}
  
  The options of the Subcommand.
- runFunction: RunSubCommandFunction
  
  The callback executed when the SubCommand is executed.
Returns SubCommand

Methods

deleteMessage

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

Inherited from Command.deleteMessage
- Defined in source/src/classes/commands/Command.ts:246
Deletes a message if deletable.

Parameters
- options: DeleteMessageOptions
  
  The options, see DeleteMessageOptions.
Returns undefined | Promise<Message> | Timeout
- If not deletable nothing, else the deleted message or the Node.js Timer if a timeout is set.

execute

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

Inherited from Command.execute
- Defined in source/src/classes/commands/Command.ts:258
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: string | Message | User | GuildMember): Cooldown

Inherited from Command.getCooldown
- Defined in source/src/classes/commands/Command.ts:287
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 | Message | User | GuildMember
  
  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[] }

Inherited from Command.getInvalidPermissions
- Defined in source/src/classes/commands/Command.ts:301
Returns the invalid permissions (not presents in Permissions.FLAGS).

internal

Returns { client: string[]; user: string[] }
- The invalid permissions put in clientPermissions & userPermissions.
- client: string[]
- user: string[]

getMissingPermissions

getMissingPermissions(ctx: CommandContext): MissingPermissions

Inherited from Command.getMissingPermissions
- Defined in source/src/classes/commands/Command.ts:316
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: CommandContext): Tag[]

Inherited from Command.getMissingTags
- Defined in source/src/classes/commands/Command.ts:352
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: string | Message | User | GuildMember): boolean

Inherited from Command.isInCooldown
- Defined in source/src/classes/commands/Command.ts:364
Returns true if the user is in a cooldown for this command.

remarks

If cooldown not set, this will always return false.

Parameters
- from: string | Message | User | GuildMember
  
  From where to test if user/guild/message is in a cooldown, see types.
Returns boolean
- Is user in a cooldown.

isInRightChannel

isInRightChannel(ctx: CommandContext): boolean

Inherited from Command.isInRightChannel
- Defined in source/src/classes/commands/Command.ts:375
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

Inherited from Command.registerSubCommands
- Defined in source/src/classes/commands/Command.ts:127
Override this method to register your subCommands.

Returns any

run

run(ctx: SubCommandContext): Promise<any>

Overrides Command.run
- Defined in source/src/classes/commands/Command.ts:555
The method executed when the SubCommand is executed.

Parameters
- ctx: SubCommandContext
  
  The SubCommandContext.
Returns Promise<any>
- Any.

setCooldown

setCooldown(from: string | Message | User | GuildMember): void

Inherited from Command.setCooldown
- Defined in source/src/classes/commands/Command.ts:393
Put all the required properties in CommandHandler.cooldowns plus the setTimeout to remove the user from the cooldowns.

Parameters
- from: string | Message | User | GuildMember
  
  What to use to select the user to set the cooldown from, can be a guild/message/member.
Returns void

signature

signature(options?: CommandSignatureOptions): string

Inherited from Command.signature
- Defined in source/src/classes/commands/Command.ts:418
Get the signature of this command.
example
// The help command with an optional command commandArgument argument.
```
help [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.

signatures

signatures(options?: CommandSignatureOptions): string

Inherited from Command.signatures
- Defined in source/src/classes/commands/Command.ts:448
Returns the signature of the command plus the signature of the subCommands of this command.
example
// The help command with an optional command commandArgument argument and a all subCommand with no arguments.
```
help [command]
help all
```
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.

validate

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

Inherited from Command.validate
- Defined in source/src/classes/commands/Command.ts:460
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.

Protected subCommand

subCommand(name: string, callback: RunSubCommandFunction): void
subCommand(name: string, options: SubCommandOptions, callback: RunSubCommandFunction): void

Inherited from Command.subCommand
- Defined in source/src/classes/commands/Command.ts:511
Parameters
- name: string
- callback: RunSubCommandFunction
Returns void
Inherited from Command.subCommand
- Defined in source/src/classes/commands/Command.ts:512
Parameters
- name: string
- options: SubCommandOptions
- callback: RunSubCommandFunction
Returns void

Accessors

nameAndAliases

get nameAndAliases(): string[]

- Defined in source/src/classes/commands/Command.ts:218
Returns the names and aliases of this command in an array.

Returns string[]

subCommandsNamesAndAliases

get subCommandsNamesAndAliases(): string[]

- Defined in source/src/classes/commands/Command.ts:225
Returns the names and aliases of the subCommands of this command in an array flatted.

Returns string[]

Hierarchy

Index

Properties

Constructors

Methods

Accessors

Properties

Optional aliases

arguments

Optional category

Optional channels

Optional clientPermissions

Optional cooldown

Optional description

Readonly name

Readonly runFunction

subCommands

Optional tags

Optional usage

Optional userPermissions

Constructors

constructor

Parameters

name: string

options: SubCommandOptions = {}

runFunction: RunSubCommandFunction

Returns SubCommand

Methods

deleteMessage

Parameters

options: DeleteMessageOptions

Returns undefined | Promise<Message> | Timeout

execute

Parameters

ctx: CommandContext

Returns Promise<undefined | CommandError>

getCooldown

Parameters

from: string | Message | User | GuildMember

Returns Cooldown

getInvalidPermissions

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

client: string[]

user: string[]

getMissingPermissions

Parameters

ctx: CommandContext

Returns MissingPermissions

getMissingTags

Parameters

ctx: CommandContext

Returns Tag[]

isInCooldown

Parameters

from: string | Message | User | GuildMember

Returns boolean

isInRightChannel

Parameters

ctx: CommandContext

Returns boolean

Optional registerSubCommands

Returns any

run

Parameters

ctx: SubCommandContext

Returns Promise<any>

setCooldown

Parameters

from: string | Message | User | GuildMember

Returns void

signature

Parameters

Optional options: CommandSignatureOptions

Returns string

signatures

Parameters

Optional options: CommandSignatureOptions

Returns string

validate

Parameters