npm - bajo - Versions diffs - 2.0.1 → 2.1.0 - Mend

bajo 2.0.1 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (101) hide show

package/.github/FUNDING.yml +13 -0
package/.github/workflows/repo-lockdown.yml +24 -0
package/.jsdoc.conf.json +7 -6
package/LICENSE +1 -1
package/README.md +50 -18
package/class/app.js +378 -54
package/class/bajo.js +228 -149
package/class/base.js +106 -0
package/class/helper/bajo.js +146 -90
package/class/helper/{plugin.js → base.js} +96 -22
package/class/{base → misc}/err.js +44 -14
package/class/misc/log.js +255 -0
package/class/misc/print.js +264 -0
package/class/plugin.js +120 -68
package/docs/App.html +23 -1
package/docs/Bajo.html +2 -9
package/docs/Base.html +3 -0
package/docs/Err.html +3 -1
package/docs/Log.html +5 -1
package/docs/Plugin.html +1 -1
package/docs/Print.html +1 -1
package/docs/class_app.js.html +378 -56
package/docs/class_bajo.js.html +230 -151
package/docs/class_base.js.html +109 -0
package/docs/class_helper_bajo.js.html +138 -87
package/docs/class_helper_base.js.html +246 -0
package/docs/class_misc_err.js.html +129 -0
package/docs/class_misc_log.js.html +210 -0
package/docs/class_misc_print.js.html +267 -0
package/docs/class_plugin.js.html +122 -70
package/docs/data/search.json +1 -1
package/docs/global.html +4 -1
package/docs/index.html +2 -2
package/docs/index.js.html +35 -0
package/docs/lib_current-loc.js.html +36 -0
package/docs/lib_formats.js.html +8 -8
package/docs/lib_import-module.js.html +59 -0
package/docs/lib_log-levels.js.html +17 -7
package/docs/lib_parse-args-argv.js.html +83 -0
package/docs/lib_parse-env.js.html +53 -0
package/docs/lib_resolve-path.js.html +3 -6
package/docs/lib_shim.js.html +8 -3
package/docs/module-Helper_Bajo.html +3 -0
package/docs/module-Helper_Base.html +3 -0
package/docs/module-Lib.html +15 -0
package/docs/static/home.md +32 -0
package/docs/static/logo-ecosystem.png +0 -0
package/docs/static/logo.png +0 -0
package/extend/bajo/intl/en-US.json +9 -2
package/extend/bajo/intl/id.json +9 -2
package/index.js +22 -2
package/lib/current-loc.js +24 -2
package/lib/formats.js +6 -6
package/lib/import-module.js +29 -0
package/lib/log-levels.js +15 -5
package/lib/parse-args-argv.js +20 -12
package/lib/parse-env.js +18 -7
package/lib/resolve-path.js +1 -4
package/lib/shim.js +6 -1
package/package.json +4 -7
package/wiki/CONFIG.md +36 -0
package/wiki/CONTRIBUTING.md +5 -0
package/wiki/DEV_GUIDE.md +3 -0
package/wiki/ECOSYSTEM.md +93 -0
package/wiki/GETTING-STARTED.md +356 -0
package/wiki/USER-GUIDE.md +256 -0
package/class/base/log.js +0 -205
package/class/base/plugin.js +0 -168
package/class/base/print.js +0 -272
package/docs/BasePlugin.html +0 -5
package/docs/class_base_err.js.html +0 -99
package/docs/class_base_log.js.html +0 -208
package/docs/class_base_plugin.js.html +0 -180
package/docs/class_base_print.js.html +0 -275
package/docs/class_helper_plugin.js.html +0 -172
package/docs/lib_create-method.js.html +0 -42
package/docs/module-class_helper_bajo.html +0 -3
package/docs/module-class_helper_plugin.html +0 -3
package/docs/module-lib_create-method.html +0 -3
package/docs/module-lib_formats.html +0 -3
package/docs/module-lib_log-levels.html +0 -3
package/docs/module-lib_resolve-path.html +0 -3
package/docs/module-lib_shim.html +0 -3
package/docs/tutorial-contribution.html +0 -3
package/docs/tutorial-ecosystem.html +0 -3
package/docs/tutorial-getting-started.html +0 -13
package/docs/tutorial-plugin-dev.html +0 -3
package/docs/tutorial-user-guide.html +0 -3
package/lib/create-method.js +0 -39
package/lib/dayjs.js +0 -8
package/lib/omitted-plugin-keys.js +0 -3
package/lib/read-all-configs.js +0 -19
package/misc-docs/.hook.md +0 -11
package/misc-docs/bitcoin.jpeg +0 -0
package/misc-docs/contribution.md +0 -20
package/misc-docs/ecosystem.md +0 -94
package/misc-docs/getting-started.md +0 -142
package/misc-docs/plugin-dev.md +0 -0
package/misc-docs/toc.json +0 -17
package/misc-docs/user-guide.md +0 -1
/package/docs/{bitcoin.jpeg → static/bitcoin.jpeg} +0 -0

package/docs/class_base_log.js.html DELETED Viewed

@@ -1,208 +0,0 @@
-<!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>Source: class/base/log.js</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 id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">class_base_log.js</h1></header><article><pre class="prettyprint source lang-js"><code>import os from 'os'
-import lodash from 'lodash'
-import dayjs from 'dayjs'
-import logLevels from '../../lib/log-levels.js'
-import chalk from 'chalk'
-const { isEmpty, without, merge } = lodash
-export function isIgnored (level) {
-  const { filter, isArray } = this.lib._
-  let ignore = this.app.bajo.config.log.ignore ?? []
-  if (!isArray(ignore)) ignore = [ignore]
-  const items = filter(ignore, i => {
-    const [ns, lvl] = i.split(':')
-    if (lvl) return ns === this.name &amp;&amp; lvl === level
-    return ns === this.name
-  })
-  return items.length > 0
-}
-/**
- * A thin logger system.
- *
- * @class
- */
-class Log {
-  /**
-   * @param {Object} plugin - Plugin instance
-   */
-  constructor (plugin) {
-    this.plugin = plugin
-    this.format = 'YYYY-MM-DDTHH:mm:ss.SSS[Z]'
-  }
-  /**
-   * Initialize logger. Auto detect to use different logger via Bajo's config file
-   *
-   * @method
-   */
-  init = () => {
-    this.bajoLog = this.plugin.app.bajo.config.log.logger ?? 'bajoLogger'
-  }
-  /**
-   * Interpolate and translate text via plugin's print engine. Check Print class
-   * for more information
-   *
-   * @method
-   * @param {string} text - Text pattern to use
-   * @param {...any} [args] - Variables to interpolate with text pattern above
-   * @returns {string} Interpolated &amp; translated text
-   */
-  write = (text, ...args) => {
-    return this.plugin.print.write(text, ...args)
-  }
-  /**
-   * Do we use external logger or Bajo's built-in one?
-   *
-   * @method
-   * @returns {boolean}
-   */
-  isExtLogger = () => {
-    return !!(this.plugin.app[this.bajoLog] &amp;&amp; this.plugin.app[this.bajoLog].logger)
-  }
-  /**
-   * Is provided level being ignored by config?
-   *
-   * @method
-   * @param {string} level - Log level
-   * @returns {boolean}
-   */
-  isIgnored = level => {
-    return isIgnored.call(this.plugin, level)
-  }
-  /**
-   * Create child logger
-   *
-   * @method
-   * @returns {Object} Child logger instance
-   */
-  child = () => {
-    if (this.isExtLogger()) return this.plugin.app[this.bajoLog].logger.child()
-    return this.plugin.app
-  }
-  /**
-   * Display &amp; format message according to one of these rules:
-   * 1. ```level``` ```text``` ```var 1``` ```var 2``` ```...var n``` - Translate ```text``` and interpolate with ```vars``` for level ```level```
-   * 2. ```level``` ```data``` ```text``` ```var 1``` ```var 2``` ```...var n``` - As above, and append stringified ```data```
-   * 3. ```level``` ```error``` - Format as **error**. If current log level is _trace_, dump the error object on screen
-   *
-   * @method
-   * @param {string} level - Log level to use
-   * @param {...any} params - See format above
-   */
-  formatMsg = (level, ...params) => {
-    if (this.plugin.app.bajo.config.log.level === 'silent') return
-    if (!this.plugin.app.bajo.isLogInRange(level)) return
-    const plain = this.plugin.app.bajo.config.log.plain
-    let [data, msg, ...args] = params
-    if (typeof data === 'string') {
-      args.unshift(msg)
-      msg = data
-      data = null
-    }
-    args = without(args, undefined)
-    if (data instanceof Error) {
-      msg = 'error%s'
-      args = [data.message]
-    }
-    msg = this.write(msg, ...args)
-    if (this.plugin.app[this.bajoLog] &amp;&amp; this.plugin.app[this.bajoLog].logger) {
-      this.plugin.app[this.bajoLog].logger[level](data, `[${this.plugin.name}] ${msg}`, ...args)
-    } else {
-      let text
-      const dt = new Date()
-      if (this.plugin.app.bajo.config.env === 'prod') {
-        const json = { level: logLevels[level].number, time: dt.valueOf(), pid: process.pid, hostname: os.hostname() }
-        if (!isEmpty(data)) merge(json, data)
-        merge(json, { msg: `[${this.plugin.name}] ${msg}` })
-        text = JSON.stringify(json)
-      } else {
-        const date = dayjs(dt).utc(true).format(this.format)
-        const tdate = plain ? `[${date}]` : chalk.cyan(date)
-        const tlevel = plain ? level.toUpperCase() : chalk[logLevels[level].color](level.toUpperCase())
-        const tplugin = plain ? `[${this.plugin.name}]` : chalk.bgBlue(`${this.plugin.name}`)
-        text = `${tdate} ${tlevel}: ${tplugin} ${msg}`
-        if (!isEmpty(data)) text += '\n' + JSON.stringify(data)
-      }
-      if (!this.isIgnored(level)) {
-        console.log(text)
-        if (data instanceof Error &amp;&amp; level === 'trace') console.error(data)
-      }
-    }
-  }
-  /**
-   * Display &amp; format message as ```trace``` level. See {@link Log#formatMsg|formatMsg} for details
-   *
-   * @method
-   * @param  {...any} params
-   */
-  trace = (...params) => {
-    this.formatMsg('trace', ...params)
-  }
-  /**
-   * Display &amp; format message as ```debug``` level. See {@link Log#formatMsg|formatMsg} for details
-   *
-   * @method
-   * @param  {...any} params
-   */
-  debug = (...params) => {
-    this.formatMsg('debug', ...params)
-  }
-  /**
-   * Display &amp; format message as ```info``` level. See {@link Log#formatMsg|formatMsg} for details
-   *
-   * @method
-   * @param  {...any} params
-   */
-  info = (...params) => {
-    this.formatMsg('info', ...params)
-  }
-  /**
-   * Display &amp; format message as ```warn``` level. See {@link Log#formatMsg|formatMsg} for details
-   *
-   * @method
-   * @param  {...any} params
-   */
-  warn = (...params) => {
-    this.formatMsg('warn', ...params)
-  }
-  /**
-   * Display &amp; format message as ```error``` level. See {@link Log#formatMsg|formatMsg} for details
-   *
-   * @method
-   * @param  {...any} params
-   */
-  error = (...params) => {
-    this.formatMsg('error', ...params)
-  }
-  /**
-   * Display &amp; format message as ```fatal``` level. See {@link Log#formatMsg|formatMsg} for details
-   *
-   * @method
-   * @param  {...any} params
-   */
-  fatal = (...params) => {
-    this.formatMsg('fatal', ...params)
-  }
-  silent = (...params) => {
-    this.formatMsg('silent', ...params)
-  }
-}
-export default Log
-</code></pre></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>

package/docs/class_base_plugin.js.html DELETED Viewed

@@ -1,180 +0,0 @@
-<!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>Source: class/base/plugin.js</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 id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">class_base_plugin.js</h1></header><article><pre class="prettyprint source lang-js"><code>import lodash from 'lodash'
-import omittedPluginKeys from '../../lib/omitted-plugin-keys.js'
-import Log from './log.js'
-import Print from './print.js'
-import Err from './err.js'
-import fastGlob from 'fast-glob'
-import { sprintf } from 'sprintf-js'
-import outmatch from 'outmatch'
-import dayjs from '../../lib/dayjs.js'
-import fs from 'fs-extra'
-import aneka from 'aneka/index.js'
-function outmatchNs (source, pattern) {
-  const { breakNsPath } = this.app.bajo
-  const [src, subSrc] = source.split(':')
-  if (!subSrc) return pattern === src
-  try {
-    const { fullNs, path } = breakNsPath(pattern)
-    const isMatch = outmatch(path)
-    return src === fullNs &amp;&amp; isMatch(subSrc)
-  } catch (err) {
-    return false
-  }
-}
-const lib = {
-  _: lodash,
-  fs,
-  fastGlob,
-  sprintf,
-  outmatch,
-  dayjs,
-  aneka
-}
-const { get, isEmpty, cloneDeep, omit, isPlainObject, camelCase } = lodash
-/**
- * This is the base class of bajo's plugin system.
- *
- * @class
- */
-class 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) {
-    /**
-     * Package name, the one from package.json
-     * @type {string}
-     */
-    this.pkgName = pkgName
-    /**
-     * Plugin name. Simply the camel cased version of plugin's package name
-     *
-     * @type {string}
-     */
-    this.name = camelCase(pkgName)
-    /**
-     * Reference to app instance
-     *
-     * @type {Object}
-     */
-    this.app = app
-    /**
-     * Config object
-     *
-     * @type {Object}
-     */
-    this.config = {}
-    /**
-     * Property to give you direct access to the most commonly used 3rd party library in a bajo based app.
-     * No manual import necessary, always available, everywhere, anytime!
-     *
-     * Example:
-     * ```javascript
-     * const { camelCase, kebabCase } = this.lib._
-     * console.log(camelCase('Elit commodo sit et aliqua'))
-     * ```
-     *
-     * @type {Object}
-     * @property {Object} _ - Access to {@link https://lodash.com|lodash}
-     * @property {Object} fs - Access to {@link https://github.com/jprichardson/node-fs-extra|fs-extra}
-     * @property {Object} fastGlob - Access to {@link https://github.com/mrmlnc/fast-glob|fast-glob}
-     * @property {Object} sprintf - Access to {@link https://github.com/alexei/sprintf.js|sprintf}
-     * @property {Object} aneka - Access to {@link https://github.com/ardhi/aneka|aneka}
-     * @property {Object} outmatch - Access to {@link https://github.com/axtgr/outmatch|outmatch}
-     * @property {Object} dayjs - Access to {@link https://day.js.org|dayjs} with utc &amp; customParseFormat plugin already applied
-     */
-    this.lib = lib
-    this.lib.outmatchNs = outmatchNs.bind(this)
-  }
-  /**
-   * Get plugin's config value
-   *
-   * @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
-   * @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
-   * @returns {Object} Returned object. If no path provided, the whole config object is returned
-   */
-  getConfig = (path, options = {}) => {
-    let obj = isEmpty(path) ? this.config : get(this.config, path, options.defValue ?? {})
-    options.omit = options.omit ?? omittedPluginKeys
-    if (isPlainObject(obj) &amp;&amp; !isEmpty(options.omit)) obj = omit(obj, options.omit)
-    if (!options.noClone) obj = cloneDeep(obj)
-    return obj
-  }
-  /**
-   * Initialize log. Please refer to {@link Log} class for more info
-   *
-   * @method
-   */
-  initLog = () => {
-    this.log = new Log(this)
-    this.log.init()
-  }
-  /**
-   * Initialize print engine. Please refer to {@link Print} class for more info
-   *
-   * @method
-   * @param {Object} [options] - Print options
-   */
-  initPrint = (options) => {
-    this.print = new Print(this, options)
-    this.print.init()
-  }
-  /**
-   * Create an instance of {@link Err} object
-   *
-   * @method
-   * @param {msg} msg - Error message
-   * @param  {...any} [args] - Argument variables you might want to add to the error object
-   * @returns {Object} Err instance
-   */
-  err = (msg, ...args) => {
-    if (!this.print) return new Error(msg, ...args)
-    const error = new Err(this, msg, ...args)
-    return error.write()
-  }
-  /**
-   * Alias to err () method above
-   *
-   * @method
-   */
-  error = (msg, ...args) => {
-    return this.error(msg, ...args)
-  }
-  /**
-   * Create an instance of Err object, display it on screen and then force
-   * terminate the app process
-   *
-   * @method
-   * @param {msg} msg - Error message
-   * @param  {...any} [args] - Argument variables you might want to add to the error object
-   */
-  fatal = (msg, ...args) => {
-    if (!this.print) return new Error(msg, ...args)
-    const error = new Err(this, msg, ...args)
-    error.fatal()
-  }
-}
-export default BasePlugin
-</code></pre></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>