Skip to content

Commit cfdda91

Browse files
KhaazKhaaz
committed
Docs build for branch master: e8bacef 
1 parent e8bacef commit cfdda91

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+432
-432
lines changed

‎docs/AxonClient.md‎

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,25 @@
99
| Name | Type | Description |
1010
| --- | --- | --- |
1111
| _botClient | <code>BotClient</code> | Discord library Client |
12-
| moduleRegistry | <code>ModuleRegistry</code> | Registry holding all modules |
13-
| commandRegistry | <code>CommandRegistry</code> | Registry holding all commands |
14-
| listenerRegistry | <code>ListenerRegistry</code> | Registry holding all listeners |
15-
| eventManager | <code>EventManager</code> | The EventManager instance that handle all AxonCore listeners |
16-
| guildConfigs | <code>GuildConfigCache</code> | The Manager that handles GuildConfigs (cache / DB etc) |
17-
| [axonConfig] | <code>AxonConfig</code> | The AxonConfig object that handles globally blacklisted users and guilds |
18-
| dispatcher | <code>CommandDispatcher</code> | Dispatch commands onMessageCreate. |
19-
| executor | <code>Executor</code> | Executor class that handles executing commands and listeners |
20-
| moduleLoader | <code>ModuleLoader</code> | Load, unload modules. |
21-
| _messageManager | <code>MessageManager</code> | Message manager object accessible with `<AxonClient>.l` |
12+
| moduleRegistry | <code>[ModuleRegistry](Modules/ModuleRegistry)</code> | Registry holding all modules |
13+
| commandRegistry | <code>[CommandRegistry](Commands/CommandRegistry)</code> | Registry holding all commands |
14+
| listenerRegistry | <code>[ListenerRegistry](Listeners/ListenerRegistry)</code> | Registry holding all listeners |
15+
| eventManager | <code>[EventManager](Listeners/EventManager)</code> | The EventManager instance that handle all AxonCore listeners |
16+
| guildConfigs | <code>[GuildConfigCache](Core/GuildConfigCache)</code> | The Manager that handles GuildConfigs (cache / DB etc) |
17+
| [axonConfig] | <code>[AxonConfig](Core/AxonConfig)</code> | The AxonConfig object that handles globally blacklisted users and guilds |
18+
| dispatcher | <code>[CommandDispatcher](Commands/CommandDispatcher)</code> | Dispatch commands onMessageCreate. |
19+
| executor | <code>[Executor](Core/Executor)</code> | Executor class that handles executing commands and listeners |
20+
| moduleLoader | <code>[ModuleLoader](Modules/ModuleLoader)</code> | Load, unload modules. |
21+
| _messageManager | <code>[MessageManager](Translation/MessageManager)</code> | Message manager object accessible with `<AxonClient>.l` |
2222
| library | <code>LibraryInterface</code> | LibraryInterface object depending the lib used |
23-
| logger | <code>ALogger</code> | The Logger instance |
24-
| axonUtils | <code>AxonUtils</code> | Util methods (AxonCore) |
25-
| utils | <code>Utils</code> | Utils methods (general) |
26-
| DBProvider | <code>ADBProvider</code> | The DBProvider instance |
23+
| logger | <code>[ALogger](Loggers/ALogger)</code> | The Logger instance |
24+
| axonUtils | <code>[Axon[Utils](Utility/Utils)](Utility/Axon[Utils](Utility/Utils))</code> | Util methods (AxonCore) |
25+
| utils | <code>[Utils](Utility/Utils)</code> | Utils methods (general) |
26+
| DBProvider | <code>[ADBProvider](Database/ADBProvider)</code> | The DBProvider instance |
2727
| _configs | <code>Object</code> | configs (webhooks, template, custom) |
2828
| _configs.webhooks | <code>Object.&lt;string, {id: String, token: String}&gt;</code> | Webhooks configs with all webhooks id and tokens |
2929
| _configs.template | <code>Object</code> | Template config |
30-
| _configs.custom | <code>AxonOptions</code> | Custom config object optionally passed via AxonOptions |
30+
| _configs.custom | <code>[AxonOptions](Core/AxonOptions)</code> | Custom config object optionally passed via AxonOptions |
3131
| staff | <code>Object</code> | Bot Staff (owners, admins, +...) |
3232
| staff.owners | <code>Array.&lt;String&gt;</code> | Array of user IDs with BotOwner permissions |
3333
| staff.admins | <code>Array.&lt;String&gt;</code> | Array of user IDs with BotAdmin permissions |
@@ -62,9 +62,9 @@
6262
* [.webhooks](#AxonClient+webhooks) : <code>Object</code>
6363
* [.template](#AxonClient+template) : <code>Object</code>
6464
* [.custom](#AxonClient+custom) : <code>Object.&lt;string, any&gt;</code>
65-
* [.getListeners(eventName)](#AxonClient+getListeners) ⇒ <code>Array.&lt;Listener&gt;</code>
66-
* [.getModule(module)](#AxonClient+getModule) ⇒ <code>Module</code> \| <code>null</code>
67-
* [.getCommand(fullLabel)](#AxonClient+getCommand) ⇒ <code>Command</code> \| <code>null</code>
65+
* [.getListeners(eventName)](#AxonClient+getListeners) ⇒ <code>Array.&lt;[Listener](Listeners/Listener)&gt;</code>
66+
* [.getModule(module)](#AxonClient+getModule) ⇒ <code>[Module](Modules/Module)</code> \| <code>null</code>
67+
* [.getCommand(fullLabel)](#AxonClient+getCommand) ⇒ <code>[Command](Commands/Command)</code> \| <code>null</code>
6868
* [.start()](#AxonClient+start)
6969
* [.onInit()](#AxonClient+onInit) ⇒ <code>Boolean</code>
7070
* [.onStart()](#AxonClient+onStart) ⇒ <code>Promise.&lt;Boolean&gt;</code>
@@ -76,7 +76,7 @@
7676
* [.initErrorListeners()](#AxonClient+initErrorListeners)
7777
* [.initStatus()](#AxonClient+initStatus)
7878
* [.sendFullHelp(msg, guildConfig)](#AxonClient+sendFullHelp)
79-
* [.registerGuildPrefixes(gID, prefixArr)](#AxonClient+registerGuildPrefixes) ⇒ <code>Promise.&lt;GuildConfig&gt;</code>
79+
* [.registerGuildPrefixes(gID, prefixArr)](#AxonClient+registerGuildPrefixes) ⇒ <code>Promise.&lt;[GuildConfig](Core/GuildConfig)&gt;</code>
8080
* [.toString()](#AxonClient+toString) ⇒ <code>String</code>
8181
* [.toJSON()](#AxonClient+toJSON) ⇒ <code>Object</code>
8282
* ["debug"](#AxonClient+event_debug)
@@ -157,7 +157,7 @@ Returns the custom config
157157
**Read only**: true
158158
<a name="AxonClient+getListeners"></a>
159159

160-
### axonClient.getListeners(eventName) ⇒ <code>Array.&lt;Listener&gt;</code>
160+
### axonClient.getListeners(eventName) ⇒ <code>Array.&lt;[Listener](Listeners/Listener)&gt;</code>
161161
Returns all registered listeners for the discord event name
162162

163163
**Kind**: instance method of [<code>AxonClient</code>](#AxonClient)
@@ -168,7 +168,7 @@ Returns all registered listeners for the discord event name
168168

169169
<a name="AxonClient+getModule"></a>
170170

171-
### axonClient.getModule(module) ⇒ <code>Module</code> \| <code>null</code>
171+
### axonClient.getModule(module) ⇒ <code>[Module](Modules/Module)</code> \| <code>null</code>
172172
Get a module from AxonClient with the given label.
173173

174174
**Kind**: instance method of [<code>AxonClient</code>](#AxonClient)
@@ -179,7 +179,7 @@ Get a module from AxonClient with the given label.
179179

180180
<a name="AxonClient+getCommand"></a>
181181

182-
### axonClient.getCommand(fullLabel) ⇒ <code>Command</code> \| <code>null</code>
182+
### axonClient.getCommand(fullLabel) ⇒ <code>[Command](Commands/Command)</code> \| <code>null</code>
183183
Get a command/subcommand from AxonClient with the given full label.
184184

185185
**Kind**: instance method of [<code>AxonClient</code>](#AxonClient)
@@ -291,16 +291,16 @@ This method can be overridden in child.
291291
| Param | Type | Description |
292292
| --- | --- | --- |
293293
| msg | <code>Message</code> | The message object |
294-
| guildConfig | <code>GuildConfig</code> | |
294+
| guildConfig | <code>[GuildConfig](Core/GuildConfig)</code> | |
295295

296296
<a name="AxonClient+registerGuildPrefixes"></a>
297297

298-
### axonClient.registerGuildPrefixes(gID, prefixArr) ⇒ <code>Promise.&lt;GuildConfig&gt;</code>
298+
### axonClient.registerGuildPrefixes(gID, prefixArr) ⇒ <code>Promise.&lt;[GuildConfig](Core/GuildConfig)&gt;</code>
299299
Register a guild prefix.
300300
Shortcut to guildConfig.registerPrefix()
301301

302302
**Kind**: instance method of [<code>AxonClient</code>](#AxonClient)
303-
**Returns**: <code>Promise.&lt;GuildConfig&gt;</code> - The guild Schema from the DB / Error if error
303+
**Returns**: <code>Promise.&lt;[GuildConfig](Core/GuildConfig)&gt;</code> - The guild Schema from the DB / Error if error
304304

305305
| Param | Type | Description |
306306
| --- | --- | --- |
@@ -348,9 +348,9 @@ Fired when a command is successfully ran
348348
| commandFullLabel | <code>String</code> | The command fullLabel |
349349
| data | <code>Object</code> | |
350350
| data.msg | <code>Message</code> | The message that triggered the command |
351-
| data.command | <code>Command</code> | The Command that was executed |
352-
| data.guildConfig | <code>GuildConfig</code> | The GuildConfig |
353-
| data.context | <code>CommandContext</code> | The execution context |
351+
| data.command | <code>[Command](Commands/Command)</code> | The Command that was executed |
352+
| data.guildConfig | <code>[GuildConfig](Core/GuildConfig)</code> | The GuildConfig |
353+
| data.context | <code>[CommandContext](Commands/CommandContext)</code> | The execution context |
354354

355355
<a name="AxonClient+event_commandError"></a>
356356

@@ -365,9 +365,9 @@ Fired when a command fails
365365
| commandFullLabel | <code>String</code> | The command fullLabel |
366366
| data | <code>Object</code> | |
367367
| data.msg | <code>Message</code> | The message that triggered the command |
368-
| data.command | <code>Command</code> | The Command that was executed |
369-
| data.guildConfig | <code>GuildConfig</code> | The GuildConfig |
370-
| data.error | <code>AxonCommandError</code> | The error |
368+
| data.command | <code>[Command](Commands/Command)</code> | The Command that was executed |
369+
| data.guildConfig | <code>[GuildConfig](Core/GuildConfig)</code> | The GuildConfig |
370+
| data.error | <code>[AxonCommandError](Errors/AxonCommandError)</code> | The error |
371371

372372
<a name="AxonClient+event_listenerExecution"></a>
373373

@@ -383,8 +383,8 @@ Fired when a listener is executed
383383
| eventName | <code>String</code> | The discord event name |
384384
| listenerName | <code>String</code> | The listener label |
385385
| data | <code>Object</code> | Additional information |
386-
| data.listener | <code>Listener</code> | The Listener that was executed |
387-
| data.guildConfig | <code>GuildConfig</code> | The GuildConfig object |
386+
| data.listener | <code>[Listener](Listeners/Listener)</code> | The Listener that was executed |
387+
| data.guildConfig | <code>[GuildConfig](Core/GuildConfig)</code> | The GuildConfig object |
388388

389389
<a name="AxonClient+event_listenerError"></a>
390390

@@ -399,8 +399,8 @@ Fired when a listener errors
399399
| eventName | <code>String</code> | The discord event name |
400400
| listenerName | <code>String</code> | The Listener label |
401401
| data | <code>Object</code> | Additional information |
402-
| data.listener | <code>Listener</code> | The Listener that was executed |
403-
| data.guildConfig | <code>GuildConfig</code> | The GuildConfig object |
402+
| data.listener | <code>[Listener](Listeners/Listener)</code> | The Listener that was executed |
403+
| data.guildConfig | <code>[GuildConfig](Core/GuildConfig)</code> | The GuildConfig object |
404404
| data.error | <code>Error</code> | The error |
405405

406406
<a name="AxonClient.AxonClient"></a>
@@ -416,6 +416,6 @@ Creates an AxonClient instance.
416416
| Param | Type | Default | Description |
417417
| --- | --- | --- | --- |
418418
| botClient | <code>BotClient</code> | | Eris or Discordjs Client instance |
419-
| [axonOptions] | <code>AxonOptions</code> | <code>{}</code> | Axon options |
420-
| [modules] | <code>Object.&lt;string, Module&gt;</code> | <code>{}</code> | Object with all modules to add in the bot |
419+
| [axonOptions] | <code>[AxonOptions](Core/AxonOptions)</code> | <code>{}</code> | Axon options |
420+
| [modules] | <code>Object.&lt;string, [Module](Modules/Module)&gt;</code> | <code>{}</code> | Object with all modules to add in the bot |
421421

‎docs/Commands/Command.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -22,23 +22,23 @@
2222

2323
| Name | Type | Default | Description |
2424
| --- | --- | --- | --- |
25-
| _module | <code>Module</code> | | Module object |
25+
| _module | <code>[Module](Modules/Module)</code> | | Module object |
2626
| _cooldown | <code>CommandCooldown</code> | | Cooldown Object for the command (manage all command cooldowns) |
2727
| label | <code>String</code> | | Command label (name/id) |
2828
| [aliases] | <code>Array.&lt;String&gt;</code> | <code>[]</code> | Array of commands aliases (including the command label) |
2929
| [enabled] | <code>Boolean</code> | <code>module.enabled</code> | Whether the command is enabled |
3030
| [serverBypass] | <code>Boolean</code> | <code>module.serverBypass</code> | Whether the command can be disabled |
31-
| [parentCommand] | [<code>Command</code>](#Command) | <code></code> | Reference to the parent command |
31+
| [parentCommand] | <code>[Command](Commands/Command)</code> | <code></code> | Reference to the parent command |
3232
| [hasSubcmd] | <code>Boolean</code> | <code>false</code> | Whether the command HAS subcommands |
33-
| [subCommands] | <code>CommandRegistry</code> | <code></code> | Registry of subcommands |
33+
| [subCommands] | <code>[CommandRegistry](Commands/CommandRegistry)</code> | <code></code> | Registry of subcommands |
3434
| info | <code>Object</code> | | Default info about the command |
3535
| [info.owners] | <code>Array.&lt;String&gt;</code> | | Command authors |
3636
| [info.name] | <code>String</code> | | Full command name |
3737
| [info.description] | <code>String</code> | | Command description |
3838
| [info.usage] | <code>String</code> | | Command usage |
3939
| [info.example] | <code>Array.&lt;String&gt;</code> | | Array of command examples |
40-
| options | <code>CommandOptions</code> | | Options Object for the command (manage all command options) |
41-
| permissions | <code>CommandPermissions</code> | | Permissions Object for the command (manage all command permissions) |
40+
| options | <code>[CommandOptions](Commands/CommandOptions)</code> | | Options Object for the command (manage all command options) |
41+
| permissions | <code>[CommandPermissions](Commands/CommandPermissions)</code> | | Permissions Object for the command (manage all command permissions) |
4242

4343

4444
* [Command](#Command) ⇐ <code>Base</code>
@@ -50,10 +50,10 @@
5050
* [.fullLabel](#Command+fullLabel) : <code>String</code>
5151
* [.init()](#Command+init) ⇒
5252
* [._init()](#Command+_init) ⇒ <code>Boolean</code>
53-
* [._process(env)](#Command+_process) ⇒ <code>Promise.&lt;CommandContext&gt;</code>
54-
* [._execute(env)](#Command+_execute) ⇒ <code>Promise.&lt;CommandContext&gt;</code>
55-
* [.execute(env)](#Command+execute) ⇒ <code>Promise.&lt;CommandResponse&gt;</code>
56-
* [.sendHelp(env)](#Command+sendHelp) ⇒ <code>Promise.&lt;CommandContext&gt;</code>
53+
* [._process(env)](#Command+_process) ⇒ <code>Promise.&lt;[CommandContext](Commands/CommandContext)&gt;</code>
54+
* [._execute(env)](#Command+_execute) ⇒ <code>Promise.&lt;[CommandContext](Commands/CommandContext)&gt;</code>
55+
* [.execute(env)](#Command+execute) ⇒ <code>Promise.&lt;[CommandResponse](Commands/CommandResponse)&gt;</code>
56+
* [.sendHelp(env)](#Command+sendHelp) ⇒ <code>Promise.&lt;[CommandContext](Commands/CommandContext)&gt;</code>
5757
* [.sendBotPerms(channel, [permissions])](#Command+sendBotPerms)
5858
* [.sendUserPerms(channel, member, [deleteTimeout], [missingPermission])](#Command+sendUserPerms)
5959
* [.sendTargetPerms(channel)](#Command+sendTargetPerms)
@@ -107,19 +107,19 @@ Returns all the subcommands for a command
107107
**Kind**: instance method of [<code>Command</code>](#Command)
108108
<a name="Command+_process"></a>
109109

110-
### command.\_process(env) ⇒ <code>Promise.&lt;CommandContext&gt;</code>
110+
### command.\_process(env) ⇒ <code>Promise.&lt;[CommandContext](Commands/CommandContext)&gt;</code>
111111
Process the command, and executes it if it can (permissions, options etc..).
112112

113113
**Kind**: instance method of [<code>Command</code>](#Command)
114-
**Returns**: <code>Promise.&lt;CommandContext&gt;</code> - Return a CommandContext or throw an AxonCommandError.
114+
**Returns**: <code>Promise.&lt;[CommandContext](Commands/CommandContext)&gt;</code> - Return a CommandContext or throw an AxonCommandError.
115115

116116
| Param | Type |
117117
| --- | --- |
118-
| env | <code>CommandEnvironment</code> |
118+
| env | <code>[CommandEnvironment](Commands/CommandEnvironment)</code> |
119119

120120
<a name="Command+_execute"></a>
121121

122-
### command.\_execute(env) ⇒ <code>Promise.&lt;CommandContext&gt;</code>
122+
### command.\_execute(env) ⇒ <code>Promise.&lt;[CommandContext](Commands/CommandContext)&gt;</code>
123123
Execute the command.
124124
Get the CommandResponse from the command execution or create it in case of errors.
125125
Create the CommandContext and returns it.
@@ -128,32 +128,32 @@ Create the CommandContext and returns it.
128128

129129
| Param | Type |
130130
| --- | --- |
131-
| env | <code>CommandEnvironment</code> |
131+
| env | <code>[CommandEnvironment](Commands/CommandEnvironment)</code> |
132132

133133
<a name="Command+execute"></a>
134134

135-
### command.execute(env) ⇒ <code>Promise.&lt;CommandResponse&gt;</code>
135+
### command.execute(env) ⇒ <code>Promise.&lt;[CommandResponse](Commands/CommandResponse)&gt;</code>
136136
Override this method in all Command child.
137137
Main method - command logic being executed when the command is actually ran.
138138

139139
**Kind**: instance method of [<code>Command</code>](#Command)
140-
**Returns**: <code>Promise.&lt;CommandResponse&gt;</code> - Returns a CommandResponse that will be used to create the CommandContext
140+
**Returns**: <code>Promise.&lt;[CommandResponse](Commands/CommandResponse)&gt;</code> - Returns a CommandResponse that will be used to create the CommandContext
141141

142142
| Param | Type | Description |
143143
| --- | --- | --- |
144-
| env | <code>CommandEnvironment</code> | The Command Environment object with all variables needed for the Commandexecution |
144+
| env | <code>[CommandEnvironment](Commands/CommandEnvironment)</code> | The Command Environment object with all variables needed for the Commandexecution |
145145

146146
<a name="Command+sendHelp"></a>
147147

148-
### command.sendHelp(env) ⇒ <code>Promise.&lt;CommandContext&gt;</code>
148+
### command.sendHelp(env) ⇒ <code>Promise.&lt;[CommandContext](Commands/CommandContext)&gt;</code>
149149
Send help message in the current channel with perm checks done before.
150150
Call a custom sendHelp method if it exists, use the default one if it doesn't.
151151

152152
**Kind**: instance method of [<code>Command</code>](#Command)
153153

154154
| Param | Type |
155155
| --- | --- |
156-
| env | <code>CommandEnvironment</code> |
156+
| env | <code>[CommandEnvironment](Commands/CommandEnvironment)</code> |
157157

158158
<a name="Command+sendBotPerms"></a>
159159

@@ -220,7 +220,7 @@ Overrides the execute method. Execute method will be called every time the comma
220220

221221
| Param | Type | Default | Description |
222222
| --- | --- | --- | --- |
223-
| module | <code>Module</code> | | |
223+
| module | <code>[Module](Modules/Module)</code> | | |
224224
| [data] | <code>Object</code> | <code>{}</code> | All command parameters |
225225
| [data.label] | <code>String</code> | | The command label |
226226
| [data.aliases] | <code>Array.&lt;String&gt;</code> | | The command aliases |
@@ -233,8 +233,8 @@ Overrides the execute method. Execute method will be called every time the comma
233233
| [data.info.examples] | <code>Array.&lt;String&gt;</code> | | Command examples |
234234
| [data.info.usage] | <code>String</code> | | The command usage |
235235
| [data.info.name] | <code>String</code> | | The full command name |
236-
| [data.options] | <code>CommandOptions</code> \| <code>Object</code> | | The command options |
237-
| [data.permissions] | <code>CommandPermissions</code> \| <code>Object</code> | | The command permissions |
236+
| [data.options] | <code>[CommandOptions](Commands/CommandOptions)</code> \| <code>Object</code> | | The command options |
237+
| [data.permissions] | <code>[CommandPermissions](Commands/CommandPermissions)</code> \| <code>Object</code> | | The command permissions |
238238

239239
<a name="AxonTemplate"></a>
240240

0 commit comments

Comments
 (0)