JSDoc: Class: Client

Constructor

new Client(token, options)

Create a client instance.

Parameters:

Name Type Description

token string The token used to log into the bot.

options

Object

Options to start the client with. This object is also passed to Eris. If there are a aghanim.config.js/json in project root, that will be loaded instead object passed to constructor. See Eris Client constructor options https://abal.moe/Eris/docs/Client

Properties

Name	Type	Attributes	Default	Description
`prefix`	string	<optional>	''	The prefix the bot will respond to in guilds for which there is no other confguration. (Currently everywhere)
`allowMention`	boolean	<optional>	false	Whether or not the bot can respond to messages starting with a mention of the bot.
`ignoreBots`	boolean	<optional>	true	Whether or not the bot ignoresBots. Default: true
`ignoreSelf`	boolean	<optional>	true	Whether or not the bot ignores self. Default: true
`helpMessage`	string	<optional>	'Help'	Title for default command help Message
`helpMessageAfterCategories`	string	<optional>	'Note: Use \`${options.prefix}help <category>\` to see the commands'	Message after categories in default command help message are shown
`helpDM`	boolean	<optional>	true	Active direct message to default command help
`helpEnable`	boolean	<optional>	true	Enable/disable default command help
`devLogs`	boolean	<optional>	false	Enable/disable aghanim dev logs

Source:

Client.js, line 52

Extends

Eris.Client

Members

app

Properties:

Name Type Description

object The OAuth application information returned by Discord. Present some time after the ready event.

description string Discord App description

name string Discord App name

owner

string

Discord App owner

Properties

Name	Type	Description
`id`	string	Owner ID
`username`	string	Owner username
`discriminator`	string	Owner discriminator
`avatar`	string	Owner avatar

bot_public boolean If app is public

bot_require_code_grant boolean -

id string Discord App id

icon string Discord App icon

Source:

Client.js, line 116

Type	Description
Array.<Category>	Categories for commands.

commands

Properties:

Type	Description
Array.<Command>	An array of commands the bot will respond to.

Source:

Client.js, line 67

components

Properties:

Type	Description
Object.<Component>	Components.

Source:

Client.js, line 71

ignoreBots

Properties:

Type	Description
boolean	Whether or not the bot ignores messages sent from bot accounts. Defaults to true.

Default Value:

true

Source:

Client.js, line 86

ignoreSelf

Properties:

Type	Description
boolean	Ignore self

Default Value:

true

Source:

Client.js, line 89

mentionPrefixRegExp

Properties:

Type	Description
RegExp	The RegExp used to tell whether or not a message starts with a mention of the bot. Only present after the 'ready' event.

Source:

Client.js, line 98

owner

Owner description

Properties:

Name	Type	Description
`id`	string	Owner ID
`username`	string	Owner username
`discriminator`	string	Owner discriminator
`avatar`	string	Owner avatar
`send`	Ownersend	Send a message to Owner

Source:

Client.js, line 125

prefix

Properties:

Type	Description
string	The prefix the bot will respond to in guilds for which there is no other confguration.

Source:

Client.js, line 65

setup

Properties:

Type	Description
Object	Setup

Source:

Client.js, line 73

Methods

addCategory(name, help, options)

Add a Command Category

Parameters:

Name Type Description

name string Name for Category

help string Help Message

options

object

Options

Properties

Name	Type	Description
`hide`	object	Options
`restrict`	object	Options

Source:

Client.js, line 426

addCommand(command) → {Command}

Parameters:

Name	Type	Description
`command`	Command \| object	The command to add to the bot.

Source:

Client.js, line 351

Returns:

- Command added

Type: Command

addCommandDir(dirname)

Load all the JS files in a directory and attempt to load them each as commands.

Parameters:

Name	Type	Description
`dirname`	string	The location of the directory.

Source:

Client.js, line 396

addCommandFile(filename) → {Command}

Load a command exported from a file.

Parameters:

Name	Type	Description
`filename`	string	The location of the file.

Source:

Client.js, line 405

Returns:

- Command added.

Type: Command

addCommandRequirement(requirement)

Define a requirement that can be added by commands

Parameters:

Name	Type	Description
`requirement`	CommandRequirementObject \| CommandRequirementFunction	Requirement to define

Source:

Client.js, line 503

addCommandRequirementDir(dirname)

Add command requirements from a directory

Parameters:

Name	Type	Description
`dirname`	string	Path to load command requirements

Source:

Client.js, line 538

addCommandRequirementFile(filename) → {CommandRequirement}

Add command requirement from file

Parameters:

Name	Type	Description
`filename`	string	Path to file

Source:

Client.js, line 520

Returns:

CommandRequirement added

Type: CommandRequirement

addComponent(component) → {Component}

Add a Component

Parameters:

Name	Type	Description
`component`	Component \| object	Component Component

Source:

Client.js, line 441

Returns:

- Component added

Type: Component

addComponentDir(dirname)

Add components from a directory

Parameters:

Name	Type	Description
`dirname`	string	Path to load components

Source:

Client.js, line 495

addComponentFile(filename) → {Component}

Add component from file

Parameters:

Name	Type	Description
`filename`	string	Path to file

Source:

Client.js, line 478

Returns:

Component added

Type: Component

createCommandArgs(msg) → {parseCommand}

Create args object and find command. Returns both.

Parameters:

Name	Type	Description
`msg`	Eris.message	Eris Message object

Source:

Client.js, line 693

Returns:

Type: parseCommand

extendCommandArgs(args, msg, client)

Extend default args object.

Parameters:

Name	Type	Description
`args`	args	Args object.
`msg`	msg	Eris Message.
`client`	Client	Client instance.

Source:

Client.js, line 337

getCommandByName(command, subcommand) → {Command|undefined}

Checks the list of registered commands and returns one whch is known by a given name, either as the command's name or an alias of the command.

Parameters:

Name	Type	Description
`command`	string	The name of the command to look for.
`subcommand`	string	The name of the subcommand to look for.

Source:

Client.js, line 602

Returns:

Type: Command | undefined

getCommandsOfCategories(categories) → {Array.<Command>|undefined}

Get Commands from a Category

Parameters:

Name	Type	Description
`categories`	string \| Array.<string>	Category or list of these to search commands

Source:

Client.js, line 649

Returns:

- Array of Command (include childs commands aka subcommands)

Type: Array.<Command> | undefined

(async) handleMessage(msg) → {*}

Given a message, see if there is a command and process it if so.

Parameters:

Name	Type	Description
`msg`	Object	The message object recieved from Eris.

Source:

Client.js, line 200

Returns:

- Returns

Type: *

reloadCommands()

Reloads all commands that were loaded via `addCommandFile` and `addCommandDir`. Useful for development to hot-reload commands as you work on them.

Source:

Client.js, line 547

reloadComponents()

Reloads all components that were loaded via `addComponentFile` and `addCommponentDir`. Useful for development to hot-reload commands as you work on them.

Source:

Client.js, line 567

triggerMessageCreate(msg, client) → {boolean}

If returns true, allow default commands management and messageCreate Components functions.

Parameters:

Name	Type	Description
`msg`	Eris.message	Eris Message object
`client`	Client	Client instance

Source:

Client.js, line 664

Returns:

- true = allow, false = omit

Type: boolean

Events

aghanim:command:error

Fired when a command got an error executing the run function

Parameters:

Name	Type	Description
`err`	object	Error
`msg`	object	Eris Message object
`args`	args	Args object
`client`	Client	Client instance
`command`	Command	Command

Source:

Client.js, line 287

aghanim:command:executed

Fired after a command is executed. Don't cant stop command of running

Parameters:

Name	Type	Description
`msg`	object	Eris Message object
`args`	args	Args object
`client`	Client	Client instance
`command`	Command	Command

Source:

Client.js, line 276

aghanim:command:prereq

Fired before a command is executed. Can't stop command of running

Parameters:

Name	Type	Description
`msg`	object	Eris Message object
`args`	args	Args object
`client`	Client	Client instance
`command`	Command	Command

Source:

Client.js, line 217

aghanim:command:prerun

Fired before a command is executed. Can't stop command of running

Parameters:

Name	Type	Description
`msg`	object	Eris Message object
`args`	args	Args object
`client`	Client	Client instance
`command`	Command	Command

Source:

Client.js, line 229

aghanim:component:error

Fired when a component get an error to be executed

Parameters:

Name	Type	Description
`err`	object	Error
`eventname`	string	Name of Eris event
`client`	Client	Client instance
`component`	Component	Component

Source:

Client.js, line 317

aghanim:error

Fired when there are an error

Parameters:

Name	Type	Description
`err`	object	Error
`client`	Client	Client instance

Source:

Client.js, line 142