Class CommandManager

Manages command storage, execution, and registration. You should not need to use this class directly; use the commands member instead.

Hierarchy

Properties

[toStringTag] size [species]

Methods

[iterator] autocomplete clear delete entries execute forEach get has keys registerAll set setToken unregister unregisterAll values

Properties

Readonly [toStringTag]

[toStringTag]: string

Readonly size

size: number

Returns

the number of elements in the Map.

Static Readonly [species]

[species]: MapConstructor

Methods

[iterator]

  • [iterator](): IterableIterator<[string, Command]>

  • Returns an iterable of entries in the map.

    Returns IterableIterator<[string, Command]>

autocomplete

  • autocomplete(commandName, argName, ...data): void

  • Executes the autocomplete handler of a command and argument of the given name. The data parameters are passed to the argument's autocomplete handler method as parameters.

    Parameters

    • commandName: string
    • argName: string
    • Rest ...data: any[]

    Returns void

clear

  • clear(): void

  • Returns void

delete

  • delete(key): boolean

  • Parameters

    • key: string

    Returns boolean

    true if an element in the Map existed and has been removed, or false if the element does not exist.

entries

  • entries(): IterableIterator<[string, Command]>

  • Returns an iterable of key, value pairs for every entry in the map.

    Returns IterableIterator<[string, Command]>

execute

  • execute(commandName, ...data): void

  • Executes a command of the given name, if possible. The data parameters are passed to the command's handler method as parameters.

    Parameters

    • commandName: string
    • Rest ...data: any[]

    Returns void

    Example

    // Common use in Discord.js 'interactionCreate' event:
    commands.execute(interaction.commandName, interaction);

forEach

  • forEach(callbackfn, thisArg?): void

  • Executes a provided function once per each key/value pair in the Map, in insertion order.

    Parameters

    • callbackfn: ((value, key, map) => void)
        • (value, key, map): void

        • Parameters

          Returns void

    • Optional thisArg: any

    Returns void

get

  • get(key): undefined | Command

  • Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

    Parameters

    • key: string

    Returns undefined | Command

    Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

has

  • has(key): boolean

  • Parameters

    • key: string

    Returns boolean

    boolean indicating whether an element with the specified key exists or not.

keys

  • keys(): IterableIterator<string>

  • Returns an iterable of keys in the map

    Returns IterableIterator<string>

registerAll

  • registerAll(): Promise<boolean>

  • Registers all commands created using @brynjolf/commands.

    Returns Promise<boolean>

set

  • set(key, value): this

  • Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

    Parameters

    Returns this

setToken

  • setToken(token, applicationId, devGuildId?): void

  • Sets the token, application ID, and optional guild ID. This method must be called before registering or unregistering any commands using the command manager.

    Parameters

    • token: string
    • applicationId: string
    • Optional devGuildId: string

    Returns void

unregister

  • unregister(commandName): Promise<boolean>

  • Unregisters the command with the given name.

    Parameters

    • commandName: string

    Returns Promise<boolean>

unregisterAll

  • unregisterAll(): Promise<boolean>

  • Unregisters all commands associated with this application.

    Returns Promise<boolean>

values

  • values(): IterableIterator<Command>

  • Returns an iterable of values in the map

    Returns IterableIterator<Command>

Settings

Member Visibility

Theme

On This Page

[toStringTag]size[species][iterator]autocompletecleardeleteentriesexecuteforEachgethaskeysregisterAllsetsetTokenunregisterunregisterAllvalues

Generated using TypeDoc