CommandGroup

^{ref / commands / CommandGroup}

Central class that manages all registered commands. This is the starting point for the plugin, and this is what you should pass to bot.use so your commands get properly registered.

^Source

Type Parameters

C

C extends Context

Constructors

CommandGroup(options: Partial<CommandOptions>);

^Source

Methods

command

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

Registers a new command with a default handler.

^Source

add

add(command: Command<C> | Command<C>[]);

Registers a Command that was created by it’s own.

^Source

toArgs

toArgs();

Serializes the commands into multiple objects that can each be passed to a setMyCommands call.

^Source

toSingleScopeArgs

toSingleScopeArgs(scope: BotCommandScope);

Serializes the commands of a single scope into objects that can each be passed to a setMyCommands call.

^Source

setCommands

setCommands({ api }: { api: Api }, options?: Partial<SetBotCommandsOptions>): Promise<void>;

Registers all commands to be displayed by clients according to their scopes and languages Calls setMyCommands for each language of each scope of each command.

[!IMPORTANT] Calling this method with upperCased command names registered, will throw

^Source

toElementals

toElementals(filterLanguage?: LanguageCode | "default"): CommandElementals[];

Serialize all register commands into it’s name, prefix and language

^Source

toString

toString();

^Source

middleware

middleware();

^Source

commands (getter)

get commands(): Command<C>[];

^Source

prefixes (getter)

get prefixes(): string[];

^Source

[Symbol.for("Deno.customInspect")]

[Symbol.for("Deno.customInspect")]();

Replaces the toString method on Deno

^Source

[Symbol.for("nodejs.util.inspect.custom")]

[Symbol.for("nodejs.util.inspect.custom")]();

Replaces the toString method on Node.js

^Source