bajo-template 2.8.0 → 2.9.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.
- package/docs/BajoTemplate.html +1 -1
- package/docs/data/search.json +1 -1
- package/docs/global.html +1 -1
- package/docs/index.html +1 -1
- package/docs/index.js.html +353 -86
- package/docs/lib_imports.js.html +173 -0
- package/docs/lib_index.js.html +163 -0
- package/docs/module-Imports.html +6 -0
- package/docs/module-Lib.html +3 -0
- package/docs/module-LibImports.html +3 -0
- package/docs/module-Lib_Imports.html +3 -0
- package/docs/scripts/core.js +477 -476
- package/docs/scripts/resize.js +36 -36
- package/docs/scripts/search.js +105 -105
- package/docs/scripts/third-party/fuse.js +1 -1
- package/docs/scripts/third-party/hljs-line-num-original.js +285 -282
- package/docs/scripts/third-party/hljs-line-num.js +1 -1
- package/docs/scripts/third-party/hljs-original.js +1202 -1195
- package/docs/scripts/third-party/hljs.js +1 -1
- package/docs/scripts/third-party/popper.js +1 -1
- package/docs/scripts/third-party/tippy.js +1 -1
- package/docs/scripts/third-party/tocbot.js +509 -508
- package/index.js +305 -17
- package/lib/imports.js +170 -0
- package/package.json +4 -2
- package/test/bajo-template.test.js +275 -0
- package/wiki/CHANGES.md +5 -0
- package/lib/resolve-resource.js +0 -90
|
@@ -0,0 +1,173 @@
|
|
|
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>Source: lib/imports.js</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">BajoTemplate 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="BajoTemplate.html">BajoTemplate</a></div><div class="sidebar-section-children"><a href="BajoTemplate.html">BajoTemplate</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-Imports.html">Imports</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#TImportsResult">TImportsResult</a></div><div class="sidebar-section-children"><a href="global.html#factory">factory</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-template" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/bajo-template" 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 id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">lib_imports.js</h1></header><article><pre class="prettyprint source lang-js"><code>/**
|
|
4
|
+
* Functions and types for {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
5
|
+
*
|
|
6
|
+
* With these functions now your templates can use all listed functions below.
|
|
7
|
+
* The imports are automatically injected into the template's scope during compilation.
|
|
8
|
+
*
|
|
9
|
+
* @module Imports
|
|
10
|
+
* @example
|
|
11
|
+
* // In your template file (e.g., template.html)
|
|
12
|
+
* <p><%= _t('Hello, %s!', user.name) %></p>
|
|
13
|
+
* <p><%= _format(user.birthDate, 'date') %></p>
|
|
14
|
+
* <p><%= _routePath('home:/user/{id}/profile', { id: user.id }) %></p>
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Translate text with optional parameters.
|
|
19
|
+
*
|
|
20
|
+
* @callback FnTranslate
|
|
21
|
+
* @function
|
|
22
|
+
* @param {string} text - Text to be translated.
|
|
23
|
+
* @param {...*} args - Optional parameters for translation.
|
|
24
|
+
* @returns {string} Translated text.
|
|
25
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
26
|
+
*/
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Format text with optional parameters.
|
|
30
|
+
*
|
|
31
|
+
* See {@link https://ardhi.github.io/bajo/Bajo.html#format|Bajo.format} for more details.
|
|
32
|
+
*
|
|
33
|
+
* @callback FnFormat
|
|
34
|
+
* @function
|
|
35
|
+
* @param {*} val - Value to be formatted.
|
|
36
|
+
* @param {string} type - Value type (e.g., 'string', 'number', 'date').
|
|
37
|
+
* @param {object} [opts] - Optional formatting options.
|
|
38
|
+
* @returns {string} Formatted text.
|
|
39
|
+
* @see {@link https://ardhi.github.io/bajo/Bajo.html#format|Bajo.format}
|
|
40
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
41
|
+
*/
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* Find route by name. Only available when Waibu plugin is installed & loaded.
|
|
45
|
+
*
|
|
46
|
+
* See {@link https://ardhi.github.io/waibu/Waibu.html#findRoute|Waibu.findRoute} for more details.
|
|
47
|
+
*
|
|
48
|
+
* @callback FnFindRoute
|
|
49
|
+
* @function
|
|
50
|
+
* @param {string} name - Route name.
|
|
51
|
+
* @param {string} [method='GET'] - HTTP method (e.g., 'GET', 'POST').
|
|
52
|
+
* @returns {object|null} Route object or null if not found.
|
|
53
|
+
* @see {@link https://ardhi.github.io/waibu/Waibu.html#findRoute|Waibu.findRoute}
|
|
54
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
55
|
+
*/
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* Get route path by name. Only available when Waibu plugin is installed & loaded.
|
|
59
|
+
*
|
|
60
|
+
* See {@link https://ardhi.github.io/waibu/Waibu.html#routePath|Waibu.routePath} for more details.
|
|
61
|
+
*
|
|
62
|
+
* @callback FnRoutePath
|
|
63
|
+
* @function
|
|
64
|
+
* @param {string} name - Route name.
|
|
65
|
+
* @param {object} [options={}] - Options object.
|
|
66
|
+
* @returns {string|null} Route path or null if not found.
|
|
67
|
+
* @see {@link https://ardhi.github.io/waibu/Waibu.html#routePath|Waibu.routePath}
|
|
68
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
69
|
+
*/
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
* Get titleized version of a string.
|
|
73
|
+
*
|
|
74
|
+
* @callback FnTitleize
|
|
75
|
+
* @function
|
|
76
|
+
* @param {string} str - String to be titleized.
|
|
77
|
+
* @returns {string} Titleized string.
|
|
78
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
79
|
+
*/
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* Check if a plugin is loaded by its name or alias.
|
|
83
|
+
*
|
|
84
|
+
* @callback FnHasPlugin
|
|
85
|
+
* @function
|
|
86
|
+
* @param {string} nameOrAlias - Plugin name or alias.
|
|
87
|
+
* @returns {boolean} True if the plugin is loaded, false otherwise.
|
|
88
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
89
|
+
*/
|
|
90
|
+
|
|
91
|
+
/**
|
|
92
|
+
* JSON stringify a value. Only available when WaibuMpa plugin is installed & loaded.
|
|
93
|
+
*
|
|
94
|
+
* See {@link https://ardhi.github.io/waibu/WaibuMpa.html#jsonStringify|WaibuMpa.jsonStringify} for more details.
|
|
95
|
+
*
|
|
96
|
+
* @callback FnJsonStringify
|
|
97
|
+
* @function
|
|
98
|
+
* @param {*} value - Value to be stringified.
|
|
99
|
+
* @param {object} [replacer] - Optional replacer function or array.
|
|
100
|
+
* @param {string|number} [space] - Optional space for indentation.
|
|
101
|
+
* @returns {string} JSON stringified value.
|
|
102
|
+
* @see {@link https://ardhi.github.io/waibu/WaibuMpa.html#jsonStringify|WaibuMpa.jsonStringify}
|
|
103
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
104
|
+
*/
|
|
105
|
+
|
|
106
|
+
/**
|
|
107
|
+
* Parse markdown text. Only available when BajoMarkdown plugin is installed & loaded.
|
|
108
|
+
* See {@link https://ardhi.github.io/bajo/BajoMarkdown.html#parse|BajoMarkdown.parse} for more details.
|
|
109
|
+
*
|
|
110
|
+
* @callback FnParseMarkdown
|
|
111
|
+
* @function
|
|
112
|
+
* @param {string} value - Markdown text to be parsed.
|
|
113
|
+
* @returns {string} Parsed HTML string.
|
|
114
|
+
* @see {@link https://ardhi.github.io/bajo/BajoMarkdown.html#parse|BajoMarkdown.parse}
|
|
115
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
116
|
+
*/
|
|
117
|
+
|
|
118
|
+
/**
|
|
119
|
+
* Get excerpt of a string.
|
|
120
|
+
*
|
|
121
|
+
* @callback FnExcerpt
|
|
122
|
+
* @function
|
|
123
|
+
* @param {string} text - String to be excerpted.
|
|
124
|
+
* @param {number} [maxWords=50] - Max number of words.
|
|
125
|
+
* @param {string} [trailChars='...'] - Characters to append if truncated.
|
|
126
|
+
* @returns {string} Excerpted string.
|
|
127
|
+
* @see {@link BajoTemplate#getExcerpt|BajoTemplate.getExcerpt}
|
|
128
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
129
|
+
*/
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* Dump a value to console.
|
|
133
|
+
*
|
|
134
|
+
* @callback FnDump
|
|
135
|
+
* @function
|
|
136
|
+
* @param {*} value - Value to be dumped.
|
|
137
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
138
|
+
*/
|
|
139
|
+
|
|
140
|
+
/**
|
|
141
|
+
* Get a setting value by key. Only available when Waibu plugin is installed & loaded.
|
|
142
|
+
*
|
|
143
|
+
* See {@link https://ardhi.github.io/waibu/Waibu.html#getSetting|Waibu.getSetting} for more details.
|
|
144
|
+
*
|
|
145
|
+
* @callback FnGetSetting
|
|
146
|
+
* @function
|
|
147
|
+
* @param {string} key - Setting key.
|
|
148
|
+
* @returns {*} Setting value.
|
|
149
|
+
* @see {@link https://ardhi.github.io/waibu/Waibu.html#getSetting|Waibu.getSetting}
|
|
150
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
151
|
+
*/
|
|
152
|
+
|
|
153
|
+
/**
|
|
154
|
+
* Result of {@link BajoTemplate#buildCompileImports} method.
|
|
155
|
+
*
|
|
156
|
+
* @typedef {object} TImportsResult
|
|
157
|
+
* @type {object}
|
|
158
|
+
* @global
|
|
159
|
+
* @property {object} _ - Utility library (lodash)
|
|
160
|
+
* @property {module:Imports~FnTranslate} _t - Translation function
|
|
161
|
+
* @property {module:Imports~FnFormat} _format - Format function
|
|
162
|
+
* @property {module:Imports~FnFindRoute} _findRoute - Find route function
|
|
163
|
+
* @property {module:Imports~FnRoutePath} _routePath - Route path function
|
|
164
|
+
* @property {module:Imports~FnTitleize} _titleize - Titleize function
|
|
165
|
+
* @property {module:Imports~FnHasPlugin} _hasPlugin - Check if plugin exists function
|
|
166
|
+
* @property {module:Imports~FnJsonStringify} _jsonStringify - JSON stringify function
|
|
167
|
+
* @property {module:Imports~FnParseMarkdown} _parseMarkdown - Parse markdown function
|
|
168
|
+
* @property {module:Imports~FnExcerpt} _excerpt - Excerpt function
|
|
169
|
+
* @property {module:Imports~FnDump} _dump - Dump function
|
|
170
|
+
* @property {module:Imports~FnGetSetting} _getSetting - Get setting function
|
|
171
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
172
|
+
*/
|
|
173
|
+
</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">BajoTemplate API</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/bajo-template" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/bajo-template" 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="BajoTemplate.html">BajoTemplate</a></div><div class="sidebar-section-children"><a href="BajoTemplate.html">BajoTemplate</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-Imports.html">Imports</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#TImportsResult">TImportsResult</a></div><div class="sidebar-section-children"><a href="global.html#factory">factory</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>
|
|
@@ -0,0 +1,163 @@
|
|
|
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>Source: lib/index.js</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">BajoTemplate 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="BajoTemplate.html">BajoTemplate</a></div><div class="sidebar-section-children"><a href="BajoTemplate.html">BajoTemplate</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-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#TImportsResult">TImportsResult</a></div><div class="sidebar-section-children"><a href="global.html#factory">factory</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-template" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/bajo-template" 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 id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">lib_index.js</h1></header><article><pre class="prettyprint source lang-js"><code>/**
|
|
4
|
+
* @module Lib
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* Translate text with optional parameters.
|
|
9
|
+
*
|
|
10
|
+
* @callback FnTranslate
|
|
11
|
+
* @function
|
|
12
|
+
* @param {string} text - Text to be translated.
|
|
13
|
+
* @param {...*} args - Optional parameters for translation.
|
|
14
|
+
* @returns {string} Translated text.
|
|
15
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
16
|
+
*/
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* Format text with optional parameters.
|
|
20
|
+
*
|
|
21
|
+
* See {@link https://ardhi.github.io/bajo/Bajo.html#format|Bajo.format} for more details.
|
|
22
|
+
*
|
|
23
|
+
* @callback FnFormat
|
|
24
|
+
* @function
|
|
25
|
+
* @param {*} val - Value to be formatted.
|
|
26
|
+
* @param {string} type - Value type (e.g., 'string', 'number', 'date').
|
|
27
|
+
* @param {object} [opts] - Optional formatting options.
|
|
28
|
+
* @returns {string} Formatted text.
|
|
29
|
+
* @see {@link https://ardhi.github.io/bajo/Bajo.html#format|Bajo.format}
|
|
30
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
31
|
+
*/
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* Find route by name. Only available when Waibu plugin is installed & loaded.
|
|
35
|
+
*
|
|
36
|
+
* See {@link https://ardhi.github.io/waibu/Waibu.html#findRoute|Waibu.findRoute} for more details.
|
|
37
|
+
*
|
|
38
|
+
* @callback FnFindRoute
|
|
39
|
+
* @function
|
|
40
|
+
* @param {string} name - Route name.
|
|
41
|
+
* @param {string} [method='GET'] - HTTP method (e.g., 'GET', 'POST').
|
|
42
|
+
* @returns {object|null} Route object or null if not found.
|
|
43
|
+
* @see {@link https://ardhi.github.io/waibu/Waibu.html#findRoute|Waibu.findRoute}
|
|
44
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
45
|
+
*/
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* Get route path by name. Only available when Waibu plugin is installed & loaded.
|
|
49
|
+
*
|
|
50
|
+
* See {@link https://ardhi.github.io/waibu/Waibu.html#routePath|Waibu.routePath} for more details.
|
|
51
|
+
*
|
|
52
|
+
* @callback FnRoutePath
|
|
53
|
+
* @function
|
|
54
|
+
* @param {string} name - Route name.
|
|
55
|
+
* @param {object} [options={}] - Options object.
|
|
56
|
+
* @returns {string|null} Route path or null if not found.
|
|
57
|
+
* @see {@link https://ardhi.github.io/waibu/Waibu.html#routePath|Waibu.routePath}
|
|
58
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
59
|
+
*/
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* Get titleized version of a string.
|
|
63
|
+
*
|
|
64
|
+
* @callback FnTitleize
|
|
65
|
+
* @function
|
|
66
|
+
* @param {string} str - String to be titleized.
|
|
67
|
+
* @returns {string} Titleized string.
|
|
68
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
69
|
+
*/
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
* Check if a plugin is loaded by its name or alias.
|
|
73
|
+
*
|
|
74
|
+
* @callback FnHasPlugin
|
|
75
|
+
* @function
|
|
76
|
+
* @param {string} nameOrAlias - Plugin name or alias.
|
|
77
|
+
* @returns {boolean} True if the plugin is loaded, false otherwise.
|
|
78
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
79
|
+
*/
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* JSON stringify a value. Only available when WaibuMpa plugin is installed & loaded.
|
|
83
|
+
*
|
|
84
|
+
* See {@link https://ardhi.github.io/waibu/WaibuMpa.html#jsonStringify|WaibuMpa.jsonStringify} for more details.
|
|
85
|
+
*
|
|
86
|
+
* @callback FnJsonStringify
|
|
87
|
+
* @function
|
|
88
|
+
* @param {*} value - Value to be stringified.
|
|
89
|
+
* @param {object} [replacer] - Optional replacer function or array.
|
|
90
|
+
* @param {string|number} [space] - Optional space for indentation.
|
|
91
|
+
* @returns {string} JSON stringified value.
|
|
92
|
+
* @see {@link https://ardhi.github.io/waibu/WaibuMpa.html#jsonStringify|WaibuMpa.jsonStringify}
|
|
93
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
94
|
+
*/
|
|
95
|
+
|
|
96
|
+
/**
|
|
97
|
+
* Parse markdown text. Only available when BajoMarkdown plugin is installed & loaded.
|
|
98
|
+
* See {@link https://ardhi.github.io/bajo/BajoMarkdown.html#parse|BajoMarkdown.parse} for more details.
|
|
99
|
+
*
|
|
100
|
+
* @callback FnParseMarkdown
|
|
101
|
+
* @function
|
|
102
|
+
* @param {string} value - Markdown text to be parsed.
|
|
103
|
+
* @returns {string} Parsed HTML string.
|
|
104
|
+
* @see {@link https://ardhi.github.io/bajo/BajoMarkdown.html#parse|BajoMarkdown.parse}
|
|
105
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
106
|
+
*/
|
|
107
|
+
|
|
108
|
+
/**
|
|
109
|
+
* Get excerpt of a string.
|
|
110
|
+
*
|
|
111
|
+
* @callback FnExcerpt
|
|
112
|
+
* @function
|
|
113
|
+
* @param {string} text - String to be excerpted.
|
|
114
|
+
* @param {number} [maxWords=50] - Max number of words.
|
|
115
|
+
* @param {string} [trailChars='...'] - Characters to append if truncated.
|
|
116
|
+
* @returns {string} Excerpted string.
|
|
117
|
+
* @see {@link BajoTemplate#getExcerpt|BajoTemplate.getExcerpt}
|
|
118
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
119
|
+
*/
|
|
120
|
+
|
|
121
|
+
/**
|
|
122
|
+
* Dump a value to console.
|
|
123
|
+
*
|
|
124
|
+
* @callback FnDump
|
|
125
|
+
* @function
|
|
126
|
+
* @param {*} value - Value to be dumped.
|
|
127
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
128
|
+
*/
|
|
129
|
+
|
|
130
|
+
/**
|
|
131
|
+
* Get a setting value by key. Only available when Waibu plugin is installed & loaded.
|
|
132
|
+
*
|
|
133
|
+
* See {@link https://ardhi.github.io/waibu/Waibu.html#getSetting|Waibu.getSetting} for more details.
|
|
134
|
+
*
|
|
135
|
+
* @callback FnGetSetting
|
|
136
|
+
* @function
|
|
137
|
+
* @param {string} key - Setting key.
|
|
138
|
+
* @returns {*} Setting value.
|
|
139
|
+
* @see {@link https://ardhi.github.io/waibu/Waibu.html#getSetting|Waibu.getSetting}
|
|
140
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
141
|
+
*/
|
|
142
|
+
|
|
143
|
+
/**
|
|
144
|
+
* Result of {@link BajoTemplate#buildCompileImports} method.
|
|
145
|
+
*
|
|
146
|
+
* @typedef {object} TImportsResult
|
|
147
|
+
* @type {object}
|
|
148
|
+
* @global
|
|
149
|
+
* @property {object} _ - Utility library (lodash)
|
|
150
|
+
* @property {module:Lib~FnTranslate} _t - Translation function
|
|
151
|
+
* @property {module:Lib~FnFormat} _format - Format function
|
|
152
|
+
* @property {module:Lib~FnFindRoute} _findRoute - Find route function
|
|
153
|
+
* @property {module:Lib~FnRoutePath} _routePath - Route path function
|
|
154
|
+
* @property {module:Lib~FnTitleize} _titleize - Titleize function
|
|
155
|
+
* @property {module:Lib~FnHasPlugin} _hasPlugin - Check if plugin exists function
|
|
156
|
+
* @property {module:Lib~FnJsonStringify} _jsonStringify - JSON stringify function
|
|
157
|
+
* @property {module:Lib~FnParseMarkdown} _parseMarkdown - Parse markdown function
|
|
158
|
+
* @property {module:Lib~FnExcerpt} _excerpt - Excerpt function
|
|
159
|
+
* @property {module:Lib~FnDump} _dump - Dump function
|
|
160
|
+
* @property {module:Lib~FnGetSetting} _getSetting - Get setting function
|
|
161
|
+
* @see {@link BajoTemplate#buildCompileImports|BajoTemplate.buildCompileImports}
|
|
162
|
+
*/
|
|
163
|
+
</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">BajoTemplate API</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/bajo-template" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/bajo-template" 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="BajoTemplate.html">BajoTemplate</a></div><div class="sidebar-section-children"><a href="BajoTemplate.html">BajoTemplate</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-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#TImportsResult">TImportsResult</a></div><div class="sidebar-section-children"><a href="global.html#factory">factory</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>
|
|
@@ -0,0 +1,6 @@
|
|
|
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: Imports</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">BajoTemplate 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="BajoTemplate.html">BajoTemplate</a></div><div class="sidebar-section-children"><a href="BajoTemplate.html">BajoTemplate</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-Imports.html">Imports</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#TImportsResult">TImportsResult</a></div><div class="sidebar-section-children"><a href="global.html#factory">factory</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-template" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/bajo-template" 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>Functions and types for <a href="BajoTemplate.html#buildCompileImports">BajoTemplate.buildCompileImports</a></p><p>With these functions now your templates can use all listed functions below. The imports are automatically injected into the template's scope during compilation.</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="lib_imports.js.html">lib/imports.js</a>, <a href="lib_imports.js.html#line1">line 1</a></li></ul></dd></div></dl><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Example</strong><div class="rel"><pre class="prettyprint"><code>// In your template file (e.g., template.html)
|
|
4
|
+
<p><%= _t('Hello, %s!', user.name) %></p>
|
|
5
|
+
<p><%= _format(user.birthDate, 'date') %></p>
|
|
6
|
+
<p><%= _routePath('home:/user/{id}/profile', { id: user.id }) %></p></code></pre></div></div></div><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id="~FnDump"><span class="type-signature">(inner) </span>FnDump<span class="signature">(value)</span></h3><div class="description"><p>Dump a value to console.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>value</code></td><td class="type"><span class="param-type">*</span></td><td class="description last"><p>Value to be dumped.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_imports.js.html">lib/imports.js</a>, <a href="lib_imports.js.html#line129">line 129</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li><a href="BajoTemplate.html#buildCompileImports">BajoTemplate.buildCompileImports</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="~FnExcerpt"><span class="type-signature">(inner) </span>FnExcerpt<span class="signature">(text, maxWords<span class="signature-attributes">opt</span>, trailChars<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Get excerpt of a string.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>text</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>String to be excerpted.</p></td></tr><tr><td class="name"><code>maxWords</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">50</td><td class="description last"><p>Max number of words.</p></td></tr><tr><td class="name"><code>trailChars</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="default">'...'</td><td class="description last"><p>Characters to append if truncated.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_imports.js.html">lib/imports.js</a>, <a href="lib_imports.js.html#line116">line 116</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li><a href="BajoTemplate.html#getExcerpt">BajoTemplate.getExcerpt</a></li><li><a href="BajoTemplate.html#buildCompileImports">BajoTemplate.buildCompileImports</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Excerpted string.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="~FnFindRoute"><span class="type-signature">(inner) </span>FnFindRoute<span class="signature">(name, method<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {object|null}</span></h3><div class="description"><p>Find route by name. Only available when Waibu plugin is installed & loaded.</p><p>See <a href="https://ardhi.github.io/waibu/Waibu.html#findRoute">Waibu.findRoute</a> for more details.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>name</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Route name.</p></td></tr><tr><td class="name"><code>method</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="default">'GET'</td><td class="description last"><p>HTTP method (e.g., 'GET', 'POST').</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_imports.js.html">lib/imports.js</a>, <a href="lib_imports.js.html#line41">line 41</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li><a href="https://ardhi.github.io/waibu/Waibu.html#findRoute">Waibu.findRoute</a></li><li><a href="BajoTemplate.html#buildCompileImports">BajoTemplate.buildCompileImports</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Route object or null if not found.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">object</span> |<wbr> <span class="param-type">null</span></dd></dl></div><h3 class="name has-anchor" id="~FnFormat"><span class="type-signature">(inner) </span>FnFormat<span class="signature">(val, type, opts<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Format text with optional parameters.</p><p>See <a href="https://ardhi.github.io/bajo/Bajo.html#format">Bajo.format</a> for more details.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>val</code></td><td class="type"><span class="param-type">*</span></td><td class="attributes"></td><td class="description last"><p>Value to be formatted.</p></td></tr><tr><td class="name"><code>type</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="description last"><p>Value type (e.g., 'string', 'number', 'date').</p></td></tr><tr><td class="name"><code>opts</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="description last"><p>Optional formatting options.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_imports.js.html">lib/imports.js</a>, <a href="lib_imports.js.html#line26">line 26</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li><a href="https://ardhi.github.io/bajo/Bajo.html#format">Bajo.format</a></li><li><a href="BajoTemplate.html#buildCompileImports">BajoTemplate.buildCompileImports</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Formatted text.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="~FnGetSetting"><span class="type-signature">(inner) </span>FnGetSetting<span class="signature">(key)</span><span class="type-signature"> → {*}</span></h3><div class="description"><p>Get a setting value by key. Only available when Waibu plugin is installed & loaded.</p><p>See <a href="https://ardhi.github.io/waibu/Waibu.html#getSetting">Waibu.getSetting</a> for more details.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>key</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>Setting key.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_imports.js.html">lib/imports.js</a>, <a href="lib_imports.js.html#line138">line 138</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li><a href="https://ardhi.github.io/waibu/Waibu.html#getSetting">Waibu.getSetting</a></li><li><a href="BajoTemplate.html#buildCompileImports">BajoTemplate.buildCompileImports</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Setting value.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">*</span></dd></dl></div><h3 class="name has-anchor" id="~FnHasPlugin"><span class="type-signature">(inner) </span>FnHasPlugin<span class="signature">(nameOrAlias)</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Check if a plugin is loaded by its name or alias.</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>nameOrAlias</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>Plugin name or alias.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_imports.js.html">lib/imports.js</a>, <a href="lib_imports.js.html#line79">line 79</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li><a href="BajoTemplate.html#buildCompileImports">BajoTemplate.buildCompileImports</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>True if the plugin is loaded, false otherwise.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id="~FnJsonStringify"><span class="type-signature">(inner) </span>FnJsonStringify<span class="signature">(value, replacer<span class="signature-attributes">opt</span>, space<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>JSON stringify a value. Only available when WaibuMpa plugin is installed & loaded.</p><p>See <a href="https://ardhi.github.io/waibu/WaibuMpa.html#jsonStringify">WaibuMpa.jsonStringify</a> for more details.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>value</code></td><td class="type"><span class="param-type">*</span></td><td class="attributes"></td><td class="description last"><p>Value to be stringified.</p></td></tr><tr><td class="name"><code>replacer</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="description last"><p>Optional replacer function or array.</p></td></tr><tr><td class="name"><code>space</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="description last"><p>Optional space for indentation.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_imports.js.html">lib/imports.js</a>, <a href="lib_imports.js.html#line89">line 89</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li><a href="https://ardhi.github.io/waibu/WaibuMpa.html#jsonStringify">WaibuMpa.jsonStringify</a></li><li><a href="BajoTemplate.html#buildCompileImports">BajoTemplate.buildCompileImports</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>JSON stringified value.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="~FnParseMarkdown"><span class="type-signature">(inner) </span>FnParseMarkdown<span class="signature">(value)</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Parse markdown text. Only available when BajoMarkdown plugin is installed & loaded. See <a href="https://ardhi.github.io/bajo/BajoMarkdown.html#parse">BajoMarkdown.parse</a> for more details.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>value</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>Markdown text to be parsed.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_imports.js.html">lib/imports.js</a>, <a href="lib_imports.js.html#line104">line 104</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li><a href="https://ardhi.github.io/bajo/BajoMarkdown.html#parse">BajoMarkdown.parse</a></li><li><a href="BajoTemplate.html#buildCompileImports">BajoTemplate.buildCompileImports</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Parsed HTML string.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="~FnRoutePath"><span class="type-signature">(inner) </span>FnRoutePath<span class="signature">(name, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string|null}</span></h3><div class="description"><p>Get route path by name. Only available when Waibu plugin is installed & loaded.</p><p>See <a href="https://ardhi.github.io/waibu/Waibu.html#routePath">Waibu.routePath</a> for more details.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>name</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Route name.</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Options object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_imports.js.html">lib/imports.js</a>, <a href="lib_imports.js.html#line55">line 55</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li><a href="https://ardhi.github.io/waibu/Waibu.html#routePath">Waibu.routePath</a></li><li><a href="BajoTemplate.html#buildCompileImports">BajoTemplate.buildCompileImports</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Route path or null if not found.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span> |<wbr> <span class="param-type">null</span></dd></dl></div><h3 class="name has-anchor" id="~FnTitleize"><span class="type-signature">(inner) </span>FnTitleize<span class="signature">(str)</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Get titleized version of a string.</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>str</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>String to be titleized.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_imports.js.html">lib/imports.js</a>, <a href="lib_imports.js.html#line69">line 69</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li><a href="BajoTemplate.html#buildCompileImports">BajoTemplate.buildCompileImports</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Titleized string.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="~FnTranslate"><span class="type-signature">(inner) </span>FnTranslate<span class="signature">(text, …args)</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Translate text with optional parameters.</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>text</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="description last"><p>Text to be translated.</p></td></tr><tr><td class="name"><code>args</code></td><td class="type"><span class="param-type">*</span></td><td class="attributes"><repeatable><br></td><td class="description last"><p>Optional parameters for translation.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_imports.js.html">lib/imports.js</a>, <a href="lib_imports.js.html#line15">line 15</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li><a href="BajoTemplate.html#buildCompileImports">BajoTemplate.buildCompileImports</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Translated text.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></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">BajoTemplate API</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/bajo-template" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/bajo-template" 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="BajoTemplate.html">BajoTemplate</a></div><div class="sidebar-section-children"><a href="BajoTemplate.html">BajoTemplate</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-Imports.html">Imports</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#TImportsResult">TImportsResult</a></div><div class="sidebar-section-children"><a href="global.html#factory">factory</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>
|