CommandManager

The main hub for creating and managing commands.

warning

You should never have to construct this class yourself.

import { client } from 'beapi-core';

client.commands.register(...);

Constructor

new CommandManager(client);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
client	Client	❌	null	Constructed Client instance.

Methods

createHandler

Creates a new command handler allowing for a different prefix and more customizations.

createHandler(prefix);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
prefix	string	❌	undefined	Prefix new handler should use.

Returns

CommandHandler

---

removeHandler

Removes a custom handler.

removeHandler(prefix);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
prefix	string	❌	undefined	Prefix of handler.

Returns

void

---

getHandler

Gets a custom handler.

getHandler(prefix);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
prefix	string	❌	undefined	Prefix of handler.

Returns

CommandHandler | undefined

---

setHandler

Sets a custom handler.

setHandler(prefix, handler);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
prefix	string	❌	undefined	Prefix of handler.
handler	CommandHandler	❌	undefined	CommandHandler instance.

Returns

void

---

register

Register a command with the default handler.

register(options, cb);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
options	CommandOptions	❌	undefined	Options for command.
cb	CommandCallback	❌	undefined	Callback function called on usage.

Returns

void

---

unregister

Unregister a command on the default handler.

unregister(name);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
name	string	❌	undefined	Name of the command.

Returns

void

---

get

Gets a command on the default handler.

get(name);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
name	string	❌	undefined	Name of the command.

Returns

Command | undefined

---

getAll

Gets all commands on the default handler.

getAll();

Returns

Map<string, Command>

---

disable

Disables default command handler (useful cause current one is temporary, whoops).

disable();

Returns

void

---