CommandHandler

A sub hub for creating and managing more customized commands.

warning

You should never have to construct this class yourself.

import { client } from 'beapi-core';

const newHandler = client.commands.createHandler(...);

Constructor

new CommandHandler(client, cm, prefix);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
client	Client	❌	null	Constructed Client instance.
cm	CommandManager	❌	null	Constructed CommandManager instance.
prefix	string	❌	null	Prefix to use.

Methods

changePrefix

Changes handlers prefix to something different.

changePrefix(prefix);

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

Returns

void

---

getPrefix

Get handlers current prefix.

getPrefix();

Returns

string

---

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>

---