diff --git a/docs/AxonClient.md b/docs/AxonClient.md index 50f4cb9d..76834e21 100644 --- a/docs/AxonClient.md +++ b/docs/AxonClient.md @@ -1,3 +1,17 @@ +## Classes + +
+
AxonClientEventEmitter
+
+
+ +## Typedefs + +
+
Extensions : Object
+
+
+ ## AxonClient ⇐ EventEmitter @@ -24,6 +38,7 @@ | axonUtils | [Axon[Utils](Utility/Utils)](Utility/Axon[Utils](Utility/Utils)) | Util methods (AxonCore) | | utils | [Utils](Utility/Utils) | Utils methods (general) | | DBProvider | [ADBProvider](Database/ADBProvider) | The DBProvider instance | +| extensions | [Extensions](#Extensions) | AxonCore extensions | | _configs | Object | configs (webhooks, template, custom) | | _configs.webhooks | Object.<string, {id: String, token: String}> | Webhooks configs with all webhooks id and tokens | | _configs.template | Object | Template config | @@ -419,3 +434,7 @@ Creates an AxonClient instance. | [axonOptions] | [AxonOptions](Core/AxonOptions) | {} | Axon options | | [modules] | Object.<string, [Module](Modules/Module)> | {} | Object with all modules to add in the bot | + + +## Extensions : Object +**Kind**: global typedef diff --git a/docs/Commands/Command.md b/docs/Commands/Command.md index 487fb2ad..b4359377 100644 --- a/docs/Commands/Command.md +++ b/docs/Commands/Command.md @@ -45,8 +45,6 @@ * [new Command()](#new_Command_new) * _instance_ * [.module](#Command+module) : Module - * [.template](#Command+template) : [AxonTemplate](#AxonTemplate) - * [.library](#Command+library) : LibraryInterface * [.fullLabel](#Command+fullLabel) : String * [.init()](#Command+init) ⇒ * [._init()](#Command+_init) ⇒ Boolean @@ -72,20 +70,6 @@ AxonCore - Command constructor ### command.module : Module Returns the parent module instance -**Kind**: instance property of [Command](#Command) -**Read only**: true - - -### command.template : [AxonTemplate](#AxonTemplate) -Returns the template object - -**Kind**: instance property of [Command](#Command) -**Read only**: true - - -### command.library : LibraryInterface -Returns the library Interface instance - **Kind**: instance property of [Command](#Command) **Read only**: true diff --git a/docs/Commands/CommandEnvironment.md b/docs/Commands/CommandEnvironment.md index 7b493ca3..e9705c1f 100644 --- a/docs/Commands/CommandEnvironment.md +++ b/docs/Commands/CommandEnvironment.md @@ -13,6 +13,7 @@ | guildConfig | [GuildConfig](Core/GuildConfig) | The GuildConfig data-structure with all DB saved settings | | prefix | String | The prefix used for this command | | command | String | The full label of the command being executed | +| usedCommandLabel | String | The used label of the command being executed | | executionType | COMMAND\_EXECUTION\_TYPES | Execution type: admin, owner, regular | @@ -23,7 +24,7 @@ * [.isOwner](#CommandEnvironment+isOwner) : Boolean * [.setPrefix(prefix)](#CommandEnvironment+setPrefix) ⇒ [CommandEnvironment](Commands/CommandEnvironment) * [.setGuildConfig(guildConfig)](#CommandEnvironment+setGuildConfig) ⇒ [CommandEnvironment](Commands/CommandEnvironment) - * [.setCommand(command)](#CommandEnvironment+setCommand) ⇒ [CommandEnvironment](Commands/CommandEnvironment) + * [.setCommand(command, usedLabel)](#CommandEnvironment+setCommand) ⇒ [CommandEnvironment](Commands/CommandEnvironment) * [.resolveArgs(parser, args)](#CommandEnvironment+resolveArgs) * _static_ * [.CommandEnvironment](#CommandEnvironment.CommandEnvironment) @@ -74,7 +75,7 @@ Set the guildConfig -### commandEnvironment.setCommand(command) ⇒ [CommandEnvironment](Commands/CommandEnvironment) +### commandEnvironment.setCommand(command, usedLabel) ⇒ [CommandEnvironment](Commands/CommandEnvironment) Set the command label from the command object **Kind**: instance method of [CommandEnvironment](#CommandEnvironment) @@ -83,6 +84,7 @@ Set the command label from the command object | Param | Type | | --- | --- | | command | [Command](Commands/Command) | +| usedLabel | String | diff --git a/docs/Utility/Utils.md b/docs/Utility/Utils.md index fe062df8..7fd25b55 100644 --- a/docs/Utility/Utils.md +++ b/docs/Utility/Utils.md @@ -35,7 +35,7 @@ * [.axon](#Utils+axon) : AxonClient * [.bot](#Utils+bot) : BotClient * [.library](#Utils+library) : LibraryInterface - * [.splitMessage(content)](#Utils+splitMessage) ⇒ Array.<String> \| String + * [.splitMessage(content, [length])](#Utils+splitMessage) ⇒ Array.<String> * [.getPrefix(msg)](#Utils+getPrefix) ⇒ Promise.<String> * [.getRoles(guild, member)](#Utils+getRoles) ⇒ Array.<Role> * [.getHighestRole(guild, member)](#Utils+getHighestRole) ⇒ Role @@ -89,16 +89,17 @@ Returns the LibraryInterface instance **Read only**: true -### utils.splitMessage(content) ⇒ Array.<String> \| String +### utils.splitMessage(content, [length]) ⇒ Array.<String> Split the given content (String), according to correct linebreaks. -Split at 1900 characters. +Split at default 1900 characters. **Kind**: instance method of [Utils](#Utils) -**Returns**: Array.<String> \| String - The array of content string splitted or the original String +**Returns**: Array.<String> - The array of content string splitted | Param | Type | | --- | --- | | content | String | +| [length] | Number |