bajo 2.21.1 → 2.22.0

package/class/bajo.js

@@ -8,9 +8,7 @@ import lodash from 'lodash'
 import { createRequire } from 'module'
 import fastGlob from 'fast-glob'
 import querystring from 'querystring'
-import importModule from '../lib/import-module.js'
-import logLevels from '../lib/log-levels.js'
-import { types as formatTypes, formats } from '../lib/formats.js'
+import { logLevels } from './log.js'
 import * as yaml from 'js-yaml'
 import aneka from 'aneka'
 import {
@@ -20,8 +18,11 @@ import {
   collectConfigHandlers,
   bootOrder,
   bootPlugins,
-  exitHandler
-} from './_helper.js'
+  exitHandler,
+  importModule,
+  types as formatTypes,
+  formats
+} from '../lib/helper.js'
 
 const require = createRequire(import.meta.url)
 
@@ -35,9 +36,10 @@ const {
 const { resolvePath, getGlobalModuleDir } = aneka
 
 /**
- * Name based ```{ns}:{path}``` format.
+ * Name based `{ns}:{path}` format.
  *
  * @typedef {string} TNsPathPairs
+ * @memberof Bajo
  * @see TNsPathResult
  * @see Bajo#buildNsPath
  * @see Bajo#breakNsPath
@@ -46,12 +48,28 @@ const { resolvePath, getGlobalModuleDir } = aneka
 /**
  * Object returned by {@link Bajo#getUnitFormat|bajo:getUnitFormat}.
  *
- * @typedef {Object} TBajoFormatResult
+ * @typedef {Object} TFormatResult
+ * @memberof Bajo
  * @property {string} unitSys - Unit system.
  * @property {Object} format - Format object.
  * @see Bajo#getUnitFormat
  */
 
+/**
+ * Object returned by {@link Bajo#breakNsPath|bajo:breakNsPath}.
+ *
+ * @typedef {Object} TNsPathResult
+ * @memberof Bajo
+ * @property {string} ns - Namespace
+ * @property {string} [subNs] - Sub namespace
+ * @property {string} [subSubNs] - Sub of sub namespace
+ * @property {string} path - Path without query string or hash
+ * @property {string} fullPath - Full path, including query string and hash
+ * @see TNsPathPairs
+ * @see Bajo#buildNsPath
+ * @see Bajo#breakNsPath
+ */
+
 /**
  * The Core. The main engine. The one and only plugin that control app's boot process and
  * making sure all other plugins working nicely.
@@ -60,28 +78,38 @@ const { resolvePath, getGlobalModuleDir } = aneka
  */
 class Bajo extends Plugin {
   /**
+   * Constructor.
+   *
    * @param {App} app - App instance. Usefull to call app method inside a plugin.
    */
   constructor (app) {
     super('bajo', app)
+
+    /**
+     * Alias
+     * @type {string}
+     */
     this.alias = 'bajo'
+
+    /**
+     * White space characters
+     * @type {string[]}
+     */
     this.whiteSpace = [' ', '\t', '\n', '\r']
+
     /**
      * Config object.
      *
-     * @type {Object}
+     * @type {Bajo.TObject}
      * @see {@tutorial config}
      */
     this.config = {}
 
-    // by defaualt, only these config formats below are supported.
-    app.configHandlers = [
-      { ns: 'bajo', ext: '.js', readHandler: this.fromJs },
-      { ns: 'bajo', ext: '.json', readHandler: this.fromJson, writeHandler: this.toJson },
-      { ns: 'bajo', ext: '.yaml', readHandler: this.fromYaml, writeHandler: this.toYaml },
-      { ns: 'bajo', ext: '.yml', readHandler: this.fromYml, writeHandler: this.toYml }
-    ]
-
+    /**
+     * Hooks container.
+     *
+     * @type {Array<Bajo.THook>}
+     */
     this.hooks = []
   }
 
@@ -112,7 +140,20 @@ class Bajo extends Plugin {
     }
   }
 
-  breakNsPathFromFile = ({ file = '', dir = '', ns, suffix = '', getType } = {}) => {
+  /**
+   * Break file path to its namespace & path infos.
+   *
+   * @method
+   * @param {Object} options - Options object
+   * @param {string} [options.file] - File path to break
+   * @param {string} [options.dir] - Base directory to remove from file path
+   * @param {string} [options.ns] - Namespace to use. If not provided, will be extracted from file path
+   * @param {string} [options.suffix] - Suffix to remove from file path
+   * @param {boolean} [options.getType] - Whether to extract type from file path
+   * @returns {Object} Namespace and path information
+   */
+  breakNsPathFromFile = (options = {}) => {
+    const { file = '', dir = '', ns, suffix = '', getType } = options
     let item = file.replace(dir + suffix, '')
     let type
     if (getType) {
@@ -136,12 +177,12 @@ class Bajo extends Plugin {
    * Build ns/path pairs.
    *
    * @method
-   * @param {object} [options={}] - Options object.
-   * @param {string} [options.ns=''] - Namespace.
-   * @param {string} [options.subNs] - Sub namespace.
-   * @param {string} [options.subSubNs] - Sub sub namespace.
-   * @param {string} [options.path] - Path.
-   * @returns {TNsPathPairs} Ns/path pairs.
+   * @param {object} [options={}] - Options object
+   * @param {string} [options.ns=''] - Namespace
+   * @param {string} [options.subNs] - Sub namespace
+   * @param {string} [options.subSubNs] - Sub sub namespace
+   * @param {string} [options.path] - Path
+   * @returns {TNsPathPairs} Ns/path pairs
    */
   buildNsPath = ({ ns = '', subNs, subSubNs, path } = {}) => {
     if (subNs) ns += '.' + subNs
@@ -150,25 +191,11 @@ class Bajo extends Plugin {
   }
 
   /**
-   * Object returned by {@link Bajo#breakNsPath|bajo:breakNsPath}.
-   *
-   * @typedef {Object} TNsPathResult
-   * @property {string} ns - Namespace.
-   * @property {string} [subNs] - Sub namespace.
-   * @property {string} [subSubNs] - Sub of sub namespace.
-   * @property {string} path - Path without query string or hash.
-   * @property {string} fullPath - Full path, including query string and hash.
-   * @see TNsPathPairs
-   * @see Bajo#buildNsPath
-   * @see Bajo#breakNsPath
-   */
-
-  /**
-   * Break name to its namespace & path infos.
+   * Break name to its namespace & path infos
    *
    * @method
    * @param {(TNsPathPairs|string)} name - Name to break
-   * @param {boolean} [checkNs=true] - If ```true``` (default), namespace will be checked for its validity
+   * @param {boolean} [checkNs=true] - If `true` (default), namespace will be checked for its validity
    * @returns {TNsPathResult}
    */
   breakNsPath = (name = '', checkNs = true) => {
@@ -222,11 +249,11 @@ class Bajo extends Plugin {
    * @method
    * @async
    * @param {Object} options - Options.
-   * @param {string} [options.ns] - Namespace. If not provided, defaults to ```bajo```
+   * @param {string} [options.ns] - Namespace. If not provided, defaults to `bajo`
    * @param {function} [options.handler] - Handler to call while building the collection item.
    * @param {string[]} [options.dupChecks=[]] - Array of keys to check for duplicates.
    * @param {string} options.container - Key used as container name.
-   * @param {boolean} [options.useDefaultName=true] - If true (default) and ```name``` key is not provided, returned collection will be named ```default```.
+   * @param {boolean} [options.useDefaultName=true] - If true (default) and `name` key is not provided, returned collection will be named `default`.
    * @fires bajo:beforeBuildCollection
    * @fires bajo:afterBuildCollection
    * @returns {Object[]} The collection
@@ -239,16 +266,6 @@ class Bajo extends Plugin {
     let items = get(cfg, container, [])
     if (!isArray(items)) items = [items]
     this.app[ns].log.trace('collecting%s', this.t(container))
-
-    /**
-     * Run before collection is built.
-     *
-     * @global
-     * @event bajo:beforeBuildCollection
-     * @param {string} container
-     * @see {@tutorial hook}
-     * @see Bajo#buildCollections
-     */
     await this.runHook(`${ns}:beforeBuildCollection`, container)
     const deleted = []
     for (const index in items) {
@@ -277,17 +294,6 @@ class Bajo extends Plugin {
     }
 
     if (!noDefault && !items.find(item => item.name === 'default')) this.app[ns].fatal('missing%s%s', 'default', container)
-
-    /**
-     * Run after collection is built
-     *
-     * @global
-     * @event bajo:afterBuildCollection
-     * @param {string} container
-     * @param {Object[]} items
-     * @see {@tutorial hook}
-     * @see Bajo#buildCollections
-     */
     await this.runHook(`${ns}:afterBuildCollection`, container, items)
     this.app[ns].log.debug('collected%s%d', this.t(container), items.length)
     return items
@@ -299,7 +305,7 @@ class Bajo extends Plugin {
    * - If name is a string, the corresponding plugin's method will be called with passed args as its parameters
    * - If name is a plugin instance, this will be used as the scope instead. The first args is now the handler name and the rest are its parameters
    * - If name is a function, this function will be run under scope with the remaining args
-   * - If name is an object and has ```handler``` key in it, this function handler will be instead
+   * - If name is an object and has `handler` key in it, this function handler will be instead
    *
    * @method
    * @async
@@ -339,15 +345,15 @@ class Bajo extends Plugin {
    * This function iterates through all loaded plugins and call the provided handler scoped as the running plugin.
    * And an object with the following key serves as its parameter:
    *
-   * - ```file```: file matched the glob pattern
-   * - ```dir```: plugin's base directory
+   * - `file`: file matched the glob pattern
+   * - `dir`: plugin's base directory
    *
    * @method
    * @async
    * @param {function} handler - Function handler. Can be an async function. Scoped to the running plugin.
    * @param {(string|Object)} [options={}] - Options. If a string is provided, it serves as the glob pattern, otherwise:
    * @param {(string|string[])} [options.glob] - Glob pattern. If provided,
-   * @param {boolean} [options.useBajo=false] - If true, add ```bajo``` to the running plugins too.
+   * @param {boolean} [options.useBajo=false] - If true, add `bajo` to the running plugins too.
    * @param {string} [options.prefix=''] - Prepend glob pattern with prefix.
    * @param {boolean} [options.noUnderscore=true] - If true (default), matched file with name starts with underscore is ignored.
    * @param {any} [options.returnItems] - If true, each value of returned handler call will be saved as an object with running plugin name as its keys.
@@ -403,7 +409,7 @@ class Bajo extends Plugin {
    * @method
    * @param {Object} [options={}] - Options.
    * @param {string} [options.lang] - Language to use. Defaults to the one you set in config.
-   * @param {string} [options.unitSys] - Unit system to use. Defaults to language's unit system or ```metric``` if unspecified.
+   * @param {string} [options.unitSys] - Unit system to use. Defaults to language's unit system or `metric` if unspecified.
    * @returns {TBajoFormatResult} Returned value.
    */
   getUnitFormat = (options = {}) => {
@@ -423,7 +429,7 @@ class Bajo extends Plugin {
    * @param {Object} [options={}] - Options.
    * @param {boolean} [options.withUnit=true] - Return with its unit appended.
    * @param {string} [options.lang] - Format value according to this language. Defaults to the one you set in config.
-   * @returns {(Array|string)} Return string if ```withUnit``` is true. Otherwise is an array of ```[value, unit, separator]```.
+   * @returns {(Array|string)} Return string if `withUnit` is true. Otherwise is an array of `[value, unit, separator]`.
    */
   formatByType = (type, value, dataType, options = {}) => {
     const { defaultsDeep } = this.app.lib.aneka
@@ -504,8 +510,8 @@ class Bajo extends Plugin {
    * Get class method by name.
    *
    * @method
-   * @param {string} name - Name in format ```ns:methodName```.
-   * @param {boolean} [thrown=true] - If ```true``` (default), throw exception in case of error.
+   * @param {string} name - Name in format `ns:methodName`.
+   * @param {boolean} [thrown=true] - If `true` (default), throw exception in case of error.
    * @returns {function} Class method.
    */
   getMethod = (name = '', thrown = true) => {
@@ -541,11 +547,11 @@ class Bajo extends Plugin {
   /**
    * Import file/module from any loaded plugins.
    *
-   * Method proxy from {@link module:Lib.importModule}
+   * Method proxy from {@link module:Helper.importModule}
    *
    * @method
    * @async
-   * @see module:Lib.importModule
+   * @see module:Helper.importModule
    */
   importModule = async (file, { asDefaultImport, asHandler, noCache } = {}) => {
     return await importModule.call(this, file, { asDefaultImport, asHandler, noCache })
@@ -555,27 +561,27 @@ class Bajo extends Plugin {
    * Import one or more packages belongs to a plugin.
    *
    * If the last arguments passed is an object, this object serves as options object:
-   * - ```returnDefault```: should return package's default export. Defaults to ```true```
-   * - ```throwNotFound```: should throw if package is not found. Defaults to ```false```
-   * - ```noCache```: always use fresh import. Defaults to ```false```
-   * - ```asObject```: see below. Defaults to ```false```
+   * - `returnDefault`: should return package's default export. Defaults to `true`
+   * - `throwNotFound`: should throw if package is not found. Defaults to `false`
+   * - `noCache`: always use fresh import. Defaults to `false`
+   * - `asObject`: see below. Defaults to `false`
    *
    * Return value:
-   * - if ```options.asObject``` is ```true``` (default ```false```), return as object with package's names as it's keys
+   * - if `options.asObject` is `true` (default `false`), return as object with package's names as it's keys
    * - Otherwise depends on how many parameters are provided, it should return the named package or an array of packages
    *
-   * Example: you want to import ```delay``` and ```chalk``` from ```bajo``` plugin because you want to use it in your code
-   * ```javascript
+   * Example: you want to import `delay` and `chalk` from `bajo` plugin because you want to use it in your code
+   * `javascript
    * const { importPkg } from this.app.bajo
    * const [delay, chalk] = await importPkg('bajo:delay', 'bajo:chalk')
    *
    * await delay(1000)
    * ...
-   * ```
+   * `
    *
    * @method
    * @async
-   * @param {...TNsPathPairs} pkgs - One or more packages in format ```{ns}:{packageName}```.
+   * @param {...TNsPathPairs} pkgs - One or more packages in format `{ns}:{packageName}`.
    * @returns {(Object|Array)} See above.
    */
   importPkg = async (...pkgs) => {
@@ -647,7 +653,7 @@ class Bajo extends Plugin {
    *
    * @method
    * @param {string} dir - Directory to check.
-   * @param {boolean} [returnPkg] - Set ```true``` to return its package.json content.
+   * @param {boolean} [returnPkg] - Set `true` to return its package.json content.
    * @returns {(boolean|Object)}
    */
   isValidApp = (dir, returnPkg) => {
@@ -660,7 +666,7 @@ class Bajo extends Plugin {
    *
    * @method
    * @param {string} dir - Directory to check.
-   * @param {boolean} [returnPkg] - Set ```true``` to return its package.json content.
+   * @param {boolean} [returnPkg] - Set `true` to return its package.json content.
    * @returns {(boolean|Object)}
    */
   isValidPlugin = (dir, returnPkg) => {
@@ -707,10 +713,10 @@ class Bajo extends Plugin {
   }
 
   /**
-   * Read and parse file as config object. Supported types: ```.js```, ```.json``` and ```.yml/.yaml```.
-   * More supports can be added using plugin. {@link https://github.com/ardhi/bajo-config|bajo-config} gives you additional supports for ```.yml```, ```.yaml``` and ```.toml``` file.
+   * Read and parse file as config object. Supported types: `.js`, `.json` and `.yml/.yaml`.
+   * More supports can be added using plugin. {@link https://github.com/ardhi/bajo-config|bajo-config} gives you additional supports for `.yml`, `.yaml` and `.toml` file.
    *
-   * If file extension is ```.*```, it will be auto detected and parsed accordingly
+   * If file extension is `.*`, it will be auto detected and parsed accordingly
    *
    * @method
    * @async
@@ -718,7 +724,7 @@ class Bajo extends Plugin {
    * @param {Object} [options={}] - Options.
    * @param {boolean} [options.ignoreError] - Any exception will be silently discarded.
    * @param {string} [options.ns] - If given, use this as the scope.
-   * @param {string} [options.pattern] - If given and auto detection is on (extension is ```.*```), it will be used for instead the default one.
+   * @param {string} [options.pattern] - If given and auto detection is on (extension is `.*`), it will be used for instead the default one.
    * @param {Object} [options.defValue={}] - Default value to use if value returned empty.
    * @param {Object} [options.parserOpts={}] - Parser setting.
    * @param {Object} [options.globOpts={}] - {@link https://github.com/mrmlnc/fast-glob|fast-glob} options.
@@ -743,7 +749,7 @@ class Bajo extends Plugin {
     const output = async (obj) => {
       let orig = parseObject(obj)
       if (!baseNs || extend === false) {
-        await this.runHook('bajo:afterReadConfig', file, orig, options)
+        await this.runHook('bajo.default:afterReadConfig', file, orig, options)
         if (cache.name) await this.app.cache.save(cache.name, orig, cache.ttlDur)
         return orig
       }
@@ -839,7 +845,7 @@ class Bajo extends Plugin {
    *
    * @method
    * @param {string} file - File to read.
-   * @param {boolean} [thrownNotFound=false] - If ```true```, silently ignore if file is not found.
+   * @param {boolean} [thrownNotFound=false] - If `true`, silently ignore if file is not found.
    * @returns {Object}
    */
   readJson = (file, thrownNotFound = false) => {
@@ -1043,6 +1049,7 @@ class Bajo extends Plugin {
    * Read config using all registered config handlers. The first handler that returns a
    * valid object or array will be used.
    *
+   * @method
    * @param {string} input - The input string to be processed by the config handlers.
    * @param {string[]} [exts] - Optional array of extensions to filter the config handlers. If provided, only handlers with matching extensions will be used.
    * @param {object} [options={}] - Options to be passed to the config handlers.

package/class/base.js

@@ -1,7 +1,7 @@
 import Plugin from './plugin.js'
 
 /**
- * This is the class that your own plugin suppose to extend. Don't use {@link Plugin} directly
+ * This is the class your own plugin suppose to extend. Don't use {@link Plugin} directly
  * unless you know what you're doing.
  *
  * @class
@@ -9,8 +9,10 @@ import Plugin from './plugin.js'
 
 class Base extends Plugin {
   /**
-   * @param {string} pkgName - Package name (the one you use in package.json).
-   * @param {Object} app - App instance reference. Useful to call app method inside a plugin.
+   * Constructor.
+   *
+   * @param {string} pkgName - Package name (the one in package.json)
+   * @param {Object} app - App instance reference. Useful to call app method inside a plugin
    */
   constructor (pkgName, app) {
     super(pkgName, app)
@@ -20,8 +22,7 @@ class Base extends Plugin {
      *
      * Semver is also supported.
      *
-     * @constant {string[]}
-     * @memberof Base
+     * @type {string[]}
      */
     this.dependencies = []
 
@@ -31,10 +32,11 @@ class Base extends Plugin {
 
   /**
    * Load config from file in data directory, program arguments and environment variables. Level of importance:
-   * ```Env Variables > Program Arguments > Config File```
+   * `Env Variables > Program Arguments > Config File`
    *
    * @method
    * @async
+   * @returns {void}
    */
   loadConfig = async () => {
     const { defaultsDeep } = this.app.lib.aneka
@@ -65,24 +67,33 @@ class Base extends Plugin {
   }
 
   /**
-   * After config is read, plugin will be initialized. You can still change your config here,
-   * because after plugin is initialized, config will be deep frozen.
+   * After config is read, plugin will be initialized.
    *
    * @method
    * @async
+   * @returns {void}
    */
   init = async () => {
   }
 
   /**
-   * This method will be called after plugin's init
+   * This method will be called after plugin's init. You can still change your config here,
+   * because after plugin is started, config will be deep frozen
    *
    * @method
    * @async
+   * @returns {void}
    */
   start = async () => {
   }
 
+  /**
+   * Reserved for future use. This method will be called before plugin is stopped.
+   *
+   * @method
+   * @async
+   * @returns {void}
+   */
   stop = async () => {
   }
 
@@ -92,6 +103,7 @@ class Base extends Plugin {
    *
    * @method
    * @async
+   * @returns {void}
    */
   exit = async () => {
     await this.dispose()
@@ -99,6 +111,10 @@ class Base extends Plugin {
 
   /**
    * Dispose internal references.
+   *
+   * @async
+   * @method
+   * @returns {Promise<void>}
    */
   dispose = async () => {
     await super.dispose()

package/class/cache.js

@@ -5,16 +5,19 @@
  */
 class Cache {
   /**
-   * @param {object} app - Application container.
+   * Constructor.
+   *
+   * @param {object} app - Application container
    */
   constructor (app) {
     this.app = app
   }
 
   /**
-   * Get root cache directory for this plugin.
+   * Get root directory for this class. It will be used to store all cache files, organized by namespace and TTL.
    *
-   * @returns {string} Absolute cache root directory.
+   * @method
+   * @returns {string} Absolute cache root directory
    */
   getRootDir = () => {
     return `${this.app.getPluginDataDir('bajo')}/cache`
@@ -23,9 +26,10 @@ class Cache {
   /**
    * Prepare cache paths for a namespaced key and TTL.
    *
-   * @param {string} name - Cache key in namespaced path format.
-   * @param {number|string} [ttlDur=0] - TTL duration (milliseconds or parseable duration).
-   * @returns {{dir: string, file: string, cacheDir: string}|undefined} Prepared paths or undefined when not cacheable.
+   * @method
+   * @param {string} name - Cache key in namespaced path format
+   * @param {number|string} [ttlDur=0] - TTL duration (milliseconds or parseable duration)
+   * @returns {{dir: string, file: string, cacheDir: string}|undefined} Prepared paths or undefined when not cacheable
    */
   prep = (name, ttlDur = 0) => {
     const { breakNsPath } = this.app.bajo
@@ -43,9 +47,10 @@ class Cache {
   /**
    * Load cached content when available and not expired.
    *
-   * @param {string} name - Cache key in namespaced path format.
-   * @param {number|string} [ttlDur=0] - TTL duration (milliseconds or parseable duration).
-   * @returns {Promise<*>} Cached value, or undefined if missing/expired.
+   * @method
+   * @param {string} name - Cache key in namespaced path format
+   * @param {number|string} [ttlDur=0] - TTL duration (milliseconds or parseable duration)
+   * @returns {Promise<any>} Cached value, or undefined if missing/expired
    */
   load = async (name, ttlDur = 0) => {
     const { fs } = this.app.lib
@@ -67,10 +72,11 @@ class Cache {
   /**
    * Save a value into cache for the given key and TTL directory.
    *
-   * @param {string} name - Cache key in namespaced path format.
-   * @param {*} item - Value to persist.
-   * @param {number|string} [ttlDur=0] - TTL duration (milliseconds or parseable duration).
-   * @returns {Promise<void>} Resolves when the value is written.
+   * @method
+   * @param {string} name - Cache key in namespaced path format
+   * @param {any} item - Value to persist
+   * @param {number|string} [ttlDur=0] - TTL duration (milliseconds or parseable duration)
+   * @returns {Promise<void>} Resolves when the value is written
    */
   save = async (name, item, ttlDur = 0) => {
     const { fs } = this.app.lib
@@ -88,10 +94,11 @@ class Cache {
   /**
    * Return cached content, and store the fallback value if cache is empty.
    *
-   * @param {string} name - Cache key in namespaced path format.
-   * @param {*} item - Fallback value to save when cache miss happens.
-   * @param {number|string} [ttlDur=0] - TTL duration (milliseconds or parseable duration).
-   * @returns {Promise<*>} Cached content.
+   * @method
+   * @param {string} name - Cache key in namespaced path format
+   * @param {any} item - Fallback value to save when cache miss happens
+   * @param {number|string} [ttlDur=0] - TTL duration (milliseconds or parseable duration)
+   * @returns {Promise<any>} Cached content
    */
   sync = async (name, item, ttlDur = 0) => {
     const content = await this.loadCache(name, ttlDur)
@@ -102,7 +109,8 @@ class Cache {
   /**
    * Remove a specific cache namespace or all first-level namespaces.
    *
-   * @param {string} name - Namespace name or "*" for all.
+   * @method
+   * @param {string} name - Namespace name or `*` for all
    * @returns {void}
    */
   _purgeItem = (name) => {
@@ -121,7 +129,8 @@ class Cache {
   /**
    * Purge cache by namespace or remove expired TTL directories.
    *
-   * @param {string} [name] - Optional namespace to remove directly.
+   * @method
+   * @param {string} [name] - Optional namespace to remove directly
    * @returns {void}
    */
   purge = (name) => {
@@ -140,6 +149,10 @@ class Cache {
 
   /**
    * Dispose internal reference.
+   *
+   * @async
+   * @method
+   * @returns {Promise<void>}
    */
   dispose = async () => {
     this.app = null

package/class/err.js

@@ -8,7 +8,7 @@ Error.stackTraceLimit = 15
 /**
  * Bajo error class, a thin wrapper of node's Error object.
  *
- * Every Bajo {@link Plugin|plugin} has a built-in method called ```error``` which basically the shortcut to create a new Err instance.
+ * Every Bajo {@link Plugin|plugin} has a built-in method called `error` which basically the shortcut to create a new Err instance.
  * It helps you create this instance anywhere in your code quickly without the hassle of importing & instantiating:
  *
  * ```javascript
@@ -18,30 +18,29 @@ Error.stackTraceLimit = 15
  */
 class Err extends Tools {
   /**
-   * @param {Plugin} plugin Plugin instance.
-   * @param {string} msg Error message.
-   * @param  {...any} [args] Variables to interpolate with error message. Payload object can be pushed at the very last argument
+   * Constructor.
+   *
+   * @param {Plugin} plugin - Plugin instance
+   * @param {string} msg - Error message
+   * @param  {...any} [args] - Variables to interpolate with error message. Payload object can be pushed at the very last argument
    */
   constructor (plugin, msg, ...args) {
     super(plugin)
 
     /**
      * Error payload extracted from the last arguments.
-     *
      * @type {Object}
      */
     this.payload = args.length > 0 && isPlainObject(args[args.length - 1]) ? args[args.length - 1] : {}
 
     /**
      * Original message before translation.
-     *
      * @type {string}
      */
     this.orgMessage = msg
 
     /**
      * Translated message.
-     *
      * @type {string}
      */
     this.message = this.payload.noTrans ? msg : this.plugin.t(msg, ...args)
@@ -51,7 +50,7 @@ class Err extends Tools {
    * Write message to the console.
    *
    * @method
-   * @returns {Err} Error object, useful for chaining.
+   * @returns {Err} - Error object, useful for chaining
    */
   write = () => {
     let err
@@ -94,8 +93,11 @@ class Err extends Tools {
   /**
    * Pretty format error details.
    *
+   * Formatted error will be applied directly to the value parameter, and a detailsMessage
+   * will be returned for display purpose.
+   *
    * @method
-   * @param {Object} value Value to format.
+   * @param {Object} value - Value to format
    * @returns {Object}
    */
   formatErrorDetails = (value) => {