bajo 2.20.1 → 2.21.0

package/class/_helper.js

@@ -15,7 +15,6 @@ import localizedFormat from 'dayjs/plugin/localizedFormat.js'
 import weekOfYear from 'dayjs/plugin/weekOfYear.js'
 import freeze from '../lib/freeze.js'
 import findDeep from '../lib/find-deep.js'
-import omitDeep from 'omit-deep'
 
 /**
  * Internal helpers called by Bajo and other classes. It should remains
@@ -160,8 +159,7 @@ export const lib = {
   dayjs,
   aneka,
   freeze,
-  findDeep,
-  omitDeep
+  findDeep
 }
 
 /**
@@ -281,12 +279,12 @@ export async function collectConfigHandlers () {
 export async function buildExtConfig () {
   // config merging
   const { defaultsDeep, includes } = this.app.lib.aneka
-  const { parseObject, omitDeep } = this.app.lib
-  const { isEmpty, get, isString, without } = this.app.lib._
+  const { parseObject } = this.app.lib
+  const { isEmpty, get, isString, without, omit } = this.app.lib._
 
   let resp = get(this, `app.options.config.${this.ns}`, {})
   if (isEmpty(resp)) resp = await this.readAllConfigs(`${this.dir.data}/config/${this.ns}`)
-  resp = omitDeep(pick(resp, ['log', 'exitHandler', 'env', 'runtime']), omitted)
+  resp = omit(pick(resp, ['log', 'exitHandler', 'env', 'runtime']), omitted)
   const envs = this.app.envs
   this.config = defaultsDeep({}, this.config, resp, defConfig)
   // language

package/class/app.js

@@ -106,9 +106,9 @@ class App {
     /**
      * Config handlers.
      *
-     * By default, there are two built-in handlers available: ```.js```
-     * and ```.json```. Use plugins to add more, e.g {@link https://github.com/ardhi/bajo-config|bajo-config}
-     * lets you to use ```.yaml/.yml``` and ```.toml```.
+     * By default, there are two built-in handlers available: ```.js```, ```.json```
+     * and ```.yml/.yaml```. Use plugins to add more, e.g {@link https://github.com/ardhi/bajo-config|bajo-config}
+     * lets you to use ```.toml```.
      *
      * @type {TAppConfigHandler[]}
      */

package/class/bajo.js

@@ -4,15 +4,14 @@ import increment from 'add-filename-increment'
 import fs from 'fs-extra'
 import path from 'path'
 import os from 'os'
-import emptyDir from 'empty-dir'
 import lodash from 'lodash'
 import { createRequire } from 'module'
-import getGlobalPath from 'get-global-path'
 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 * as yaml from 'js-yaml'
 import aneka from 'aneka'
 import {
   buildBaseConfig,
@@ -30,10 +29,10 @@ const {
   isFunction, map, isObject,
   trim, filter, isEmpty, orderBy, pullAt, find, camelCase,
   cloneDeep, isPlainObject, isArray, isString, omit, keys, indexOf,
-  last, get, has, values, dropRight, pick
+  last, get, has, values, pick
 } = lodash
 
-const { resolvePath } = aneka
+const { resolvePath, getGlobalModuleDir } = aneka
 
 /**
  * Name based ```{ns}:{path}``` format.
@@ -78,7 +77,9 @@ class Bajo extends Plugin {
     // 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: '.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 }
     ]
 
     this.hooks = []
@@ -499,34 +500,6 @@ class Bajo extends Plugin {
     return value
   }
 
-  /**
-   * Get NPM global module directory.
-   *
-   * @method
-   * @param {string} [pkgName] - If provided, return this package global directory. Otherwise the npm global module directory.
-   * @param {boolean} [silent=true] - Set to ```false``` to throw exception in case of error. Otherwise silently returns undefined.
-   * @returns {string}
-   */
-  getGlobalModuleDir = (pkgName, silent = true) => {
-    let nodeModulesDir = process.env.BAJO_GLOBAL_MODULE_DIR
-    if (!nodeModulesDir) {
-      const npmPath = getGlobalPath('npm')
-      if (!npmPath) {
-        if (silent) return
-        throw this.error('cantLocateNpmGlobalDir', { code: 'BAJO_CANT_LOCATE_NPM_GLOBAL_DIR' })
-      }
-      nodeModulesDir = dropRight(resolvePath(npmPath).split('/'), 1).join('/')
-      process.env.BAJO_GLOBAL_MODULE_DIR = nodeModulesDir
-    }
-    if (!pkgName) return nodeModulesDir
-    const dir = `${nodeModulesDir}/${pkgName}`
-    if (!fs.existsSync(dir)) {
-      if (silent) return
-      throw this.error('cantLocateGlobalDir%s', pkgName, { code: 'BAJO_CANT_LOCATE_MODULE_GLOBAL_DIR' })
-    }
-    return dir
-  }
-
   /**
    * Get class method by name.
    *
@@ -543,22 +516,21 @@ class Bajo extends Plugin {
   }
 
   /**
-   * Get module directory, locally and globally.
+   * Get module directory.
    *
    * @method
    * @param {string} pkgName - Package name to find.
-   * @param {string} base - Provide base name if ```pkgName``` is a module under ```base```'s package name.
+   * @param {boolean} [withGlobalDir=true] - Whether to include the global module directory.
    * @returns {string} Return absolute package directory.
    */
-  getModuleDir = (pkgName, base) => {
+  getModuleDir = (pkgName, base, withGlobalDir = true) => {
     const { findDeep } = this.app.lib
     if (pkgName === 'main') return resolvePath(this.app.dir)
     if (base === 'main') base = this.app.dir
     else if (this && this.app && this.app[base]) base = this.app[base].pkgName
     const pkgPath = pkgName + '/package.json'
     const paths = require.resolve.paths(pkgPath)
-    const gdir = this.getGlobalModuleDir()
-    paths.unshift(gdir)
+    if (withGlobalDir) paths.push(getGlobalModuleDir())
     paths.unshift(resolvePath(path.join(this.app.dir, 'node_modules')))
     let dir = findDeep(pkgPath, paths)
     if (base && !dir) dir = findDeep(`${base}/node_modules/${pkgPath}`, paths)
@@ -643,21 +615,6 @@ class Bajo extends Plugin {
     return values(result)
   }
 
-  /**
-   * Check whether a directory is empty or not. More info please {@link https://github.com/gulpjs/empty-dir|check here}.
-   *
-   * @method
-   * @async
-   * @param {(string|TNsPathPairs)} dir - Directory to check.
-   * @param {function} filterFn - Filter function to filter out files that cause false positives.
-   * @returns {boolean}
-   */
-  isEmptyDir = async (dir, filterFn) => {
-    dir = resolvePath(this.app.getPluginFile(dir))
-    await fs.exists(dir)
-    return await emptyDir(dir, filterFn)
-  }
-
   /**
    * Check whether log level is within log's app current level.
    *
@@ -750,7 +707,7 @@ class Bajo extends Plugin {
   }
 
   /**
-   * Read and parse file as config object. Supported types: ```.js``` and ```.json```.
+   * 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
@@ -925,6 +882,32 @@ class Bajo extends Plugin {
     return JSON.parse(content)
   }
 
+  /**
+   * Parse YAML text
+   *
+   * @method
+   * @param {string} text - Text to be parsed
+   * @param {object} options - Options object
+   * @returns {object} Parsed object
+   */
+  fromYaml = (text, options = {}) => {
+    const { fs } = this.app.lib
+    const content = options.readFromFile ? fs.readFileSync(text, 'utf8') : text
+    return yaml.load(content)
+  }
+
+  /**
+   * Parse YML text. Alias for fromYaml.
+   *
+   * @method
+   * @param {string} text - Text to be parsed
+   * @param {object} options - Options object
+   * @returns {object} Parsed object
+   */
+  fromYml = (text, options = {}) => {
+    return this.fromYaml(text, options)
+  }
+
   /**
    * Convert data to JSON string.
    *
@@ -944,6 +927,37 @@ class Bajo extends Plugin {
     return content
   }
 
+  /**
+   * Convert object to YAML string
+   *
+   * @method
+   * @param {object} object - Object to be converted
+   * @param {object} options - Options object
+   * @returns {string} YAML string
+   */
+  toYaml = (object, options = {}) => {
+    const { omit } = this.app.lib._
+    const { fs } = this.app.lib
+    const content = yaml.dump(object, omit(options, ['writeToFile']))
+    if (options.writeToFile) {
+      fs.writeFileSync(options.saveAsFile, content, 'utf8')
+      return
+    }
+    return content
+  }
+
+  /**
+   * Convert object to YML string. Alias for toYaml.
+   *
+   * @method
+   * @param {object} object - Object to be converted
+   * @param {object} options - Options object
+   * @returns {string} YML string
+   */
+  toYml = (object, options = {}) => {
+    return this.toYaml(object, options)
+  }
+
   /**
    * Read all config files from path.
    *

package/docs/App.html

@@ -16,9 +16,9 @@ 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">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#line199">line 199</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li>module:Lib.parseArgsArgv</li></ul></dd></div></dl><h3 class="name has-anchor" id="baseClass"><span class="type-signature"></span>baseClass<span class="type-signature"></span></h3><div class="description"><p>All plugin's base class are saved here as key-value pairs with plugin name as its key. The special key <code>Base</code> &amp;&amp; <code>Tools</code> is for <a href="Base.html">Base</a> &amp; <a href="Tools.html">Tools</a> class so anytime you want to create your own plugin, just use something like this:</p><pre class="prettyprint source lang-javascript"><code>class MyPlugin extends this.app.baseClass.Base {
   ... your class
-}</code></pre></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#line150">line 150</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="boxen"><span class="type-signature"></span>boxen<span class="type-signature"></span></h3><div class="description"><p>Placeholder for boxen that will get imported from <code>bajoCli</code> later during boot process.</p></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#line224">line 224</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="global.html#TAppConfigHandler">TAppConfigHandler</a>></span></h3><div class="description"><p>Config handlers.</p><p>By default, there are two built-in handlers available: <code>.js</code> and <code>.json</code>. Use plugins to add more, e.g <a href="https://github.com/ardhi/bajo-config">bajo-config</a> lets you to use <code>.yaml/.yml</code> and <code>.toml</code>.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Array.&lt;<a href="global.html#TAppConfigHandler">TAppConfigHandler</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#line115">line 115</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>Environment variables. Support dotenv (<code>.env</code>) file too!</p><ul><li>Underscore (<code>_</code>) translates key to camel-cased one</li><li>Double underscores (<code>__</code>) breaks the key into object keys</li><li>While dot (<code>.</code>) is used as namespace separator. If no namespace found, it is saved under <code>_</code> key.</li></ul><p>Values are also parsed automatically 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></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#line219">line 219</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li>module:Lib.parseEnv</li></ul></dd></div></dl><h3 class="name has-anchor" id="getConfigFormats"><span class="type-signature"></span>getConfigFormats<span class="type-signature"></span></h3><div class="description"><p>Helper method to list all supported config formats.</p></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#line567">line 567</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="lib"><span class="type-signature"></span>lib<span class="type-signature"> :TAppLib</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><p>Example:</p><pre class="prettyprint source lang-javascript"><code>const { camelCase, kebabCase } = this.app.lib._
+}</code></pre></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#line150">line 150</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="boxen"><span class="type-signature"></span>boxen<span class="type-signature"></span></h3><div class="description"><p>Placeholder for boxen that will get imported from <code>bajoCli</code> later during boot process.</p></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#line224">line 224</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="global.html#TAppConfigHandler">TAppConfigHandler</a>></span></h3><div class="description"><p>Config handlers.</p><p>By default, there are two built-in handlers available: <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></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Array.&lt;<a href="global.html#TAppConfigHandler">TAppConfigHandler</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#line115">line 115</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>Environment variables. Support dotenv (<code>.env</code>) file too!</p><ul><li>Underscore (<code>_</code>) translates key to camel-cased one</li><li>Double underscores (<code>__</code>) breaks the key into object keys</li><li>While dot (<code>.</code>) is used as namespace separator. If no namespace found, it is saved under <code>_</code> key.</li></ul><p>Values are also parsed automatically 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></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#line219">line 219</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li>module:Lib.parseEnv</li></ul></dd></div></dl><h3 class="name has-anchor" id="lib"><span class="type-signature"></span>lib<span class="type-signature"> :TAppLib</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><p>Example:</p><pre class="prettyprint source lang-javascript"><code>const { camelCase, kebabCase } = this.app.lib._
 console.log(camelCase('Elit commodo sit et aliqua'))
-</code></pre></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">TAppLib</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#line129">line 129</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="log"><span class="type-signature"></span>log<span class="type-signature"> :<a href="Log.html">Log</a></span></h3><div class="description"><p>Instance of system log.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type"><a href="Log.html">Log</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#line138">line 138</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="options"><span class="type-signature"></span>options<span class="type-signature"> :Object</span></h3><div class="description"><p>Copy of provided options.</p></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#line58">line 58</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="pluginPkgs"><span class="type-signature"></span>pluginPkgs<span class="type-signature"> :Array</span></h3><div class="description"><p>Plugin's package names container. This is the list of plugins to load. It is read from <code>package.json</code> and <code>.plugins</code> file by default, but you can override it by providing <code>options.plugins</code> at constructor.</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#line96">line 96</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="runAt"><span class="type-signature"></span>runAt<span class="type-signature"> :Date</span></h3><div class="description"><p>Date/time when your app start.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Date</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#line82">line 82</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="startPlugin"><span class="type-signature"></span>startPlugin<span class="type-signature"></span></h3><div class="description"><p>Start a plugin.</p></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#line577">line 577</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="stopPlugin"><span class="type-signature"></span>stopPlugin<span class="type-signature"></span></h3><div class="description"><p>Stop a plugin.</p></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#line587">line 587</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".this.envs"><span class="type-signature">(static, constant) </span>this.envs<span class="type-signature"> :<a href="global.html#TAppEnv">TAppEnv</a></span></h3><div class="description"><p>App environments.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type"><a href="global.html#TAppEnv">TAppEnv</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#line75">line 75</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".this.mainNs"><span class="type-signature">(static, constant) </span>this.mainNs<span class="type-signature"> :string</span></h3><div class="description"><p>Your main namespace. And yes, you suppose to NOT CHANGE this.</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-default bold">Default Value</dt><dd class="tag-default"><ul><li data-skip-pre-process="true">'main'</li></ul></dd></div><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#line67">line 67</a></li></ul></dd></div></dl><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id="addPlugin"><span class="type-signature"></span>addPlugin<span class="signature">(plugin, baseClass<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Add and save plugin and it's base class definition (if provided).</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 class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>plugin</code></td><td class="type"><span class="param-type">TPlugin</span></td><td class="attributes"></td><td class="description last"><p>A valid bajo plugin.</p></td></tr><tr><td class="name"><code>baseClass</code></td><td class="type"><span class="param-type">Object</span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>Base class definition.</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#line245">line 245</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="boot"><span class="type-signature">(async) </span>boot<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="App.html">App</a>}</span></h3><div class="description"><p>Boot process:</p><ul><li>Parsing program arguments, options and environment values</li><li>Create <a href="Bajo.html">Bajo</a> instance &amp; initialize it</li><li>Run in applet mode if <code>-a</code> or <code>--applet</code> is given</li></ul><p>After boot process is completed, event <code>bajo:afterBootCompleted</code> is emitted.</p><p>If app mode is <code>applet</code>, it runs your choosen applet instead.</p></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#line409">line 409</a></li></ul></dd></div></dl><div class="method-member-container flex w-100 overflow-auto mt-20"><strong>Fires:</strong><ul><li>bajo:afterBootCompleted</li></ul></div><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type"><a href="App.html">App</a></span></dd></dl></div><h3 class="name has-anchor" id="dump"><span class="type-signature"></span>dump<span class="signature">(&hellip;args)</span></h3><div class="description"><p>Dumping variable on screen. Like <code>console.log</code> with configurable options. Useful for quick debugging and testing. You can also use it to dump variables in production without worrying about performance because it is using Bajo's built-in cache to store the result of util's inspect, so it will only be processed once for each unique variable.</p><p>Any argument passed to this method will be displayed on screen. If the last argument is a boolean <code>true</code>, app will quit rightaway after dumping.</p><p>If you have <code>bajoCli</code> plugin installed, variables will be displayed in a nice box using <code>boxen</code> package. Otherwise, it will fallback to <code>console.log</code> with util's inspect result.</p><p>To have more control on how the variable is displayed, you can set options in Bajo's config under <code>dump</code> key. See <a href="Bajo.html#config">Bajo#config</a> for details.</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 class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>args</code></td><td class="type"><span class="param-type">any</span></td><td class="attributes">&lt;repeatable><br></td><td class="description last"><p>Variables to dump.</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#line373">line 373</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="exit"><span class="type-signature"></span>exit<span class="signature">(signal<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Terminate the app and back to console.</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>signal</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes">&lt;optional><br></td><td class="default">SIGINT</td><td class="description last"><p>Signal to send.</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#line455">line 455</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="getAllNs"><span class="type-signature"></span>getAllNs<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h3><div class="description"><p>Get all loaded plugin namespaces.</p></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#line257">line 257</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">Array.&lt;string></span></dd></dl></div><h3 class="name has-anchor" id="getAllPlugins"><span class="type-signature"></span>getAllPlugins<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;TPlugin>}</span></h3><div class="description"><p>Get all plugins loaded plugins.</p></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#line279">line 279</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">Array.&lt;TPlugin></span></dd></dl></div><h3 class="name has-anchor" id="getPlugin"><span class="type-signature"></span>getPlugin<span class="signature">(name, silent<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Object}</span></h3><div class="description"><p>Get plugin by its namespace.</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 class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>name</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="description last"><p>Plugin name/namespace or alias.</p></td></tr><tr><td class="name"><code>silent</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>If <code>true</code>, silently return undefined even on error.</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#line291">line 291</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Plugin object.</p></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">Object</span></dd></dl></div><h3 class="name has-anchor" id="getPluginDataDir"><span class="type-signature"></span>getPluginDataDir<span class="signature">(name, ensureDir<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {string}</span></h3><div class="description"><p>Get plugin data directory</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>name</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Plugin name (namespace) or alias.</p></td></tr><tr><td class="name"><code>ensureDir</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes">&lt;optional><br></td><td class="default">true</td><td class="description last"><p>Set <code>true</code> (default) to ensure directory is existed.</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#line319">line 319</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="getPluginFile"><span class="type-signature"></span>getPluginFile<span class="signature">(file)</span><span class="type-signature"> &rarr; {string}</span></h3><div class="description"><p>Resolve file path from:</p><ul><li>local/absolute file</li><li>TNsPath (<code>myPlugin:/path/to/file.txt</code>)</li><li>file under node_modules, e.g. <code>myPlugin:node_modules/some-package/file.txt</code></li></ul></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>file</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>File path, see above for supported types.</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#line338">line 338</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Resolved file path.</p></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="getPlugins"><span class="type-signature"></span>getPlugins<span class="signature">(nss<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;TPlugin>}</span></h3><div class="description"><p>Get loaded plugins.</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 class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>nss</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 namespaces. If empty, it returns all loaded plugins.</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#line268">line 268</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">Array.&lt;TPlugin></span></dd></dl></div><h3 class="name has-anchor" id="loadIntl"><span class="type-signature"></span>loadIntl<span class="signature">(ns)</span></h3><div class="description"><p>Load internationalization &amp; languages files for particular plugin.</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>Plugin name.</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#line466">line 466</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="t"><span class="type-signature"></span>t<span class="signature">(ns, text, &hellip;params)</span><span class="type-signature"> &rarr; {string}</span></h3><div class="description"><p>Translate text and interpolate with given <code>args</code>.</p><p>There is a shortcut to this method attached on all plugins. You'll normally call that shorcut instead of this method, because it is bound to plugin's name already</p><pre class="prettyprint source lang-javascript"><code>... within your main plugin
+</code></pre></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">TAppLib</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#line129">line 129</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="log"><span class="type-signature"></span>log<span class="type-signature"> :<a href="Log.html">Log</a></span></h3><div class="description"><p>Instance of system log.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type"><a href="Log.html">Log</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#line138">line 138</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="options"><span class="type-signature"></span>options<span class="type-signature"> :Object</span></h3><div class="description"><p>Copy of provided options.</p></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#line58">line 58</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="pluginPkgs"><span class="type-signature"></span>pluginPkgs<span class="type-signature"> :Array</span></h3><div class="description"><p>Plugin's package names container. This is the list of plugins to load. It is read from <code>package.json</code> and <code>.plugins</code> file by default, but you can override it by providing <code>options.plugins</code> at constructor.</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#line96">line 96</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="runAt"><span class="type-signature"></span>runAt<span class="type-signature"> :Date</span></h3><div class="description"><p>Date/time when your app start.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Date</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#line82">line 82</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="startPlugin"><span class="type-signature"></span>startPlugin<span class="type-signature"></span></h3><div class="description"><p>Start a plugin.</p></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#line580">line 580</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="stopPlugin"><span class="type-signature"></span>stopPlugin<span class="type-signature"></span></h3><div class="description"><p>Stop a plugin.</p></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#line590">line 590</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".this.envs"><span class="type-signature">(static, constant) </span>this.envs<span class="type-signature"> :<a href="global.html#TAppEnv">TAppEnv</a></span></h3><div class="description"><p>App environments.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type"><a href="global.html#TAppEnv">TAppEnv</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#line75">line 75</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".this.mainNs"><span class="type-signature">(static, constant) </span>this.mainNs<span class="type-signature"> :string</span></h3><div class="description"><p>Your main namespace. And yes, you suppose to NOT CHANGE this.</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-default bold">Default Value</dt><dd class="tag-default"><ul><li data-skip-pre-process="true">'main'</li></ul></dd></div><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#line67">line 67</a></li></ul></dd></div></dl><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id="addPlugin"><span class="type-signature"></span>addPlugin<span class="signature">(plugin, baseClass<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Add and save plugin and it's base class definition (if provided).</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 class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>plugin</code></td><td class="type"><span class="param-type">TPlugin</span></td><td class="attributes"></td><td class="description last"><p>A valid bajo plugin.</p></td></tr><tr><td class="name"><code>baseClass</code></td><td class="type"><span class="param-type">Object</span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>Base class definition.</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#line245">line 245</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="boot"><span class="type-signature">(async) </span>boot<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="App.html">App</a>}</span></h3><div class="description"><p>Boot process:</p><ul><li>Parsing program arguments, options and environment values</li><li>Create <a href="Bajo.html">Bajo</a> instance &amp; initialize it</li><li>Run in applet mode if <code>-a</code> or <code>--applet</code> is given</li></ul><p>After boot process is completed, event <code>bajo:afterBootCompleted</code> is emitted.</p><p>If app mode is <code>applet</code>, it runs your choosen applet instead.</p></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#line409">line 409</a></li></ul></dd></div></dl><div class="method-member-container flex w-100 overflow-auto mt-20"><strong>Fires:</strong><ul><li>bajo:afterBootCompleted</li></ul></div><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type"><a href="App.html">App</a></span></dd></dl></div><h3 class="name has-anchor" id="dump"><span class="type-signature"></span>dump<span class="signature">(&hellip;args)</span></h3><div class="description"><p>Dumping variable on screen. Like <code>console.log</code> with configurable options. Useful for quick debugging and testing. You can also use it to dump variables in production without worrying about performance because it is using Bajo's built-in cache to store the result of util's inspect, so it will only be processed once for each unique variable.</p><p>Any argument passed to this method will be displayed on screen. If the last argument is a boolean <code>true</code>, app will quit rightaway after dumping.</p><p>If you have <code>bajoCli</code> plugin installed, variables will be displayed in a nice box using <code>boxen</code> package. Otherwise, it will fallback to <code>console.log</code> with util's inspect result.</p><p>To have more control on how the variable is displayed, you can set options in Bajo's config under <code>dump</code> key. See <a href="Bajo.html#config">Bajo#config</a> for details.</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 class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>args</code></td><td class="type"><span class="param-type">any</span></td><td class="attributes">&lt;repeatable><br></td><td class="description last"><p>Variables to dump.</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#line373">line 373</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="exit"><span class="type-signature"></span>exit<span class="signature">(signal<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Terminate the app and back to console.</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>signal</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes">&lt;optional><br></td><td class="default">SIGINT</td><td class="description last"><p>Signal to send.</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#line455">line 455</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="getAllNs"><span class="type-signature"></span>getAllNs<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h3><div class="description"><p>Get all loaded plugin namespaces.</p></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#line257">line 257</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">Array.&lt;string></span></dd></dl></div><h3 class="name has-anchor" id="getAllPlugins"><span class="type-signature"></span>getAllPlugins<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;TPlugin>}</span></h3><div class="description"><p>Get all plugins loaded plugins.</p></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#line279">line 279</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">Array.&lt;TPlugin></span></dd></dl></div><h3 class="name has-anchor" id="getConfigFormats"><span class="type-signature"></span>getConfigFormats<span class="signature">(noDot<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h3><div class="description"><p>Helper method to list all supported config formats.</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 class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>noDot</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>If <code>true</code>, it will return the list without dot prefix.</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#line569">line 569</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">Array.&lt;string></span></dd></dl></div><h3 class="name has-anchor" id="getPlugin"><span class="type-signature"></span>getPlugin<span class="signature">(name, silent<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Object}</span></h3><div class="description"><p>Get plugin by its namespace.</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 class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>name</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="description last"><p>Plugin name/namespace or alias.</p></td></tr><tr><td class="name"><code>silent</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>If <code>true</code>, silently return undefined even on error.</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#line291">line 291</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Plugin object.</p></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">Object</span></dd></dl></div><h3 class="name has-anchor" id="getPluginDataDir"><span class="type-signature"></span>getPluginDataDir<span class="signature">(name, ensureDir<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {string}</span></h3><div class="description"><p>Get plugin data directory</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>name</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Plugin name (namespace) or alias.</p></td></tr><tr><td class="name"><code>ensureDir</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes">&lt;optional><br></td><td class="default">true</td><td class="description last"><p>Set <code>true</code> (default) to ensure directory is existed.</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#line319">line 319</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="getPluginFile"><span class="type-signature"></span>getPluginFile<span class="signature">(file)</span><span class="type-signature"> &rarr; {string}</span></h3><div class="description"><p>Resolve file path from:</p><ul><li>local/absolute file</li><li>TNsPath (<code>myPlugin:/path/to/file.txt</code>)</li><li>file under node_modules, e.g. <code>myPlugin:node_modules/some-package/file.txt</code></li></ul></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>file</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>File path, see above for supported types.</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#line338">line 338</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Resolved file path.</p></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="getPlugins"><span class="type-signature"></span>getPlugins<span class="signature">(nss<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;TPlugin>}</span></h3><div class="description"><p>Get loaded plugins.</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 class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>nss</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 namespaces. If empty, it returns all loaded plugins.</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#line268">line 268</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">Array.&lt;TPlugin></span></dd></dl></div><h3 class="name has-anchor" id="loadIntl"><span class="type-signature"></span>loadIntl<span class="signature">(ns)</span></h3><div class="description"><p>Load internationalization &amp; languages files for particular plugin.</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>Plugin name.</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#line466">line 466</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="t"><span class="type-signature"></span>t<span class="signature">(ns, text, &hellip;params)</span><span class="type-signature"> &rarr; {string}</span></h3><div class="description"><p>Translate text and interpolate with given <code>args</code>.</p><p>There is a shortcut to this method attached on all plugins. You'll normally call that shorcut instead of this method, because it is bound to plugin's name already</p><pre class="prettyprint source lang-javascript"><code>... within your main plugin
 const translated = this.app.t('main', 'My cute cat is %s', 'purring')
 // or
 const translated = this.t('My cute cat is %s', 'purring')