bajo 1.2.8 → 2.0.0

package/class/helper/plugin.js

@@ -0,0 +1,169 @@
+import createMethod from '../../lib/create-method.js'
+import semver from 'semver'
+import lodash from 'lodash'
+
+const {
+  merge,
+  forOwn,
+  groupBy,
+  find,
+  reduce,
+  map,
+  trim,
+  keys,
+  intersection,
+  each,
+  camelCase,
+  get
+} = lodash
+
+/**
+ * @module
+ */
+
+/**
+ * Scan plugins ```method``` directories, and turn + attach its found files as methods dynamically.
+ *
+ * @async
+ */
+export async function attachMethods () {
+  const { eachPlugins } = this.bajo
+  const me = this // the app
+  me.bajo.log.debug('attachMethods')
+  await eachPlugins(async function () {
+    const { name: ns, pkgName } = this
+    const dir = ns === me.bajo.mainNs ? (`${me.bajo.dir.base}/${me.bajo.mainNs}`) : me.bajo.getModuleDir(pkgName)
+    const num = await createMethod.call(me[ns], `${dir}/method`, pkgName)
+    me.bajo.log.trace('- %s (%d)', ns, num)
+  })
+}
+
+/**
+ * Build configurations
+ *
+ * @async
+ */
+export async function buildConfigs () {
+  this.bajo.log.debug('readConfigs')
+  for (const pkg of this.bajo.pluginPkgs) {
+    const plugin = this[camelCase(pkg)]
+    await plugin.loadConfig()
+    plugin.initPrint()
+    plugin.initLog()
+  }
+}
+
+/**
+ * Ensure for names and aliases to be unique and no clashes with other plugins
+ *
+ * @async
+ */
+export async function checkNameAliases () {
+  const { eachPlugins } = this.bajo
+  this.bajo.log.debug('checkAliasNameClash')
+  const refs = []
+  await eachPlugins(async function () {
+    const { name: ns, pkgName, alias } = this
+    let item = find(refs, { ns })
+    if (item) throw this.error('pluginNameClash%s%s%s%s', ns, pkgName, item.ns, item.pkgName, { code: 'BAJO_NAME_CLASH' })
+    item = find(refs, { alias })
+    if (item) throw this.error('pluginNameClash%s%s%s%s', alias, pkgName, item.alias, item.pkgName, { code: 'BAJO_ALIAS_CLASH' })
+    refs.push({ ns, alias, pkgName })
+  })
+}
+
+/**
+ * Ensure dependencies are met
+ *
+ * @async
+ */
+export async function checkDependencies () {
+  async function runner () {
+    const { name: ns, pkgName } = this
+    const { join } = this.app.bajo
+    this.app.bajo.log.trace('- %s', ns)
+    const odep = reduce(this.dependencies, (o, k) => {
+      const item = map(k.split('@'), m => trim(m))
+      if (k[0] === '@') o['@' + item[1]] = item[2]
+      else o[item[0]] = item[1]
+      return o
+    }, {})
+    const deps = keys(odep)
+    if (deps.length > 0) {
+      if (intersection(this.app.bajo.pluginPkgs, deps).length !== deps.length) {
+        throw this.error('dependencyUnfulfilled%s%s', pkgName, join(deps), { code: 'BAJO_DEPENDENCY' })
+      }
+      each(deps, d => {
+        if (!odep[d]) return
+        const ver = get(this.app[camelCase(d)], 'config.pkg.version')
+        if (!ver) return
+        if (!semver.satisfies(ver, odep[d])) {
+          throw this.error('semverCheckFailed%s%s', pkgName, `${d}@${odep[d]}`, { code: 'BAJO_DEPENDENCY_SEMVER' })
+        }
+      })
+    }
+  }
+
+  const { eachPlugins } = this.bajo
+  this.bajo.log.debug('checkDeps')
+  await eachPlugins(async function () {
+    await runner.call(this)
+  })
+}
+
+/**
+ * Collect and build hooks and push them to the bajo's hook system
+ *
+ * @async
+ */
+export async function collectHooks () {
+  const { eachPlugins, runHook, isLogInRange, importModule, breakNsPathFromFile } = this.bajo
+  const me = this
+  me.bajo.hooks = this.bajo.hooks ?? []
+  me.bajo.log.debug('collectHooks')
+  // collects
+  await eachPlugins(async function ({ dir, file }) {
+    const { name: ns } = this
+    const { fullNs, path } = breakNsPathFromFile({ file, dir, baseNs: ns, suffix: '/hook/' })
+    const mod = await importModule(file, { asHandler: true })
+    if (!mod) return undefined
+    merge(mod, { ns: fullNs, path, src: ns })
+    me.bajo.hooks.push(mod)
+  }, { glob: 'hook/**/*.js', prefix: me.bajo.name })
+  // for log trace purpose only
+  if (!isLogInRange('trace')) return
+  const items = groupBy(me.bajo.hooks, 'ns')
+  forOwn(items, (v, k) => {
+    const hooks = groupBy(v, 'path')
+    forOwn(hooks, (v1, k1) => {
+      me.bajo.log.trace('- %s:%s (%d)', k, k1, v1.length)
+    })
+  })
+  // run handler
+  await runHook('bajo:afterCollectHooks')
+}
+
+/**
+ * Finally, run all plugins
+ *
+ * @async
+ */
+export async function run () {
+  const me = this
+  const { runHook, eachPlugins, join } = me.bajo
+  const { freeze } = me.bajo
+  const methods = ['init']
+  if (!me.bajo.applet) methods.push('start')
+  for (const method of methods) {
+    await runHook(`bajo:${camelCase(`before ${method} all plugins`)}`)
+    await eachPlugins(async function () {
+      const { name: ns } = this
+      if (method === 'start') freeze(me[ns].config)
+      await runHook(`${ns}:${camelCase(`before ${method}`)}`)
+      await me[ns][method]()
+      await runHook(`${ns}:${camelCase(`after ${method}`)}`)
+    })
+    await runHook(`bajo:${camelCase(`after ${method} all plugins`)}`)
+  }
+  me.bajo.log.debug('loadedPlugins%s', join(map(me.bajo.pluginPkgs, b => camelCase(b))))
+}

package/{boot/class/bajo-plugin.js → class/plugin.js}

@@ -1,16 +1,50 @@
-import Plugin from './plugin.js'
+import BasePlugin from './base/plugin.js'
 import lodash from 'lodash'
 import omittedPluginKeys from '../lib/omitted-plugin-keys.js'
 import readAllConfigs from '../lib/read-all-configs.js'
 
 const { pick, omit } = lodash
 
-class BajoPlugin extends Plugin {
+/**
+ * This is the class that your own plugin suppose to extend. Don't use {@link BasePlugin}
+ * unless you know what you're doing.
+ *
+ * @class
+ */
+
+class Plugin extends BasePlugin {
+  /**
+   * @param {string} pkgName - Package name (the one you use in package.json)
+   * @param {Object} app - App instance reference. Usefull to call app method inside a plugin
+   */
   constructor (pkgName, app) {
     super(pkgName, app)
+    /**
+     * Plugin alias. Derived plugin must provide its own, unique alias. If it left blank,
+     * Bajo will provide this automatically
+     *
+     * @type {string}
+     */
+    this.alias = ''
+
+    /**
+     * Dependencies to other plugins. Enter all plugin's package name your plugin dependent from.
+     *
+     * Semver is also supported.
+     *
+     * @type {Array}
+     */
+    this.dependencies = []
     this.state = {}
   }
 
+  /**
+   * Load config from file in data directory, program arguments and environment variables. Level of importance:
+   * ```Env Variables > Program Arguments > Config File```
+   *
+   * @method
+   * @async
+   */
   loadConfig = async () => {
     const { defaultsDeep } = this.lib.aneka
     const { get } = this.lib._
@@ -48,14 +82,37 @@ class BajoPlugin extends Plugin {
     this.config = parseObject(cfg, { parseValue: true })
   }
 
+  /**
+   * After config is read, plugin will be initialized. You can still change your config here,
+   * because after plugin is initialized, config will be deep frozen.
+   *
+   * @method
+   * @async
+   */
   init = async () => {
   }
 
+  /**
+   * This method will be called after plugin's init
+   *
+   * @method
+   * @async
+   */
   start = async () => {
   }
 
   stop = async () => {
   }
+
+  /**
+   * Upon app termination, this method will be called first. Mostly useful for system cleanup,
+   * delete temporary files, freeing resources etc.
+   *
+   * @method
+   * @async
+   */
+  exit = async () => {
+  }
 }
 
-export default BajoPlugin
+export default Plugin

package/docs/App.html

@@ -0,0 +1,3 @@
+<!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 Framework</a><div class="sidebar-items-container"><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-class_helper_bajo.html">class/helper/bajo</a></div><div class="sidebar-section-children"><a href="module-class_helper_plugin.html">class/helper/plugin</a></div><div class="sidebar-section-children"><a href="module-lib_create-method.html">lib/create-method</a></div><div class="sidebar-section-children"><a href="module-lib_formats.html">lib/formats</a></div><div class="sidebar-section-children"><a href="module-lib_log-levels.html">lib/log-levels</a></div><div class="sidebar-section-children"><a href="module-lib_resolve-path.html">lib/resolve-path</a></div><div class="sidebar-section-children"><a href="module-lib_shim.html">lib/shim</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="BasePlugin.html">BasePlugin</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><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-contribution.html">Contribution</a></div><div class="sidebar-section-children"><a href="tutorial-ecosystem.html">Ecosystem</a></div><div class="sidebar-section-children"><a href="tutorial-getting-started.html">Getting Started</a></div><div class="sidebar-section-children"><a href="tutorial-plugin-dev.html">Plugin Development</a></div><div class="sidebar-section-children"><a href="tutorial-user-guide.html">User Guide</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#NsPathType">NsPathType</a></div><div class="sidebar-section-children"><a href="global.html#ObjectFormatType">ObjectFormatType</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://bajo.app" target="">Bajo.app</a></div><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><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 where everything starts, the boot process:</p><ol><li>Parsing all arguments and environment values</li><li>Create <a href="Bajo.html">Bajo</a> instance</li><li>Building <a href="module-class_helper_bajo.html#.buildBaseConfig">base config</a></li><li><a href="module-class_helper_bajo.html#.buildPlugins">Building plugins</a></li><li>Collect all <a href="module-class_helper_bajo.html#.collectConfigHandlers">config handler</a></li><li>Building <a href="module-class_helper_bajo.html#.buildExtConfig">extra config</a></li><li>Setup <a href="module-class_helper_bajo.html#.bootOrder">boot order</a></li><li><a href="module-class_helper_bajo.html#.bootPlugins">Boot loaded plugins</a></li><li>Attach <a href="module-class_helper_bajo.html#.exitHandler">exit handlers</a></li><li>Finish</li></ol><p>After boot process is completed, event <code>bajo:afterBootComplete</code> is emitted.</p><p>If app mode is <code>applet</code>, it runs your choosen applet instead.</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">(cwd)</span></h3><div class="description"><p>Class 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 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="description last"><p>Current working dirctory</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#line40">line 40</a></li></ul></dd></div></dl></div><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)</span></h3><div class="description"><p>Add a plugin to the app</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>plugin</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>A valid bajo plugin</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#line63">line 63</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="boot"><span class="type-signature">(async) </span>boot<span class="signature">()</span></h3><div class="description"><p>Booting the app</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#line90">line 90</a></li></ul></dd></div></dl><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</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>any arguments passed will be displayed on screen. If the last argument is a boolean 'true', app will quit rightaway</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#line74">line 74</a></li></ul></dd></div></dl></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">Bajo Framework</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://bajo.app" target="">Bajo.app</a></div><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><div class="mobile-sidebar-items-c"><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-class_helper_bajo.html">class/helper/bajo</a></div><div class="sidebar-section-children"><a href="module-class_helper_plugin.html">class/helper/plugin</a></div><div class="sidebar-section-children"><a href="module-lib_create-method.html">lib/create-method</a></div><div class="sidebar-section-children"><a href="module-lib_formats.html">lib/formats</a></div><div class="sidebar-section-children"><a href="module-lib_log-levels.html">lib/log-levels</a></div><div class="sidebar-section-children"><a href="module-lib_resolve-path.html">lib/resolve-path</a></div><div class="sidebar-section-children"><a href="module-lib_shim.html">lib/shim</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="BasePlugin.html">BasePlugin</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><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-contribution.html">Contribution</a></div><div class="sidebar-section-children"><a href="tutorial-ecosystem.html">Ecosystem</a></div><div class="sidebar-section-children"><a href="tutorial-getting-started.html">Getting Started</a></div><div class="sidebar-section-children"><a href="tutorial-plugin-dev.html">Plugin Development</a></div><div class="sidebar-section-children"><a href="tutorial-user-guide.html">User Guide</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#NsPathType">NsPathType</a></div><div class="sidebar-section-children"><a href="global.html#ObjectFormatType">ObjectFormatType</a></div></div></div><div class="mobile-navbar-actions"><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></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>