SubCommandContext | Advanced Command-Handler

see: https://ayfri.gitbook.io/advanced-command-handler/concepts/commands/context

Hierarchy

CommandContext
- SubCommandContext

Index

Accessors

Methods

Properties

Constructors

constructor

Accessors

args

get args(): string[]

- Defined in source/src/classes/contexts/CommandContext.ts:90
The old list of raw arguments.
deprecated
- Use {@link CommandContext#rawArgs} instead.
Returns string[]

argsString

get argsString(): string

- Defined in source/src/classes/contexts/CommandContext.ts:97
Returns the arguments joined with a space between each.

Returns string

arguments

get arguments(): CommandArgument<any>[]

- Defined in source/src/classes/contexts/SubCommandContext.ts:37
Returns the list of arguments of the SubCommand.

Returns CommandArgument<any>[]

channel

get channel(): TextBasedChannels

- Defined in source/src/classes/contexts/CommandContext.ts:111
Returns the channel where the command was executed.

Returns TextBasedChannels

client

get client(): AdvancedClient

- Defined in source/src/classes/contexts/CommandContext.ts:118
Returns the client.

Returns AdvancedClient

commandName

get commandName(): string

- Defined in source/src/classes/contexts/CommandContext.ts:125
Returns the name of the command executed.

Returns string

content

get content(): string

- Defined in source/src/classes/contexts/CommandContext.ts:132
Returns the content of the message.

Returns string

guild

get guild(): null | Guild

- Defined in source/src/classes/contexts/CommandContext.ts:139
Returns the guild of the message.

Returns null | Guild

isCallingASubCommand

get isCallingASubCommand(): boolean

- Defined in source/src/classes/contexts/CommandContext.ts:146
Returns true if the arguments are calling a SubCommand.

Returns boolean

member

get member(): null | GuildMember

- Defined in source/src/classes/contexts/CommandContext.ts:155
Returns the member of the message, null if executed in private messages.

Returns null | GuildMember

prefix

get prefix(): string

- Defined in source/src/classes/contexts/CommandContext.ts:162
Returns the prefix used in the message.

Returns string

subCommandName

get subCommandName(): string

- Defined in source/src/classes/contexts/SubCommandContext.ts:56
Returns the name of the subCommand associated to this SubCommandContext.

Returns string

textChannel

get textChannel(): undefined | TextChannel | NewsChannel

- Defined in source/src/classes/contexts/CommandContext.ts:169
Returns the channel where the command was executed as a TextChannel or undefined if it isn't.

Returns undefined | TextChannel | NewsChannel

thread

get thread(): undefined | ThreadChannel

- Defined in source/src/classes/contexts/CommandContext.ts:176
Returns the channel where the command was executed as a ThreadChannel or undefined if it isn't.

Returns undefined | ThreadChannel

user

get user(): User

- Defined in source/src/classes/contexts/CommandContext.ts:183
Returns the author of the message.

Returns User

Methods

argument

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

Inherited from CommandContext.argument
- Defined in source/src/classes/contexts/CommandContext.ts:195
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: number, filterOld?: boolean): Promise<Collection<string, Message>>
bulkDeleteInChannel(number: Collection<string, Message>, filterOld?: boolean): Promise<Collection<string, Message>>
bulkDeleteInChannel(number: readonly MessageResolvable[], filterOld?: boolean): Promise<Collection<string, Message>>

Inherited from CommandContext.bulkDeleteInChannel
- Defined in source/src/classes/contexts/CommandContext.ts:200
Parameters
- number: number
- Optional filterOld: boolean
Returns Promise<Collection<string, Message>>
Inherited from CommandContext.bulkDeleteInChannel
- Defined in source/src/classes/contexts/CommandContext.ts:201
Parameters
- number: Collection<string, Message>
- Optional filterOld: boolean
Returns Promise<Collection<string, Message>>
Inherited from CommandContext.bulkDeleteInChannel
- Defined in source/src/classes/contexts/CommandContext.ts:202
Parameters
- number: readonly MessageResolvable[]
- Optional filterOld: boolean
Returns Promise<Collection<string, Message>>

createThread

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

Inherited from CommandContext.createThread
- Defined in source/src/classes/contexts/CommandContext.ts:222
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?: number): Promise<Message>

Inherited from CommandContext.deleteMessage
- Defined in source/src/classes/contexts/CommandContext.ts:233
Deletes the message with an optional timeout.

Parameters
- timeout: number = 0
  
  The time to wait in milliseconds before deleting the message.
Returns Promise<Message>
- The deleted message.

react

react(...emoji: EmojiIdentifierResolvable[]): Promise<void>

Inherited from CommandContext.react
- Defined in source/src/classes/contexts/CommandContext.ts:249
Add one or multiple reactions to a message.

remarks

React in the order of emoji used.

Parameters
- Rest ...emoji: EmojiIdentifierResolvable[]
  
  The emoji to react with, can be custom or native.
Returns Promise<void>

removeAllReactions

removeAllReactions(): Promise<void>

Inherited from CommandContext.removeAllReactions
- Defined in source/src/classes/contexts/CommandContext.ts:258
Remove all the reactions.

Returns Promise<void>

removeReaction

removeReaction(...emojis: EmojiIdentifierResolvable[]): Promise<void>

Inherited from CommandContext.removeReaction
- Defined in source/src/classes/contexts/CommandContext.ts:267
Remove one or multiple reactions from emojis.

Parameters
- Rest ...emojis: EmojiIdentifierResolvable[]
  
  The list of emoji reactions to remove.
Returns Promise<void>

removeSelfReaction

removeSelfReaction(...emojis: EmojiIdentifierResolvable[]): Promise<void>

Inherited from CommandContext.removeSelfReaction
- Defined in source/src/classes/contexts/CommandContext.ts:278
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: ReplyOptions): Promise<Message>
reply(content: string): Promise<Message>
reply(content: string, options: ReplyOptions): Promise<Message>

Inherited from CommandContext.reply
- Defined in source/src/classes/contexts/CommandContext.ts:284
Parameters
- options: ReplyOptions
Returns Promise<Message>
Inherited from CommandContext.reply
- Defined in source/src/classes/contexts/CommandContext.ts:285
Parameters
- content: string
Returns Promise<Message>
Inherited from CommandContext.reply
- Defined in source/src/classes/contexts/CommandContext.ts:286
Parameters
- content: string
- options: ReplyOptions
Returns Promise<Message>

resolveArgument

resolveArgument<T>(name: string): undefined | MaybePromise<ArgumentResolved<T>>

Inherited from CommandContext.resolveArgument
- Defined in source/src/classes/contexts/CommandContext.ts:313
Resolves one of the argument. If the argument is errored it will return a CommandError.

remarks

Internally it uses resolveArguments.

Type parameters
- T
  
  The type of the argument.
Parameters
- name: string
  
  The name of the argument.
Returns undefined | MaybePromise<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.

resolveArguments

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

Overrides CommandContext.resolveArguments
- Defined in source/src/classes/contexts/SubCommandContext.ts:48
Resolves all of the arguments of the SubCommand. If an argument has an error it will return a CommandError.

typeparam

The type of the arguments as an union.

Type parameters
- A: any[]
Returns Promise<undefined | Map<string, ArgumentResolved<A[number]>>>
- A map of arguments or undefined if the SubCommand has no arguments.

send

send(options: SendOptions): Promise<Message>
send(content: string): Promise<Message>
send(content: string, options: SendOptions): Promise<Message>

Inherited from CommandContext.send
- Defined in source/src/classes/contexts/CommandContext.ts:330
Parameters
- options: SendOptions
Returns Promise<Message>
Inherited from CommandContext.send
- Defined in source/src/classes/contexts/CommandContext.ts:331
Parameters
- content: string
Returns Promise<Message>
Inherited from CommandContext.send
- Defined in source/src/classes/contexts/CommandContext.ts:332
Parameters
- content: string
- options: SendOptions
Returns Promise<Message>

sendGlobalHelpMessage

sendGlobalHelpMessage(): Promise<Message>

Inherited from CommandContext.sendGlobalHelpMessage
- Defined in source/src/classes/contexts/CommandContext.ts:355
Sends the help menu from the default HelpCommand command (even if you are not using it).

Returns Promise<Message>
- The message of the help menu.

sendHelpMessage

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

Inherited from CommandContext.sendHelpMessage
- Defined in source/src/classes/contexts/CommandContext.ts:365
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>
- The message of the help menu of the command.

Properties

Optional argumentParser

argumentParser: ArgumentParser

The argument parser of this context, if the command has no arguments it will be undefined.

command

command: Command

The command itself.

handler

handler: typeof CommandHandler

The handler.

message

message: Message

The message that executed the command.

rawArgs

rawArgs: string[]

The arguments in the message.

subCommand

subCommand: SubCommand

The SubCommand related to this SubcommandContext.

Constructors

constructor

new SubCommandContext(options: SubCommandContextBuilder): SubCommandContext

Overrides CommandContext.constructor
- Defined in source/src/classes/contexts/SubCommandContext.ts:29
Creates a new SubCommandContext associated to a SubCommand.

Parameters
- options: SubCommandContextBuilder
  
  The options of this context.
Returns SubCommandContext

Hierarchy

Index

Accessors

Methods

Properties

Constructors

Accessors

args

Returns string[]

argsString

Returns string

arguments

Returns CommandArgument<any>[]

channel

Returns TextBasedChannels

client

Returns AdvancedClient

commandName

Returns string

content

Returns string

guild

Returns null | Guild

isCallingASubCommand

Returns boolean

member

Returns null | GuildMember

prefix

Returns string

subCommandName

Returns string

textChannel

Returns undefined | TextChannel | NewsChannel

thread

Returns undefined | ThreadChannel

user

Returns User

Methods

argument

Type parameters

T

Parameters

name: string

Returns Promise<null | T>

bulkDeleteInChannel

Parameters

number: number

Optional filterOld: boolean

Returns Promise<Collection<string, Message>>

Parameters

number: Collection<string, Message>

Optional filterOld: boolean

Returns Promise<Collection<string, Message>>

Parameters

number: readonly MessageResolvable[]

Optional filterOld: boolean

Returns Promise<Collection<string, Message>>

createThread

Parameters

options: StartThreadOptions

Returns undefined | Promise<ThreadChannel>

deleteMessage

Parameters

timeout: number = 0

Returns Promise<Message>

react

Parameters

Rest ...emoji: EmojiIdentifierResolvable[]

Returns Promise<void>

removeAllReactions

Returns Promise<void>

removeReaction

Parameters

Rest ...emojis: EmojiIdentifierResolvable[]

Returns Promise<void>

removeSelfReaction

Parameters

Rest ...emojis: EmojiIdentifierResolvable[]

Returns Promise<void>

reply