Command

^{ref / commands / Command}

Class that represents a single command and allows you to configure it.

^Source

Implements

MiddlewareObj<C>

Type Parameters

C

C extends Context = Context

Constructors

Command(
  name: string | RegExp,
  description: string,
  handler: MaybeArray<Middleware<CommandContext<C>>>,
  options?: Partial<CommandOptions>,
);

Initialize a new command with a default handler.

[!IMPORTANT] This class by its own does nothing. It needs to be imported into a CommandGroup via the add method.

^Source

Command(
  name: string | RegExp,
  description: string,
  options?: Partial<CommandOptions>,
);

Initialize a new command with no handlers.

[!IMPORTANT] This class by its own does nothing. It needs to be imported into a CommandGroup via the add method

^Source

Command(
  name: string | RegExp,
  description: string,
  handlerOrOptions?: MaybeArray<Middleware<CommandContext<C>>> | Partial<CommandOptions>,
  options?: Partial<CommandOptions>,
);

^Source

Command(
  name: string | RegExp,
  description: string,
  handlerOrOptions?: MaybeArray<Middleware<CommandContext<C>>> | Partial<CommandOptions>,
  options?: Partial<CommandOptions>,
);

^Source

Methods

hasCustomPrefix (getter)

get hasCustomPrefix();

Whether the command has a custom prefix

^Source

stringName (getter)

get stringName();

Gets the command name as string

^Source

isApiCompliant

isApiCompliant();

Whether the command can be passed to a setMyCommands API call and, if not, the reason.

^Source

scopes (getter)

get scopes();

Get registered scopes for this command

^Source

languages (getter)

get languages();

Get registered languages for this command

^Source

names (getter)

get names();

Get registered names for this command

^Source

name (getter)

get name();

Get the default name for this command

^Source

description (getter)

get description();

Get the default description for this command

^Source

prefix (getter)

get prefix();

Get the prefix for this command

^Source

hasHandler (getter)

get hasHandler();

Get if this command has a handler

^Source

isEphemeral (getter)

get isEphemeral();

Whether this command is ephemeral.

Ephemeral commands are highlighted with a special icon in the bot menu, and the user’s command message stays invisible to other group members.

^Source

ephemeral

ephemeral();

Marks this command as ephemeral. This adds is_ephemeral: true to the command when it is serialized for a setMyCommands call.

By default, the handlers of an ephemeral command only run when the incoming command message was itself sent ephemerally. Pass { strict: false } to also run the handlers when the command is sent as a regular, non-ephemeral message.

Note: Some clients may send a command regularly if it is typed out rather than selected from the command menu.

^Source

addToScope

// Overload 1
addToScope();
// Overload 2
addToScope();
// Overload 3
addToScope();

Registers the command to a scope to allow it to be handled and used with setMyCommands. This will automatically apply filtering middlewares for you, so the handler only runs on the specified scope.

^Source

localize

localize();

Adds a new translation for the command

^Source

getLocalizedName

getLocalizedName();

Gets the localized command name of an existing translation

^Source

getLocalizedDescription

getLocalizedDescription();

Gets the localized command name of an existing translation

^Source

toObject

toObject();

Converts command to an object representation. Useful for JSON serialization.

^Source

middleware

middleware();

^Source

Static Methods

findMatchingCommand

findMatchingCommand();

Finds the matching command in the given context

^Source

hasCommand

hasCommand();

Creates a matcher for the given command that can be used in filtering operations

^Source