bajo 2.23.0 → 2.25.0

package/class/plugin.js

@@ -4,12 +4,14 @@ import Err from './err.js'
 const { get, isEmpty, cloneDeep, omit, isPlainObject, camelCase } = lodash
 
 /**
- * This is the **mother** of all plugin classes. All Bajo plugin classess inherit from this class
- * respectfully.
+ * The **root** plugin class. All Bajo plugin classes inherit from this class respectfully.
  *
- * There are currently only two main plugins available:
- * - {@link Bajo} - Core plugin class, responsible for system wide setup and boot process. You should not touch this obviously.
- * - {@link Base} - Base plugin class your own plugin should inherite from.
+ * This class provides the basic structure and functionality for all plugins in the Bajo framework.
+ * It includes methods for configuration management, error handling, logging, and more.
+ *
+ * Only two direct descendants of this class are allowed:
+ * - {@link Bajo} - Bajo core plugin class, responsible for system wide setup and boot process. You should not touch this obviously
+ * - {@link Base} - Base plugin class **your own plugin should inherit from**
  *
  * @class
  */
@@ -39,7 +41,9 @@ class Plugin {
      * Plugin alias. Derived plugin must provide its own, unique alias. If it left blank,
      * Bajo will provide this automatically (by using the kebab-cased version of plugin name).
      *
-     * @readonly
+     * By convention, plugin alias should be all lower case, alphanumeric, and without any space or special character except `-`.
+     * It should be unique across all plugins in the Bajo framework, as it is used to identify the plugin in the system beside its namespace.
+     *
      * @type {string}
      */
     this.alias = null
@@ -53,7 +57,7 @@ class Plugin {
     /**
      * Configuration object.
      *
-     * @type {Object}
+     * @type {TConfig}
      * @see {@tutorial config}
      */
     this.config = {}
@@ -75,7 +79,7 @@ class Plugin {
   }
 
   /**
-   * Get package info.
+   * Get package info. Basically it reads the package.json file and returns the requested fields
    *
    * @method
    * @param {string} [dir] - Package directory. Defaults to the current plugin's package dir
@@ -91,14 +95,18 @@ class Plugin {
   }
 
   /**
-   * Get plugin's config value.
+   * Get plugin's configuration object's value.
+   *
+   * > **Note**: Configuration object is frozen after boot process, so you can't modify it at runtime.
+   * If you want to change its values, you need to do it in the config file, program options or via environment variables.
+   * Hooks are also available to modify the configuration before the boot process.
    *
    * @method
    * @param {string} [path] - dot separated config path (think of lodash's 'get'). If not provided, the full config will be given
    * @param {Object} [options={}] - Options object
    * @param {any} [options.defValue={}] - Default value to use if returned object is undefined
    * @param {string[]} [options.omit=[]] - Omit these keys from returned object
-   * @param {boolean} [options.noClone=false] - Set true to NOT clone returned object
+   * @param {boolean} [options.noClone=false] - Set true to **NOT clone** returned object
    * @returns {Object} Returned object. If no path provided, the whole config object is returned
    */
   getConfig = (path, options = {}) => {
@@ -110,12 +118,18 @@ class Plugin {
   }
 
   /**
-   * Create an instance of {@link Err} object.
+   * Create an instance of {@link Err} object by providing an error message and optional arguments. Error instance will
+   * then be displayed on console and returned so you can chain it with other methods if you want.
+   *
+   * Typically, you would use this method to throw an error and the framework will handle it gracefully.
+   *
+   * This method is a shortcut to create a new Err instance.
    *
    * @method
    * @param {string} msg - Error message
-   * @param  {...any} [args] - Argument variables you might want to add to the error object
+   * @param  {...*} [args] - Argument variables you might want to add to the error object
    * @returns {Err} Err instance
+   * @see {@link Err#write}
    */
   error = (msg, ...args) => {
     if (!this.print) return new Error(msg, ...args)
@@ -124,12 +138,11 @@ class Plugin {
   }
 
   /**
-   * Create an instance of Err object, display it on screen and then force
-   * terminate the app.
+   * Same as {@link Plugin#error} but will *forcefully* terminate the process after printing the error to console.
    *
    * @method
    * @param {string} msg - Error message
-   * @param  {...any} [args] - Argument variables you might want to add to the error object
+   * @param  {...*} [args] - Argument variables you might want to add to the error object
    * @returns {void}
    */
   fatal = (msg, ...args) => {
@@ -145,46 +158,56 @@ class Plugin {
    *
    * @method
    * @param {string} text - Text to translate
-   * @param  {...any} params - Variables to interpolate to `text`
+   * @param  {...*} args - Arguments to interpolate to `text`
    * @returns {string}
+   * @see {@link App#t}
    */
-  t = (text, ...params) => {
-    return this.app.t(this.ns, text, ...params)
+  t = (text, ...args) => {
+    return this.app.t(this.ns, text, ...args)
   }
 
   /**
-   * Check whether translation text/key exists.
+   * Check whether translation text (key) exists.
    *
    * Shortcut to {@link App#te} with ns parameter set to this plugin namespace.
    *
    * @method
    * @param {string} text - Text to translate
-   * @param  {...any} params - Variables to interpolate to `text`
-   * @returns {string}
+   * @param  {...*} args - Arguments to interpolate to `text`
+   * @returns {boolean}
+   * @see {@link App#te}
    */
-  te = (text, ...params) => {
-    return this.app.te(this.ns, text, ...params)
+  te = (text, ...args) => {
+    return this.app.te(this.ns, text, ...args)
   }
 
   /**
-   * Force bind methods to self (`this`).
+   * Force bind methods to `this` context.
+   *
+   * Since JavaScript's `this` is dynamic, this method is useful to ensure
+   * that the methods always refer to the correct instance of the class.
    *
+   * Typically, you would call this method in the constructor of your plugin class,
+   * passing an array of method names or imported functions that you want to bind.
    * @method
-   * @param {string[]} names - Method's names
+   * @param {...(string|function)} names - Method's names or function references to bind to `this` context
    * @returns {void}
    */
-  selfBind (names) {
-    if (!Array.isArray(names)) names = [names]
+  bindThis (...names) {
     for (const name of names) {
-      this[name] = this[name].bind(this)
+      if (typeof name === 'string') this[name] = this[name].bind(this)
+      else if (typeof name === 'function') {
+        const methodName = name.name
+        this[methodName] = name.bind(this)
+      }
     }
   }
 
   /**
-   * Alias to `this.app.dump()`.
+   * Shortcut to `this.app.dump()`.
    *
    * @method
-   * @param {...any} args - Arguments
+   * @param {...*} args - Arguments
    * @returns {void}
    */
   dump = (...args) => {

package/class/print.js

@@ -23,12 +23,14 @@ const { isPlainObject } = lodash
  * Features many methods to display things on screen/console using {@link https://github.com/sindresorhus/ora|ora}
  * based spinner.
  *
+ * You don't need to instantiate this class directly, since every plugin instance already has a built-in `print` property you can use
+ * to access this class instance.
+ *
  * @class
  */
 class Print extends Tools {
   /**
-   * @param {Plugin} plugin Plugin instance.
-   * @param {Print.TOptions} [options={}] Options object.
+   * Constructor.
    */
   constructor (plugin, options = {}) {
     super(plugin)
@@ -52,6 +54,7 @@ class Print extends Tools {
 
     /**
      * ora instance
+     * @type {object}
      * @see {@link https://github.com/sindresorhus/ora|ora}
      */
     this.ora = ora(this.options.ora)
@@ -62,10 +65,10 @@ class Print extends Tools {
    * Setting spinner options; override the one passed at constructor.
    *
    * @method
-   * @param {any[]} - [args=[]] Array of options. If the last argument is an object, it will be used to override ora options
+   * @param {...*} args - Arguments. If the last argument is an object, it will be used to override the current options.
    * @returns {void}
    */
-  setOpts = (args = []) => {
+  setOpts = (...args) => {
     const { silent } = this.app.bajo.config
     let opts = {}
     if (isPlainObject(args.slice(-1)[0])) opts = args.pop()
@@ -77,12 +80,12 @@ class Print extends Tools {
    * Translate text, prefixed with counter and/or datetime etc.
    *
    * @param {string} text - Text to translate
-   * @param {...any} [args] - Any variable to interpolate text translation. If the last argument is an object, it will be used to override ora's options.
+   * @param {...*} [args] - Arguments to interpolate text translation. If the last argument is an object, it will be used to override ora's options.
    * @returns {string}
    */
   buildText = (text, ...args) => {
     text = this.plugin.t(text, ...args)
-    this.setOpts(args)
+    this.setOpts(...args)
     const prefixes = []
     if (this.options.showDatetime) prefixes.push('[' + this.app.lib.dayjs().toISOString() + ']')
     if (this.options.showCounter) prefixes.push('[' + this.getElapsed() + ']')
@@ -96,7 +99,7 @@ class Print extends Tools {
    *
    * @method
    * @param {string} text - Text to use
-   * @param {...any} [args] - Any variable to interpolate text. If the last argument is an object, it will be used to override ora's options
+   * @param {...*} [args] - Arguments to interpolate text. If the last argument is an object, it will be used to override ora's options
    * @returns {Print} Return the instance itself, usefull for method chaining
    */
   setText = (text, ...args) => {
@@ -124,11 +127,11 @@ class Print extends Tools {
    *
    * @method
    * @param {string} text - Text to use
-   * @param {...any} [args] - Any variable to interpolate text. If the last argument is an object, it will be used to override ora's options
+   * @param {...*} [args] - Arguments to interpolate text. If the last argument is an object, it will be used to override ora's options
    * @returns {Print} Return the instance itself, usefull for method chaining
    */
   start = (text, ...args) => {
-    this.setOpts(args)
+    this.setOpts(...args)
     this.setText(text, ...args)
     this.ora.start()
     return this
@@ -150,7 +153,7 @@ class Print extends Tools {
    *
    * @method
    * @param {string} text - Text to use
-   * @param {...any} [args] - Any variable to interpolate text. If the last argument is an object, it will be used to override ora options.
+   * @param {...*} [args] - Arguments to interpolate text. If the last argument is an object, it will be used to override ora options.
    * @returns {Print} Return the instance itself, usefull for method chaining
    */
   succeed = (text, ...args) => {
@@ -164,7 +167,7 @@ class Print extends Tools {
    *
    * @method
    * @param {string} text - Text to use
-   * @param {...any} [args] - Any variable to interpolate text. If the last argument is an object, it will be used to override ora options
+   * @param {...*} [args] - Arguments to interpolate text. If the last argument is an object, it will be used to override ora options
    * @returns {Print} Return the instance itself, usefull for method chaining
    */
   fail = (text, ...args) => {
@@ -178,7 +181,7 @@ class Print extends Tools {
    *
    * @method
    * @param {string} text - Text to use
-   * @param {...any} [args] - Any variable to interpolate text. If the last argument is an object, it will be used to override ora options
+   * @param {...*} [args] - Arguments to interpolate text. If the last argument is an object, it will be used to override ora options
    * @returns {Print} Return the instance itself, usefull for method chaining
    */
   warn = (text, ...args) => {
@@ -192,7 +195,7 @@ class Print extends Tools {
    *
    * @method
    * @param {string} text - Text to use
-   * @param {...any} [args] - Any variable to interpolate text. If the last argument is an object, it will be used to override ora options
+   * @param {...*} [args] - Arguments to interpolate text. If the last argument is an object, it will be used to override ora options
    * @returns {Print} Return the instance itself, usefull for method chaining
    */
   info = (text, ...args) => {
@@ -228,7 +231,7 @@ class Print extends Tools {
    *
    * @method
    * @param {string} text - Text to use
-   * @param {...any} [args] - Any variable to interpolate text. If the last argument is an object, it will be used to override ora options
+   * @param {...*} [args] - Arguments to interpolate text. If the last argument is an object, it will be used to override ora options
    * @returns {void}
    */
   fatal = (text, ...args) => {
@@ -243,7 +246,7 @@ class Print extends Tools {
   }
 
   /**
-   * Create a new print instance.
+   * Create a new Print instance.
    *
    * @method
    * @param {App.TOptions} [options] Options object. If not provided, defaults to the current options.

package/class/tools.js

@@ -1,33 +1,43 @@
 /**
- * Tools class.
+ * Tools class. Basic utility class that provides common functionalities for other classes to extend.
+ * It serves as a base class for error handling, printing, and other utility operations.
  *
  * @class
  */
 class Tools {
   constructor (plugin) {
     /**
-     * Attached plugin
+     * Reference to the plugin instance that this Tools class is associated with
      * @type {Plugin}
      */
     this.plugin = plugin
 
     /**
-     * The app instance
+     * Reference to the app instance
      * @type {App}
      */
     this.app = plugin.app
   }
 
   /**
-   * Force bind methods to self (`this`).
+   * Force bind methods to `this` context.
    *
+   * Since JavaScript's `this` is dynamic, this method is useful to ensure
+   * that the methods always refer to the correct instance of the class.
+   *
+   * Typically, you would call this method in the constructor of your plugin class,
+   * passing an array of method names or imported functions that you want to bind.
    * @method
-   * @param {string[]} names - Method's names
+   * @param {...(string|function)} names - Method's names or function references to bind to `this` context
    * @returns {void}
    */
-  selfBind (names) {
+  bindThis (...names) {
     for (const name of names) {
-      this[name] = this[name].bind(this)
+      if (typeof name === 'string') this[name] = this[name].bind(this)
+      else if (typeof name === 'function') {
+        const methodName = name.name
+        this[methodName] = name.bind(this)
+      }
     }
   }
 

package/docs/App.html

@@ -1,3 +1,53 @@
 <!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Class: App</title><!--[if lt IE 9]>
       <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124    C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124    c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227    c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6    V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474    c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323    c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848    S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328    c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="light"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Bajo API</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="App.html">App</a></div><div class="sidebar-section-children"><a href="Bajo.html">Bajo</a></div><div class="sidebar-section-children"><a href="Base.html">Base</a></div><div class="sidebar-section-children"><a href="Cache.html">Cache</a></div><div class="sidebar-section-children"><a href="Err.html">Err</a></div><div class="sidebar-section-children"><a href="Log.html">Log</a></div><div class="sidebar-section-children"><a href="Plugin.html">Plugin</a></div><div class="sidebar-section-children"><a href="Print.html">Print</a></div><div class="sidebar-section-children"><a href="Tools.html">Tools</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-Helper.html">Helper</a></div><div class="sidebar-section-children"><a href="module-Hook.html">Hook</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#boot">boot</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/bajo" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/bajo" target="">Github</a></div><div class="navbar-item"><a id="" href="https://bajo.app" target="">Bajo</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><header><h1 id="App-title" class="has-anchor">App</h1><div class="class-description"><p>App class. This is the root. This is where all plugins call it home.</p></div></header><article><div class="container-overview"><h2 id="constructor" class="has-anchor">Constructor</h2><h3 class="name has-anchor" id="App"><span class="type-signature"></span>new App<span class="signature">(options<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Constructor.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="App.html#.TOptions">App.<wbr>TOptions</a></span></td><td class="attributes">&lt;optional><br></td><td class="default">{}</td><td class="description last"><p>Options object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="class_app.js.html">class/app.js</a>, <a href="class_app.js.html#line80">line 80</a></li></ul></dd></div></dl></div><h2 id="members" class="subsection-title has-anchor">Members</h2><h3 class="name has-anchor" id="applet"><span class="type-signature"></span>applet<span class="type-signature"> :string</span></h3><div class="description"><p>If app runs in applet mode, this will be the applet's name.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">string</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="class_app.js.html">class/app.js</a>, <a href="class_app.js.html#line170">line 170</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="applets"><span class="type-signature"></span>applets<span class="type-signature"> :Array</span></h3><div class="description"><p>Applets container.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Array</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="class_app.js.html">class/app.js</a>, <a href="class_app.js.html#line114">line 114</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="args"><span class="type-signature"></span>args<span class="type-signature"> :Array.&lt;string></span></h3><div class="description"><p>Parsed program arguments.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Array.&lt;string></span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="class_app.js.html">class/app.js</a>, <a href="class_app.js.html#line181">line 181</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li>module:Helper.parseArgsArgv</li></ul></dd></div></dl><b>Example</b><div class="rel"><pre class="prettyprint"><code>$ node index.js arg1 arg2
+    <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124    C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124    c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227    c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6    V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474    c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323    c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848    S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328    c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="light"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Bajo API</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-01_WELCOME.html">Welcome</a></div><div class="sidebar-section-children"><a href="tutorial-02_GETTING_STARTED.html">Getting Started</a></div><div class="sidebar-section-children"><a href="tutorial-03_USER_GUIDE.html">User Guide</a></div><div class="sidebar-section-children"><a href="tutorial-04_DEV_GUIDE.html">Developer Guide</a></div><div class="sidebar-section-children"><a href="tutorial-05_ECOSYSTEM.html">Ecosystem</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="App.html">App</a></div><div class="sidebar-section-children"><a href="Bajo.html">Bajo</a></div><div class="sidebar-section-children"><a href="Base.html">Base</a></div><div class="sidebar-section-children"><a href="Cache.html">Cache</a></div><div class="sidebar-section-children"><a href="Err.html">Err</a></div><div class="sidebar-section-children"><a href="Log.html">Log</a></div><div class="sidebar-section-children"><a href="Main.html">Main</a></div><div class="sidebar-section-children"><a href="Plugin.html">Plugin</a></div><div class="sidebar-section-children"><a href="Print.html">Print</a></div><div class="sidebar-section-children"><a href="Tools.html">Tools</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-Applet.html">Applet</a></div><div class="sidebar-section-children"><a href="module-Helper.html">Helper</a></div><div class="sidebar-section-children"><a href="module-Hook.html">Hook</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#TConfig">TConfig</a></div><div class="sidebar-section-children"><a href="global.html#boot">boot</a></div><div class="sidebar-section-children"><a href="global.html#package%25C2%25B7json">package·json</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/bajo" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/bajo" target="">Github</a></div><div class="navbar-item"><a id="" href="https://bajo.app" target="">Bajo</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><header><h1 id="App-title" class="has-anchor">App</h1><div class="class-description"><p>App class. This is the root. This is where all plugins call it home.</p><p>This class should not be instantiated directly (see example in <a href="App.html#.TOptions">App.TOptions</a> if you feel adventurous). Instead, use the default <a href="global.html#boot">boot</a> script.</p><p>Plugins (including special plugins <a href="Main.html">Main</a> and <a href="Bajo.html">Bajo</a>) are loaded and attached as property members of this class. They can be accessed using their name/namespace.</p><p>In every plugin there is a reference to this class instance, so they can call each other easily, e.g. in your plugin method, you would call other plugin's method like this <code>this.app.otherPlugin.method()</code>.</p><p>A typical Bajo app should follow the following structure:</p><pre class="prettyprint source"><code>my-app
+|-- package.json
+|-- index.js
+|-- main
+|   |-- extend
+|   |   |-- bajo
+|   |   |   |-- hook
+|   |   |   |   |   |-- myPlugin:beforeAction.js
+|   |   |   |   |   |-- myOtherPlugin:afterAction.js
+|   |   |   |-- intl
+|   |-- index.js
+|-- data
+|   |-- config
+|   |   |-- .plugins
+|   |   |-- bajo.yml
+|   |   |-- myPlugin.yml
+</code></pre></div></header><article><div class="container-overview"><h2 id="constructor" class="has-anchor">Constructor</h2><h3 class="name has-anchor" id="App"><span class="type-signature"></span>new App<span class="signature">(options<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Constructor. See <a href="App.html#.TOptions">App.TOptions</a> if you want to write custom boot process for your app without using the default boot module.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="App.html#.TOptions">App.<wbr>TOptions</a></span></td><td class="attributes">&lt;optional><br></td><td class="default">{}</td><td class="description last"><p>Options object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="class_app.js.html">class/app.js</a>, <a href="class_app.js.html#line156">line 156</a></li></ul></dd></div></dl></div><h2 id="members" class="subsection-title has-anchor">Members</h2><h3 class="name has-anchor" id="applet"><span class="type-signature"></span>applet<span class="type-signature"> :string</span></h3><div class="description"><p>If app runs in <strong>applet</strong> mode, this will be the current applet's name. Otherwise, it will be <code>undefined</code>. See <a href="module-Applet.html">applet</a> for details.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">string</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="class_app.js.html">class/app.js</a>, <a href="class_app.js.html#line268">line 268</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="applets"><span class="type-signature"></span>applets<span class="type-signature"> :Array</span></h3><div class="description"><p>Applets container. Usefull to get all available applets in your app. See <a href="module-Applet.html">applet</a> for details.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Array</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="class_app.js.html">class/app.js</a>, <a href="class_app.js.html#line190">line 190</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="args"><span class="type-signature"></span>args<span class="type-signature"> :Array.&lt;string></span></h3><div class="description"><p>Parsed program arguments.</p><p>Example:</p><pre class="prettyprint source lang-js"><code>$ node index.js arg1 arg2
+...
+console.log(this.args) // it should print: ['arg1', 'arg2']
+</code></pre></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Array.&lt;string></span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="class_app.js.html">class/app.js</a>, <a href="class_app.js.html#line282">line 282</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="argv"><span class="type-signature"></span>argv<span class="type-signature"> :Object</span></h3><div class="description"><p>Parsed program options:</p><ul><li>Dash (<code>-</code>) breaks the string into object keys</li><li>While colon (<code>:</code>) is used as namespace - object separator. If no such namespace found, it is saved under <code>_</code>.</li></ul><p>Parsed object values are normalized to its primitives using <a href="https://github.com/ladjs/dotenv-parse-variables">dotenv-parse-variables</a></p><pre class="prettyprint source lang-js"><code>$ node index.js --my-name-first=John --my-name-last=Doe --my-birthDay=secret --nameSpace:path-subPath=true
+...
+// {
+//   _: {
+//    my: {
+//       name: { first: 'John', last: 'Doe' },
+//       birthDay: 'secret'
+//     }
+//   },
+//   nameSpace: { path: { subPath: true } }
+// }</code></pre></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="class_app.js.html">class/app.js</a>, <a href="class_app.js.html#line306">line 306</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="baseClass"><span class="type-signature"></span>baseClass<span class="type-signature"> :Object</span></h3><div class="description"><p>All plugin's base classes are saved here for reference so that you can extend them in your own plugins.</p><p>Two basic classes from Bajo package are also provided: <a href="Base.html">Base</a> and <a href="Tools.html">Tools</a>. These are the most used classes in Bajo plugin development. You can extend them to create your own plugin's base class:</p><pre class="prettyprint source lang-javascript"><code>// factory function to create your own plugin's base class
+async function () {
+  const { Base } = this.app.baseClass
+  class MyBase extends Base {
+    constructor(pkgName, app) {
+      super(pkgName, app)
+      this.myProperty = 'myValue' // your class property
+    }
+
+    async myMethod() {
+      // your class method
+    }
+  }
+}
+</code></pre></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="class_app.js.html">class/app.js</a>, <a href="class_app.js.html#line262">line 262</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="cache"><span class="type-signature"></span>cache<span class="type-signature"> :<a href="Cache.html">Cache</a></span></h3><div class="description"><p>Internal cache instance. This is used to store temporary data in memory for faster access.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type"><a href="Cache.html">Cache</a></span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="class_app.js.html">class/app.js</a>, <a href="class_app.js.html#line332">line 332</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="configHandlers"><span class="type-signature"></span>configHandlers<span class="type-signature"> :Array.&lt;<a href="App.html#.TConfigHandler">App.TConfigHandler</a>></span></h3><div class="description"><p>Config handlers container. This is where all config handlers are stored. Each handler is responsible to read and write config file in a particular format. Bajo uses this heavily to read/write config files and/or anything that needs to be parsed/stringified from string to object and vice versa.</p><p>By default, there are three built-in handlers: <code>.js</code>, <code>.json</code> and <code>.yml/.yaml</code>. Use plugins to add more, e.g <a href="https://github.com/ardhi/bajo-config">bajo-config</a> lets you to use <code>.toml</code>.</p><blockquote><p><em>Note</em>: <code>.js</code> is for reading only, it cannot be used to write config file.</p></blockquote></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Array.&lt;<a href="App.html#.TConfigHandler">App.TConfigHandler</a>></span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="class_app.js.html">class/app.js</a>, <a href="class_app.js.html#line216">line 216</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="envVars"><span class="type-signature"></span>envVars<span class="type-signature"> :Object</span></h3><div class="description"><p>Parsed environment variables. Support dotenv (<code>.env</code>) file too!</p><ul><li>Underscore (<code>_</code>) between keys merge those keys into a single camel-cased key</li><li>Double underscores (<code>__</code>) between keys breaks the key into nested objects</li><li>Meanwhile a dot (<code>.</code>) between keys breaks the key into nested, name-spaced objects</li></ul><p>Parsed object values are normalized to its primitives using <a href="https://github.com/ladjs/dotenv-parse-variables">dotenv-parse-variables</a></p><p>Example:</p><ul><li><code>MY_KEY=secret</code> → <code>{ _: { myKey: 'secret' } }</code></li><li><code>MY_KEY__SUB_KEY=supersecret</code> → <code>{ _: { myKey: { subKey: 'supersecret' } } }</code></li><li><code>MY_NS.MY_NAME=John</code> → <code>{ myNs: { myName: 'John' } }</code></li></ul><blockquote><p><strong>Tips</strong>: During boot process, Bajo will add <code>APPDIR</code> environment variable which points to your app's root directory.</p></blockquote></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="class_app.js.html">class/app.js</a>, <a href="class_app.js.html#line325">line 325</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="envs"><span class="type-signature"></span>envs<span class="type-signature"> :<a href="App.html#.TEnv">App.TEnv</a></span></h3><div class="description"><p>Supported environments. Read-only</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type"><a href="App.html#.TEnv">App.<wbr>TEnv</a></span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="class_app.js.html">class/app.js</a>, <a href="class_app.js.html#line178">line 178</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="lib"><span class="type-signature"></span>lib<span class="type-signature"> :<a href="App.html#.TLib">App.TLib</a></span></h3><div class="description"><p>Gives you direct access to the most commonly used 3rd party library in a Bajo based app. No manual import necessary, always available, anywhere, anytime!</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type"><a href="App.html#.TLib">App.<wbr>TLib</a></span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="class_app.js.html">class/app.js</a>, <a href="class_app.js.html#line227">line 227</a></li></ul></dd></div></dl><b>Example</b><div class="rel"><pre class="prettyprint"><code>const { camelCase, kebabCase } = this.app.lib._
+const translated = this.app.t('main', 'My cute cat is %s', 'purring')
+// or within your plugin
+const translated = this.t('My cute cat is %s', 'purring')
+</code></pre></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>ns</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="description last"><p>Namespace</p></td></tr><tr><td class="name"><code>text</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="description last"><p>Text to translate</p></td></tr><tr><td class="name"><code>params</code></td><td class="type"><span class="param-type">*</span></td><td class="attributes">&lt;repeatable><br></td><td class="description last"><p>Parameters to interpolate into the translation text</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="class_app.js.html">class/app.js</a>, <a href="class_app.js.html#line663">line 663</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="te"><span class="type-signature"></span>te<span class="signature">(ns, text)</span><span class="type-signature"> &rarr; {boolean}</span></h3><div class="description"><p>Check whether translation text/key exists.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>ns</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>Namespace</p></td></tr><tr><td class="name"><code>text</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>Text to translate</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="class_app.js.html">class/app.js</a>, <a href="class_app.js.html#line686">line 686</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">boolean</span></dd></dl></div><h2 id="type-definitions" class="subsection-title has-anchor">Type Definitions</h2><h3 class="name has-anchor" id=".TConfigHandler">TConfigHandler</h3><div class="description"><p>Config handler definition. Your own handler must follow this structure.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>ns</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="description last"><p>Owner plugin namespace</p></td></tr><tr><td class="name"><code>ext</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="description last"><p>Supported file extension</p></td></tr><tr><td class="name"><code>readHandler</code></td><td class="type"><span class="param-type"><a href="App.html#.readHandler">App.<wbr>readHandler</a></span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>Async function to call for reading</p></td></tr><tr><td class="name"><code>writeHandler</code></td><td class="type"><span class="param-type"><a href="App.html#.writeHandler">App.<wbr>writeHandler</a></span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>Async function to call for writing</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="class_app.js.html">class/app.js</a>, <a href="class_app.js.html#line75">line 75</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li><a href="App.html#configHandlers">App#configHandlers</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".TEnv">TEnv</h3><div class="description"><p>Supported environments.</p><p>Environment is one of the most important aspect of a Bajo app. It is used to determine how your app should behave in different environments. It allows you to have different configurations and settings, and as a plugin developer, you can also use it to determine how your plugin should behave in different environments.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>dev</code></td><td class="type"><span class="param-type">string</span></td><td class="default">development</td><td class="description last"></td></tr><tr><td class="name"><code>stag</code></td><td class="type"><span class="param-type">string</span></td><td class="default">staging</td><td class="description last"></td></tr><tr><td class="name"><code>prod</code></td><td class="type"><span class="param-type">string</span></td><td class="default">production</td><td class="description last"></td></tr><tr><td class="name"><code>test</code></td><td class="type"><span class="param-type">string</span></td><td class="default">testing</td><td class="description last"></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="class_app.js.html">class/app.js</a>, <a href="class_app.js.html#line33">line 33</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".TLib">TLib</h3><div class="description"><p>Most commonly used libraries by Bajo and its plugins. They are already imported and ready to use, so you don't have to import them again in your plugin.</p><p>Example:</p><pre class="prettyprint source lang-javascript"><code>const { fs, dayjs } = this.app.lib
+fs.ensureDirSync('/path/to/dir')
+const now = dayjs().format('YYYY-MM-DD HH:mm:ss')
+</code></pre></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>_</code></td><td class="type"><span class="param-type">Object</span></td><td class="attributes"></td><td class="description last"><p>Access to <a href="https://lodash.com">lodash</a>.</p></td></tr><tr><td class="name"><code>fs</code></td><td class="type"><span class="param-type">Object</span></td><td class="attributes"></td><td class="description last"><p>Access to <a href="https://github.com/jprichardson/node-fs-extra">fs-extra</a>.</p></td></tr><tr><td class="name"><code>fastGlob</code></td><td class="type"><span class="param-type">Object</span></td><td class="attributes"></td><td class="description last"><p>Access to <a href="https://github.com/mrmlnc/fast-glob">fast-glob</a>.</p></td></tr><tr><td class="name"><code>sprintf</code></td><td class="type"><span class="param-type">Object</span></td><td class="attributes"></td><td class="description last"><p>Access to <a href="https://github.com/alexei/sprintf.js">sprintf</a>.</p></td></tr><tr><td class="name"><code>aneka</code></td><td class="type"><span class="param-type">Object</span></td><td class="attributes"></td><td class="description last"><p>Access to <a href="https://github.com/ardhi/aneka">aneka</a>.</p></td></tr><tr><td class="name"><code>outmatch</code></td><td class="type"><span class="param-type">Object</span></td><td class="attributes"></td><td class="description last"><p>Access to <a href="https://github.com/axtgr/outmatch">outmatch</a>.</p></td></tr><tr><td class="name"><code>dayjs</code></td><td class="type"><span class="param-type">Object</span></td><td class="attributes"></td><td class="description last"><p>Access to <a href="https://day.js.org">dayjs</a> with utc &amp; customParseFormat plugin already applied.</p></td></tr><tr><td class="name"><code>freeze</code></td><td class="type"><span class="param-type">Object</span></td><td class="attributes"></td><td class="description last"><p>Freeze object. See <a href="module-Helper.html#.freeze">freeze</a> for more details.</p></td></tr><tr><td class="name"><code>findDeep</code></td><td class="type"><span class="param-type">Object</span></td><td class="attributes"></td><td class="description last"><p>Deep file file in an array of files. See <a href="module-Helper.html#.findDeep">findDeep</a> for more details.</p></td></tr><tr><td class="name"><code>outmatchNs</code></td><td class="type"><span class="param-type">Object</span></td><td class="attributes"></td><td class="description last"><p>Like outmatch, but support scoped source &amp; pattern. See <a href="module-Helper.html#.outmatchNs">outmatchNs</a> for more details.</p></td></tr><tr><td class="name"><code>parseObject</code></td><td class="type"><span class="param-type">Object</span></td><td class="attributes"></td><td class="description last"><p>Parse object and normalize their values. Also support translation. See <a href="module-Helper.html#.parseObject">parseObject</a> for more details.</p></td></tr><tr><td class="name"><code>anekaSpatial</code></td><td class="type"><span class="param-type">Object</span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>Access to <a href="https://ardhi.github.io/bajo-spatial">aneka-spatial</a> helpers if <code>bajoSpatial</code> plugin is loaded.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_helper.js.html">lib/helper.js</a>, <a href="lib_helper.js.html#line132">line 132</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li><a href="App.html">App</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".TOptions">TOptions</h3><div class="description"><p>Options object passed to <a href="App.html">App</a> constructor. By default, you don't need to pass any options, unless you want to manually override the default behavior.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>cwd</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>Set current working directory. Defaults to the script directory</p></td></tr><tr><td class="name"><code>plugins</code></td><td class="type"><span class="param-type">Array.&lt;string></span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>Array of plugins <strong>package names</strong> to load. If provided, it override the list in <code>package.json</code> and <code>.plugins</code> file</p></td></tr><tr><td class="name"><code>config</code></td><td class="type"><span class="param-type">Object</span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>Plugin config objects, with plugin name as keys and their respective config objects as values. If provided, plugin configs will no longer be read from its config files</p></td></tr><tr><td class="name"><code>hooks</code></td><td class="type"><span class="param-type">Array.&lt;<a href="module-Hook.html#.THook">module:Hook.THook</a>></span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>Array of hooks to be added to the app</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="class_app.js.html">class/app.js</a>, <a href="class_app.js.html#line87">line 87</a></li></ul></dd></div></dl><b>Example</b><div class="rel"><pre class="prettyprint"><code>// If you feel adventurous and decide to manually boot your app without the default boot module, here we go,,,
  plugins: ['my-plugin', 'my-other-plugin'],
  config: {
    myPlugin: {
      // plugin config here
    },
    myOtherPlugin: {
      // plugin config here
    }
   },
   hooks: [{
     name: 'myPlugin:myHook',
     handler: async function (arg1, arg2) {
       // do something with arg1 and arg2
     }
   }]
  }