bajo 2.21.0 → 2.22.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 (66) hide show
  1. package/.jsdoc.conf.json +1 -1
  2. package/class/app.js +139 -115
  3. package/class/bajo.js +96 -89
  4. package/class/base.js +25 -9
  5. package/class/cache.js +32 -19
  6. package/class/err.js +11 -9
  7. package/class/log.js +102 -52
  8. package/class/plugin.js +45 -35
  9. package/class/print.js +45 -44
  10. package/class/tools.js +7 -1
  11. package/docs/App.html +1 -23
  12. package/docs/Bajo.html +1 -6
  13. package/docs/Base.html +1 -1
  14. package/docs/Cache.html +1 -1
  15. package/docs/Err.html +2 -2
  16. package/docs/Log.html +4 -4
  17. package/docs/Plugin.html +1 -1
  18. package/docs/Print.html +1 -1
  19. package/docs/Tools.html +1 -1
  20. package/docs/class_app.js.html +141 -117
  21. package/docs/class_bajo.js.html +98 -91
  22. package/docs/class_base.js.html +27 -11
  23. package/docs/class_cache.js.html +34 -21
  24. package/docs/class_err.js.html +13 -11
  25. package/docs/class_log.js.html +104 -54
  26. package/docs/class_plugin.js.html +47 -37
  27. package/docs/class_print.js.html +47 -46
  28. package/docs/class_tools.js.html +9 -3
  29. package/docs/data/search.json +1 -1
  30. package/docs/global.html +1 -1
  31. package/docs/index.html +1 -1
  32. package/docs/index.js.html +8 -4
  33. package/docs/{class__helper.js.html → lib_helper.js.html} +208 -96
  34. package/docs/lib_hook.js.html +231 -0
  35. package/docs/module-Helper.html +8 -1
  36. package/docs/module-Hook.html +3 -0
  37. package/docs/module-Lib.html +1 -8
  38. package/index.js +6 -2
  39. package/{class/_helper.js → lib/helper.js} +206 -94
  40. package/lib/hook.js +228 -0
  41. package/package.json +1 -1
  42. package/wiki/CHANGES.md +10 -0
  43. package/docs/class_helper_bajo.js.html +0 -398
  44. package/docs/class_helper_base.js.html +0 -246
  45. package/docs/class_misc_err.js.html +0 -129
  46. package/docs/class_misc_log.js.html +0 -210
  47. package/docs/class_misc_print.js.html +0 -267
  48. package/docs/lib_current-loc.js.html +0 -36
  49. package/docs/lib_find-deep.js.html +0 -27
  50. package/docs/lib_formats.js.html +0 -68
  51. package/docs/lib_freeze.js.html +0 -54
  52. package/docs/lib_import-module.js.html +0 -61
  53. package/docs/lib_index.js.html +0 -9
  54. package/docs/lib_log-levels.js.html +0 -38
  55. package/docs/lib_parse-args-argv.js.html +0 -83
  56. package/docs/lib_parse-env.js.html +0 -53
  57. package/docs/lib_resolve-path.js.html +0 -27
  58. package/docs/lib_shim.js.html +0 -40
  59. package/docs/module-Helper_Bajo.html +0 -3
  60. package/docs/module-Helper_Base.html +0 -3
  61. package/lib/find-deep.js +0 -24
  62. package/lib/formats.js +0 -65
  63. package/lib/freeze.js +0 -51
  64. package/lib/import-module.js +0 -58
  65. package/lib/index.js +0 -6
  66. package/lib/log-levels.js +0 -35
@@ -1,3 +0,0 @@
1
- <!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>Module: Helper/Base</title><!--[if lt IE 9]>
2
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
3
- <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="light"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Bajo API</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="App.html">App</a></div><div class="sidebar-section-children"><a href="Bajo.html">Bajo</a></div><div class="sidebar-section-children"><a href="Base.html">Base</a></div><div class="sidebar-section-children"><a href="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-events"><div>Events</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#event:bajo:afterAll%257Bmethod%257D">bajo:afterAll{method}</a></div><div class="sidebar-section-children"><a href="global.html#event:bajo:afterBootComplete">bajo:afterBootComplete</a></div><div class="sidebar-section-children"><a href="global.html#event:bajo:afterBuildCollection">bajo:afterBuildCollection</a></div><div class="sidebar-section-children"><a href="global.html#event:bajo:afterCollectHooks">bajo:afterCollectHooks</a></div><div class="sidebar-section-children"><a href="global.html#event:bajo:beforeAll%257Bmethod%257D">bajo:beforeAll{method}</a></div><div class="sidebar-section-children"><a href="global.html#event:bajo:beforeBuildCollection">bajo:beforeBuildCollection</a></div><div class="sidebar-section-children"><a href="global.html#event:%257Bns%257D:afterAppletRun">{ns}:afterAppletRun</a></div><div class="sidebar-section-children"><a href="global.html#event:%257Bns%257D:after%257Bmethod%257D">{ns}:after{method}</a></div><div class="sidebar-section-children"><a href="global.html#event:%257Bns%257D:beforeAppletRun">{ns}:beforeAppletRun</a></div><div class="sidebar-section-children"><a href="global.html#event:%257Bns%257D:before%257Bmethod%257D">{ns}:before{method}</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-Helper_Bajo.html">Helper/Bajo</a></div><div class="sidebar-section-children"><a href="module-Helper_Base.html">Helper/Base</a></div><div class="sidebar-section-children"><a href="module-Lib.html">Lib</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#TAppConfigHandler">TAppConfigHandler</a></div><div class="sidebar-section-children"><a href="global.html#TAppEnv">TAppEnv</a></div><div class="sidebar-section-children"><a href="global.html#TAppLib">TAppLib</a></div><div class="sidebar-section-children"><a href="global.html#TBajoDataType">TBajoDataType</a></div><div class="sidebar-section-children"><a href="global.html#TBajoFormatResult">TBajoFormatResult</a></div><div class="sidebar-section-children"><a href="global.html#TBajoFormatType">TBajoFormatType</a></div><div class="sidebar-section-children"><a href="global.html#TLogJson">TLogJson</a></div><div class="sidebar-section-children"><a href="global.html#TLogLevels">TLogLevels</a></div><div class="sidebar-section-children"><a href="global.html#TNsPathPairs">TNsPathPairs</a></div><div class="sidebar-section-children"><a href="global.html#TNsPathResult">TNsPathResult</a></div><div class="sidebar-section-children"><a href="global.html#TPrintOptions">TPrintOptions</a></div><div class="sidebar-section-children"><a href="global.html#boot">boot</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/bajo" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/bajo" target="">Github</a></div><div class="navbar-item"><a id="" href="https://bajo.app" target="">Bajo</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><header></header><article><div class="container-overview"><div class="description"><p>Internal helpers called by Bajo &amp; plugins that only used once for bootstrapping purpose. It should remains hidden and not to be imported by any program.</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_helper_base.js.html">class/helper/base.js</a>, <a href="class_helper_base.js.html#line23">line 23</a></li></ul></dd></div></dl></div><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id=".attachMethods"><span class="type-signature">(async, static) </span>attachMethods<span class="signature">()</span></h3><div class="description"><p>Scan plugins <code>method</code> directories, and turn + attach its found files as methods dynamically.</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_helper_base.js.html">class/helper/base.js</a>, <a href="class_helper_base.js.html#line35">line 35</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".buildConfigs"><span class="type-signature">(async, static) </span>buildConfigs<span class="signature">()</span></h3><div class="description"><p>Build configurations</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_helper_base.js.html">class/helper/base.js</a>, <a href="class_helper_base.js.html#line70">line 70</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".checkDependencies"><span class="type-signature">(async, static) </span>checkDependencies<span class="signature">()</span></h3><div class="description"><p>Ensure dependencies are met</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_helper_base.js.html">class/helper/base.js</a>, <a href="class_helper_base.js.html#line104">line 104</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".checkNameAliases"><span class="type-signature">(async, static) </span>checkNameAliases<span class="signature">()</span></h3><div class="description"><p>Ensure for names and aliases to be unique and no clashes with other 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_helper_base.js.html">class/helper/base.js</a>, <a href="class_helper_base.js.html#line84">line 84</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".collectHooks"><span class="type-signature">(async, static) </span>collectHooks<span class="signature">()</span></h3><div class="description"><p>Collect and build hooks and push them to the bajo's hook system</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_helper_base.js.html">class/helper/base.js</a>, <a href="class_helper_base.js.html#line145">line 145</a></li></ul></dd></div></dl><div class="method-member-container flex w-100 overflow-auto mt-20"><strong>Fires:</strong><ul><li><a href="global.html#event:bajo:afterCollectHooks">bajo:afterCollectHooks</a></li></ul></div><h3 class="name has-anchor" id=".run"><span class="type-signature">(async, static) </span>run<span class="signature">()</span></h3><div class="description"><p>Finally, run all 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_helper_base.js.html">class/helper/base.js</a>, <a href="class_helper_base.js.html#line190">line 190</a></li></ul></dd></div></dl><div class="method-member-container flex w-100 overflow-auto mt-20"><strong>Fires:</strong><ul><li><a href="global.html#event:bajo:beforeAll%257Bmethod%257D">bajo:beforeAll{method}</a></li><li><a href="global.html#event:%257Bns%257D:before%257Bmethod%257D">event:{ns}:before{method}</a></li><li><a href="global.html#event:%257Bns%257D:after%257Bmethod%257D">event:{ns}:after{method}</a></li><li><a href="global.html#event:bajo:afterAll%257Bmethod%257D">bajo:afterAll{method}</a></li></ul></div></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 API</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/bajo" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/bajo" target="">Github</a></div><div class="navbar-item"><a id="" href="https://bajo.app" target="">Bajo</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="App.html">App</a></div><div class="sidebar-section-children"><a href="Bajo.html">Bajo</a></div><div class="sidebar-section-children"><a href="Base.html">Base</a></div><div class="sidebar-section-children"><a href="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-events"><div>Events</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#event:bajo:afterAll%257Bmethod%257D">bajo:afterAll{method}</a></div><div class="sidebar-section-children"><a href="global.html#event:bajo:afterBootComplete">bajo:afterBootComplete</a></div><div class="sidebar-section-children"><a href="global.html#event:bajo:afterBuildCollection">bajo:afterBuildCollection</a></div><div class="sidebar-section-children"><a href="global.html#event:bajo:afterCollectHooks">bajo:afterCollectHooks</a></div><div class="sidebar-section-children"><a href="global.html#event:bajo:beforeAll%257Bmethod%257D">bajo:beforeAll{method}</a></div><div class="sidebar-section-children"><a href="global.html#event:bajo:beforeBuildCollection">bajo:beforeBuildCollection</a></div><div class="sidebar-section-children"><a href="global.html#event:%257Bns%257D:afterAppletRun">{ns}:afterAppletRun</a></div><div class="sidebar-section-children"><a href="global.html#event:%257Bns%257D:after%257Bmethod%257D">{ns}:after{method}</a></div><div class="sidebar-section-children"><a href="global.html#event:%257Bns%257D:beforeAppletRun">{ns}:beforeAppletRun</a></div><div class="sidebar-section-children"><a href="global.html#event:%257Bns%257D:before%257Bmethod%257D">{ns}:before{method}</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-Helper_Bajo.html">Helper/Bajo</a></div><div class="sidebar-section-children"><a href="module-Helper_Base.html">Helper/Base</a></div><div class="sidebar-section-children"><a href="module-Lib.html">Lib</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#TAppConfigHandler">TAppConfigHandler</a></div><div class="sidebar-section-children"><a href="global.html#TAppEnv">TAppEnv</a></div><div class="sidebar-section-children"><a href="global.html#TAppLib">TAppLib</a></div><div class="sidebar-section-children"><a href="global.html#TBajoDataType">TBajoDataType</a></div><div class="sidebar-section-children"><a href="global.html#TBajoFormatResult">TBajoFormatResult</a></div><div class="sidebar-section-children"><a href="global.html#TBajoFormatType">TBajoFormatType</a></div><div class="sidebar-section-children"><a href="global.html#TLogJson">TLogJson</a></div><div class="sidebar-section-children"><a href="global.html#TLogLevels">TLogLevels</a></div><div class="sidebar-section-children"><a href="global.html#TNsPathPairs">TNsPathPairs</a></div><div class="sidebar-section-children"><a href="global.html#TNsPathResult">TNsPathResult</a></div><div class="sidebar-section-children"><a href="global.html#TPrintOptions">TPrintOptions</a></div><div class="sidebar-section-children"><a href="global.html#boot">boot</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/lib/find-deep.js DELETED
@@ -1,24 +0,0 @@
1
- import fs from 'fs'
2
-
3
- /**
4
- * Find item deep in paths.
5
- *
6
- * @method
7
- * @memberof module:Lib
8
- * @param {string} item Item to find.
9
- * @param {Array} paths Array of path to look for.
10
- * @returns {string}
11
- */
12
- function findDeep (item, paths) {
13
- let dir
14
- for (const p of paths) {
15
- const d = `${p}/${item}`
16
- if (fs.existsSync(d)) {
17
- dir = d
18
- break
19
- }
20
- }
21
- return dir
22
- }
23
-
24
- export default findDeep
package/lib/formats.js DELETED
@@ -1,65 +0,0 @@
1
- /**
2
- * Supported data types.
3
- *
4
- * @typedef {Object} TBajoDataType
5
- * @type {Array}
6
- * @property {string} 0 string
7
- * @property {string} 1 float
8
- * @property {string} 2 double
9
- * @property {string} 3 integer
10
- * @property {string} 4 smallint
11
- * @property {string} 5 date
12
- * @property {string} 6 time
13
- * @property {string} 7 datetime
14
- * @property {string} 8 array
15
- * @property {string} 9 object
16
- * @property {string} 10 auto
17
- */
18
-
19
- /**
20
- * General format types,
21
- *
22
- * @typedef {Object} TBajoFormatType
23
- * @type {Array}
24
- * @property {string} 0 speed
25
- * @property {string} 1 distance
26
- * @property {string} 2 area
27
- * @property {string} 3 degree
28
- */
29
- export const types = ['speed', 'distance', 'area', 'degree']
30
-
31
- export const formats = {
32
- metric: {
33
- speedFn: (val) => val,
34
- speedUnit: 'kmh',
35
- distanceFn: (val) => val,
36
- distanceUnit: 'km',
37
- areaFn: (val) => val,
38
- areaUnit: 'km²',
39
- degreeFn: (val) => val,
40
- degreeUnit: '°',
41
- degreeUnitSep: ''
42
- },
43
- imperial: {
44
- speedFn: (val) => val / 1.609,
45
- speedUnit: 'mih',
46
- distanceFn: (val) => val / 1.609,
47
- distanceUnit: 'mi',
48
- areaFn: (val) => val / 2.59,
49
- areaUnit: 'mi²',
50
- degreeFn: (val) => val,
51
- degreeUnit: '°',
52
- degreeUnitSep: ''
53
- },
54
- nautical: {
55
- speedFn: (val) => val / 1.852,
56
- speedUnit: 'knot',
57
- distanceFn: (val) => val / 1.852,
58
- distanceUnit: 'nm',
59
- areaFn: (val) => val / 2.92,
60
- areaUnit: 'nm²',
61
- degreeFn: (val) => val,
62
- degreeUnit: '°',
63
- degreeUnitSep: ''
64
- }
65
- }
package/lib/freeze.js DELETED
@@ -1,51 +0,0 @@
1
- import _ from 'lodash'
2
- const { cloneDeep } = _
3
-
4
- /**
5
- * Freeze object.
6
- *
7
- * @method
8
- * @memberof module:Lib
9
- * @param {Object} obj Object to freeze.
10
- * @param {boolean} [shallow=false] If ```false``` (default), deep freeze object.
11
- */
12
- function freeze (obj, options = {}) {
13
- const { shallow = false, clone = false } = options
14
- if (shallow) Object.freeze(obj)
15
- else deepFreeze(obj, clone)
16
- }
17
-
18
- // take from https://github.com/3imed-jaberi/deepfreeze/blob/master/index.js
19
- function deepFreeze (object, clone = false) {
20
- function _deepFreeze (_object) {
21
- if (Object.isFrozen(_object)) return _object
22
- if (_object instanceof Map) {
23
- _object.set = _object.clear = _object.delete = function () {
24
- throw new Error('Map is read-only')
25
- }
26
- return _object
27
- }
28
- if (_object instanceof Set) {
29
- _object.add = _object.clear = _object.delete = function () {
30
- throw new Error('Set is read-only')
31
- }
32
- return _object
33
- }
34
-
35
- Object.freeze(_object)
36
- Object.getOwnPropertyNames(_object).forEach(function (key) {
37
- if (Object.hasOwn(_object, key) && _object[key] !== null &&
38
- (typeof _object[key] === 'object' || typeof _object[key] === 'function') &&
39
- !Object.isFrozen(_object[key])
40
- ) _deepFreeze(_object[key])
41
- })
42
-
43
- return _object
44
- }
45
-
46
- if (!Object.isFrozen(object)) Object.defineProperty(object, 'isDeepFrozen', { value: () => true })
47
- object = clone ? cloneDeep(object) : object
48
- return _deepFreeze(object)
49
- }
50
-
51
- export default freeze
@@ -1,58 +0,0 @@
1
- import fs from 'fs-extra'
2
- import lodash from 'lodash'
3
- import aneka from 'aneka'
4
-
5
- const { resolvePath } = aneka
6
- const { isFunction, isPlainObject } = lodash
7
-
8
- /**
9
- * Import file/module from any loaded plugins.
10
- *
11
- * E.g. your plugin structure looks like this:
12
- * ```
13
- * |- src
14
- * | |- lib
15
- * | | |- my-module.js
16
- * |- index.js
17
- * |- package.json
18
- * ```
19
- *
20
- * And this is how to import ```my-module.js```:
21
- * ```javascript
22
- * const { importModule } = this.app.bajo
23
- * const myModule = await importModule('myPlugin:/src/lib/my-module.js')
24
- * ```
25
- *
26
- * @method
27
- * @async
28
- * @memberof module:Lib
29
- * @param {TNsPathPairs} file File to import.
30
- * @param {Object} [options={}] Options.
31
- * @param {boolean} [options.asDefaultImport=true] If ```true``` (default), return default imported module.
32
- * @param {boolean} [options.asHandler] If ```true```, return as a {@link HandlerType|handler}.
33
- * @param {boolean} [options.noCache] If ```true```, always import as a fresh copy.
34
- * @returns {any}
35
- * @see Bajo#importModule
36
- */
37
- async function importModule (file, { asDefaultImport = true, asHandler, noCache } = {}) {
38
- const load = async (file, asDefaultImport, noCache = false) => {
39
- file = resolvePath(file, true)
40
- if (noCache) file += `?_=${Date.now()}`
41
- const imported = await import(file)
42
- if (asDefaultImport) return imported.default
43
- return imported
44
- }
45
-
46
- if (this) file = this.app.getPluginFile(file)
47
- if (!fs.existsSync(file)) return
48
- let mod = await load(file, asDefaultImport, noCache)
49
- if (!asHandler) return mod
50
- if (isFunction(mod)) mod = { level: 999, handler: mod }
51
- if (!isPlainObject(mod)) {
52
- if (this) throw this.error('fileNotModuleHandler%s', file)
53
- throw new Error(`File '${file}' is NOT a handler module`)
54
- }
55
- return mod
56
- }
57
-
58
- export default importModule
package/lib/index.js DELETED
@@ -1,6 +0,0 @@
1
- /**
2
- * External helpers you can use by importing its file directly
3
- *
4
- * @name Lib
5
- * @module Lib
6
- */
package/lib/log-levels.js DELETED
@@ -1,35 +0,0 @@
1
- /**
2
- * @typedef {Object} TLogLevels
3
- * @type {Object}
4
- * @property {Object} trace
5
- * @property {number} [trace.number=10]
6
- * @property {string} [trace.color=gray]
7
- * @property {Object} debug
8
- * @property {number} [debug.number=20]
9
- * @property {string} [debug.color=greenBright]
10
- * @property {Object} info
11
- * @property {number} [info.number=30]
12
- * @property {string} [info.color=blueBright]
13
- * @property {Object} warn
14
- * @property {number} [warn.number=40]
15
- * @property {string} [warn.color=yellowBright]
16
- * @property {Object} error
17
- * @property {number} [error.number=50]
18
- * @property {string} [error.color=redBright]
19
- * @property {Object} fatal
20
- * @property {number} [fatal.number=60]
21
- * @property {string} [fatal.color=magentaBright]
22
- * @property {Object} silent
23
- * @property {number} [silent.number=99]
24
- * @property {string} [silent.color=white]
25
- */
26
-
27
- export default {
28
- trace: { number: 10, color: 'gray' },
29
- debug: { number: 20, color: 'greenBright' },
30
- info: { number: 30, color: 'blueBright' },
31
- warn: { number: 40, color: 'yellowBright' },
32
- error: { number: 50, color: 'redBright' },
33
- fatal: { number: 60, color: 'magentaBright' },
34
- silent: { number: 99, color: 'white' }
35
- }