docs(AxonClient): extensions

Khaaz · Jul 29, 2020 · e133684 · e133684
1 parent d93d4ee
commit e133684
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/src/AxonClient.js b/src/AxonClient.js
@@ -48,6 +48,9 @@ import { WEBHOOK_TYPES, LOG_LEVELS, WEBHOOK_TO_COLOR, DEBUG_FLAGS } from './Util
  * @typedef {import('./Core/Command/CommandEnvironment').default} CommandEnvironment
  * @typedef {import(./Libraries/definitions/LibraryInterface).default} LibraryInterface
  * @typedef {import('./Core/Models/AxonConfig').default} AxonConfig
+ * @typedef {{
+ * Utils: Utils, DBProvider: ADBProvider, AxonConfig: AxonConfig, GuildConfig: GuildConfig, DBLocation: String
+ * }} Extensions
  */
 
 /**
@@ -74,6 +77,7 @@ import { WEBHOOK_TYPES, LOG_LEVELS, WEBHOOK_TO_COLOR, DEBUG_FLAGS } from './Util
  * @prop {AxonUtils} axonUtils - Util methods (AxonCore)
  * @prop {Utils} utils - Utils methods (general)
  * @prop {ADBProvider} DBProvider - The DBProvider instance
+ * @prop {Extensions} extensions - AxonCore extensions
  * @prop {Object} _configs - configs (webhooks, template, custom)
  * @prop {Object.<string, {id: String, token: String}>} _configs.webhooks - Webhooks configs with all webhooks id and tokens
  * @prop {{ embeds: Object.<string, Number>, emotes: Object.<string, String> }} _configs.template - Template config

diff --git a/src/Core/Loaders/ClientInitialiser.js b/src/Core/Loaders/ClientInitialiser.js
@@ -5,6 +5,9 @@
  * @typedef {import('../../Database/ADBProvider').default} ADBProvider
  * @typedef {import('../Models/GuildConfig').default} GuildConfig
  * @typedef {import('../Models/AxonConfig').default} AxonConfig
+ * @typedef {{
+ * Utils: Utils, DBProvider: ADBProvider, AxonConfig: AxonConfig, GuildConfig: GuildConfig, DBLocation: String
+ * }} Extensions
  */
 
 import Utils from '../../Utility/Utils';
@@ -75,6 +78,7 @@ class ClientInitialiser {
      * Returns uninstantiated classes without logger. These values should then be instantiated
      * @param {AxonClient} axon - AxonClient
      * @param {AxonOptions} axonOptions - AxonOptions
+     * @returns {Extensions} extensions
      */
     static initExtensions(axon, axonOptions) {
         const extensions = {};