Class CommandContext

constructor

• new CommandContext(options): CommandContext

• Creates a new CommandContext associated to a Command.

  Parameters

  • options: CommandContextBuilder

    The options of the CommandContext.

  Returns CommandContext

Optional argumentParser

command

handler

message

rawArgs

args

• get args(): string[]

• The old list of raw arguments.

  Returns string[]

  Deprecated

  • Use CommandContext#rawArgs instead.

argsString

• get argsString(): string

• Returns the arguments joined with a space between each.

  Returns string

arguments

• get arguments(): CommandArgument<any>[]

• Returns the list of arguments of the command.

  Returns CommandArgument<any>[]

channel

• get channel(): DMChannel | PartialDMChannel | NewsChannel | StageChannel | TextChannel | ThreadChannel | VoiceChannel

• Returns the channel where the command was executed.

  Returns DMChannel | PartialDMChannel | NewsChannel | StageChannel | TextChannel | ThreadChannel | VoiceChannel

client

• get client(): AdvancedClient

• Returns the client.

  Returns AdvancedClient

commandName

• get commandName(): string

• Returns the name of the command executed.

  Returns string

content

• get content(): string

• Returns the content of the message.

  Returns string

guild

• get guild(): null | Guild

• Returns the guild of the message.

  Returns null | Guild

isCallingASubCommand

• get isCallingASubCommand(): boolean

• Returns true if the arguments are calling a SubCommand.

  Returns boolean

member

• get member(): null | GuildMember

• Returns the member of the message, null if executed in private messages.

  Returns null | GuildMember

prefix

• get prefix(): string

• Returns the prefix used in the message.

  Returns string

textChannel

• get textChannel(): undefined | NewsChannel | TextChannel

• Returns the channel where the command was executed as a TextChannel or undefined if it isn't.

  Returns undefined | NewsChannel | TextChannel

thread

• get thread(): undefined | ThreadChannel

• Returns the channel where the command was executed as a ThreadChannel or undefined if it isn't.

  Returns undefined | ThreadChannel

user

• get user(): User

• Returns the author of the message.

  Returns User

argument

• argument<T>(name): Promise<null | T>

• Returns an argument. If the argument is errored or not found it will return null.

  Type Parameters

  • T

    The type of the argument.

  Parameters

  • name: string

    The name of the argument.

  Returns Promise<null | T>

  • The argument in a promise or null if the argument is not found or errored or the command has no arguments.

bulkDeleteInChannel

• bulkDeleteInChannel(number, filterOld?): Promise<Collection<string, Message<boolean>>>

• Parameters

  • number: number

  • Optional filterOld: boolean

  Returns Promise<Collection<string, Message<boolean>>>
• bulkDeleteInChannel(number, filterOld?): Promise<Collection<string, Message<boolean>>>

• Parameters

  • number: Collection<string, Message<boolean>>

  • Optional filterOld: boolean

  Returns Promise<Collection<string, Message<boolean>>>
• bulkDeleteInChannel(number, filterOld?): Promise<Collection<string, Message<boolean>>>

• Parameters

  • number: readonly MessageResolvable[]

  • Optional filterOld: boolean

  Returns Promise<Collection<string, Message<boolean>>>

createThread

• createThread(options): undefined | Promise<ThreadChannel>

• Create a Thread, returns undefined if already in a Thread.

  Parameters

  • options: StartThreadOptions

    The options of the Thread.

  Returns undefined | Promise<ThreadChannel>

  • The resulting Thread.

deleteMessage

• deleteMessage(timeout?): Promise<Message<boolean>>

• Deletes the message with an optional timeout.

  Parameters

  • timeout: number = 0

    The time to wait in milliseconds before deleting the message.

  Returns Promise<Message<boolean>>

  • The deleted message.

react

• react(...emoji): Promise<void>

• Add one or multiple reactions to a message.

  Parameters

  • Rest ...emoji: EmojiIdentifierResolvable[]

    The emoji to react with, can be custom or native.

  Returns Promise<void>

  Remarks

  React in the order of emoji used.

removeAllReactions

• removeAllReactions(): Promise<void>

• Remove all the reactions.

  Returns Promise<void>

removeReaction

• removeReaction(...emojis): Promise<void>

• Remove one or multiple reactions from emojis.

  Parameters

  • Rest ...emojis: EmojiIdentifierResolvable[]

    The list of emoji reactions to remove.

  Returns Promise<void>

removeSelfReaction

• removeSelfReaction(...emojis): Promise<void>

• Remove one or multiple reactions from the bot.

  Parameters

  • Rest ...emojis: EmojiIdentifierResolvable[]

    The emojis the bot has to remove reaction from.

  Returns Promise<void>

reply

• reply(options): Promise<Message<boolean>>

• Parameters

  • options: ReplyOptions

  Returns Promise<Message<boolean>>
• reply(content): Promise<Message<boolean>>

• Parameters

  • content: string

  Returns Promise<Message<boolean>>
• reply(content, options): Promise<Message<boolean>>

• Parameters

  • content: string

  • options: ReplyOptions

  Returns Promise<Message<boolean>>

resolveArgument

• resolveArgument<T>(name): undefined | Awaitable<ArgumentResolved<T>>

• Resolves one of the argument. If the argument is errored it will return a CommandError.

  Type Parameters

  • T

    The type of the argument.

  Parameters

  • name: string

    The name of the argument.

  Returns undefined | Awaitable<ArgumentResolved<T>>

  • The result of the argument maybe in a promise or undefined if no arguments with this name exists or the command has no arguments.

  Remarks

  Internally it uses resolveArguments.

resolveArguments

• resolveArguments<A>(): Promise<undefined | Map<string, ArgumentResolved<A[number]>>>

• Resolves all of the arguments of the command. If an argument has an error it will return a CommandError.

  Type Parameters

  • A extends any[]

  Returns Promise<undefined | Map<string, ArgumentResolved<A[number]>>>

  • A map of arguments or undefined if the command has no arguments.

send

• send(options): Promise<Message<boolean>>

• Parameters

  • options: SendOptions

  Returns Promise<Message<boolean>>
• send(content): Promise<Message<boolean>>

• Parameters

  • content: string

  Returns Promise<Message<boolean>>
• send(content, options): Promise<Message<boolean>>

• Parameters

  • content: string

  • options: SendOptions

  Returns Promise<Message<boolean>>

sendGlobalHelpMessage

• sendGlobalHelpMessage(): Promise<Message<boolean>>

• Sends the help menu from the default HelpCommand command (even if you are not using it).

  Returns Promise<Message<boolean>>

  • The message of the help menu.

sendHelpMessage

• sendHelpMessage(commandName?): Promise<undefined | Message<boolean>>

• Sends the help menu of the command from the default HelpCommand command (even if you are not using it).

  Parameters

  • commandName: string = ...

    The name of the command to send the help menu.

  Returns Promise<undefined | Message<boolean>>

  • The message of the help menu of the command.