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(language?: LanguageCode | "default"): [true] | [false, string[]];

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(): boolean;

Get if this command has a handler

^Source

addToScope

// Overload 1
addToScope(
  scope: BotCommandGroupsScope,
  middleware?: MaybeArray<ChatTypeMiddleware<C, "group" | "supergroup">>,
  options?: Partial<CommandOptions>,
): this;
// Overload 2
addToScope(
  scope: BotCommandScopeAllPrivateChats,
  middleware?: MaybeArray<ChatTypeMiddleware<C, "private">>,
  options?: Partial<CommandOptions>,
): this;
// Overload 3
addToScope(
  scope: BotCommandScope,
  middleware?: MaybeArray<Middleware<C>>,
  options?: Partial<CommandOptions>,
): this;

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(
  languageCode: LanguageCode,
  name: string | RegExp,
  description: string,
);

Adds a new translation for the command

^Source

getLocalizedName

getLocalizedName(languageCode: LanguageCode | "default");

Gets the localized command name of an existing translation

^Source

getLocalizedDescription

getLocalizedDescription(languageCode: LanguageCode | "default");

Gets the localized command name of an existing translation

^Source

toObject

toObject(languageCode: LanguageCode | "default"): Pick<BotCommandX, "command" | "description" | "hasHandler">;

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

^Source

middleware

middleware();

^Source

Static Methods

findMatchingCommand

findMatchingCommand(
  command: MaybeArray<string | RegExp>,
  options: CommandOptions,
  ctx: Context,
): CommandMatch | null;

Finds the matching command in the given context

^Source

hasCommand

hasCommand(command: MaybeArray<string | RegExp>, options: CommandOptions);

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

^Source