aneka 0.17.4 → 0.17.5
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/CHANGES.md +1 -0
- package/docs/data/search.json +1 -1
- package/docs/global.html +1 -1
- package/docs/set-interval.js.html +5 -2
- package/package.json +1 -1
- package/src/set-interval.js +5 -2
package/CHANGES.md
CHANGED
package/docs/data/search.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"list":[{"title":"arrangeArray","link":"<a href=\"global.html#arrangeArray\">arrangeArray</a>","description":"<p>Reorders items by handling '^' (move to front) and '$' (move to end) prefixes.</p>"},{"title":"createClass","link":"<a href=\"global.html#createClass\">createClass</a>","description":"<p>Creates a dynamic class and optionally extends a parent class.</p>"},{"title":"currentLoc","link":"<a href=\"global.html#currentLoc\">currentLoc</a>","description":"<p>Get current directory & file.\nAn attempt to brings back the old <code>__dirname</code> and <code>__filename</code> to the ES6 era.</p>\n<p>Returns object with the following keys:</p>\n<ul>\n<li><code>__dirname</code> (aliases to <code>dir</code>) - current directory name</li>\n<li><code>__filename</code> (aliases to <code>file</code>) - current file path</li>\n</ul>\n<p>Example:</p>\n<pre class=\"prettyprint source lang-javascript\"><code>const { importModule } = this.app.bajo\nconst currentLoc = await importModule('bajo:/lib/current-loc.js')\n\nconst { __dirname, __filename } = currentLoc(import.meta)\nconsole.log(__dirname, __filename)\n</code></pre>"},{"title":"defaultsDeep","link":"<a href=\"global.html#defaultsDeep\">defaultsDeep</a>","description":"<p>Deep-merges objects while replacing arrays from higher-priority inputs.</p>"},{"title":"delay","link":"<a href=\"global.html#delay\">delay</a>","description":"<p>Waits for a duration and resolves a promise.</p>"},{"title":"extractText","link":"<a href=\"global.html#extractText\">extractText</a>","description":"<p>Extracts text between two boundary patterns.</p>"},{"title":"fillObject","link":"<a href=\"global.html#fillObject\">fillObject</a>","description":"<p>Fill object with keys. <code>defValue</code> is used if the corresponding key doesn't have value</p>"},{"title":"filterDuplicate","link":"<a href=\"global.html#filterDuplicate\">filterDuplicate</a>","description":"<p>Filter array of duplicates</p>"},{"title":"filterIndex","link":"<a href=\"global.html#filterIndex\">filterIndex</a>","description":"<p>Filter array's indexes</p>"},{"title":"formatText","link":"<a href=\"global.html#formatText\">formatText</a>","description":"<p>Format text according using sprintf with extra ability to run its arguments through a serie of modifiers\nModifier must be place right after a token prepended with pipe ``|``` symbols.\nYou can put as many mofifiers as you want.</p>\n<p>E.g:</p>\n<pre class=\"prettyprint source lang-javascript\"><code>const text = 'Collected %s|toLower|upperFirst: %d'\nconst result = this.app.lib.formatText(text, 'iTeMs', 10)\nconsole.log(result) // Collected Items: 10\n</code></pre>"},{"title":"getCallerFilename","link":"<a href=\"global.html#getCallerFilename\">getCallerFilename</a>","description":"<p>Returns the caller file path from the current stack trace.</p>"},{"title":"getGlobalModuleDir","link":"<a href=\"global.html#getGlobalModuleDir\">getGlobalModuleDir</a>","description":"<p>Get the node global module directory.</p>"},{"title":"getIndex","link":"<a href=\"global.html#getIndex\">getIndex</a>","description":"<p>Returns indexes of items that match a predicate.</p>"},{"title":"getKeyByValue","link":"<a href=\"global.html#getKeyByValue\">getKeyByValue</a>","description":"<p>Finds an object key by value.</p>"},{"title":"includes","link":"<a href=\"global.html#includes\">includes</a>","description":"<p>Checks whether at least one matcher value exists in an array.</p>"},{"title":"isClass","link":"<a href=\"global.html#isClass\">isClass</a>","description":"<p>Checks whether a value appears to be a class constructor.</p>"},{"title":"isSet","link":"<a href=\"global.html#isSet\">isSet</a>","description":"<p>Checks whether a value is neither null nor undefined.</p>"},{"title":"mergeObjectsByKey","link":"<a href=\"global.html#mergeObjectsByKey\">mergeObjectsByKey</a>","description":"<p>Merges objects by a shared key, where later objects override earlier fields.</p>"},{"title":"module.exports","link":"<a href=\"module.html#.exports\">exports</a>","description":"<p>Converts seconds (or milliseconds) to HH:MM:SS string.</p>"},{"title":"module:Lib.generateId","link":"<a href=\"module-Lib.html#.generateId\">generateId</a>","description":"<p>Generate unique random characters that can be used as ID. Use {@link https://github.com/ai/nanoid|nanoid} under the hood</p>"},{"title":"paginate","link":"<a href=\"global.html#paginate\">paginate</a>","description":"<p>Paginates and optionally sorts a collection.</p>"},{"title":"parseArgsArgv","link":"<a href=\"global.html#parseArgsArgv\">parseArgsArgv</a>","description":"<p>Parse program arguments (args) & options (argv)</p>"},{"title":"parseDuration","link":"<a href=\"global.html#parseDuration\">parseDuration</a>","description":"<p>Parse duration to its millisecond value. Use {@link https://github.com/vercel/ms|ms} under the hood</p>"},{"title":"parseEnv","link":"<a href=\"global.html#parseEnv\">parseEnv</a>","description":"<p>Parse environment variables</p>"},{"title":"parseKvString","link":"<a href=\"global.html#parseKvString\">parseKvString</a>","description":"<p>Parses key-value text into an object and normalizes primitive types.</p>"},{"title":"parseObject","link":"<a href=\"global.html#parseObject\">parseObject</a>","description":"<p>Parses an object (or JSON string) and recursively normalizes nested values.</p>\n<p>When <code>options.parseValue</code> is enabled, string values are converted using\ndotenv-parse-variables rules (for example booleans, numbers, arrays, and null),\nincluding values inside arrays and nested objects.</p>\n<p>Special key handling:</p>\n<ul>\n<li>Keys ending with <code>Dur</code> are converted to milliseconds using parseDuration.</li>\n<li>Keys ending with <code>Dt</code> are converted to Unix timestamps using Date.parse.</li>\n<li><code>options.translator</code> can translate prefixed keys/values before normalization.</li>\n</ul>"},{"title":"pascalCase","link":"<a href=\"global.html#pascalCase\">pascalCase</a>","description":"<p>Converts text into PascalCase.</p>"},{"title":"randomRange","link":"<a href=\"global.html#randomRange\">randomRange</a>","description":"<p>Generate random value.</p>"},{"title":"resolvePath","link":"<a href=\"global.html#resolvePath\">resolvePath</a>","description":"<p>Resolve file name to filesystem's path. Windows path separator <code>\\</code>\nis normalized to Unix's <code>/</code></p>"},{"title":"round","link":"<a href=\"global.html#round\">round</a>","description":"<p>Rounds a number using decimal precision.</p>"},{"title":"setImmediate","link":"<a href=\"global.html#setImmediate\">setImmediate</a>","description":"<p>Schedules execution on the next immediate cycle and resolves when it runs.</p>"},{"title":"setInterval","link":"<a href=\"global.html#setInterval\">setInterval</a>","description":"<p>Like original setInterval, but repeatedly executes a function after a specified delay asynchronously.</p>\n<p>Function handler will only be executed if the previous execution has completed. This prevents\noverlapping executions.</p>\n<p>Optionally using a lock file.</p>"},{"title":"setTimeout","link":"<a href=\"global.html#setTimeout\">setTimeout</a>","description":"<p>Like original setTimeout, but executes a function after a specified delay asynchronously.\nOptionally using a lock file.</p>"},{"title":"shim","link":"<a href=\"global.html#shim\">shim</a>","description":"<p>Attaches missing String polyfills when they are not available in the current runtime.\nAdds <code>String.prototype.replaceAll</code> and <code>String.prototype.splice</code> if needed.</p>"},{"title":"textToArray","link":"<a href=\"global.html#textToArray\">textToArray</a>","description":"<p>Converts multiline text into a cleaned array and removes comments.</p>"},{"title":"titleize","link":"<a href=\"global.html#titleize\">titleize</a>","description":"<p>Converts text to title case with optional ignore and replacement rules.</p>"},{"title":"without","link":"<a href=\"global.html#without\">without</a>","description":"<p>Returns an array without provided values and empty-like entries.</p>"}]}
|
|
1
|
+
{"list":[{"title":"arrangeArray","link":"<a href=\"global.html#arrangeArray\">arrangeArray</a>","description":"<p>Reorders items by handling '^' (move to front) and '$' (move to end) prefixes.</p>"},{"title":"createClass","link":"<a href=\"global.html#createClass\">createClass</a>","description":"<p>Creates a dynamic class and optionally extends a parent class.</p>"},{"title":"currentLoc","link":"<a href=\"global.html#currentLoc\">currentLoc</a>","description":"<p>Get current directory & file.\nAn attempt to brings back the old <code>__dirname</code> and <code>__filename</code> to the ES6 era.</p>\n<p>Returns object with the following keys:</p>\n<ul>\n<li><code>__dirname</code> (aliases to <code>dir</code>) - current directory name</li>\n<li><code>__filename</code> (aliases to <code>file</code>) - current file path</li>\n</ul>\n<p>Example:</p>\n<pre class=\"prettyprint source lang-javascript\"><code>const { importModule } = this.app.bajo\nconst currentLoc = await importModule('bajo:/lib/current-loc.js')\n\nconst { __dirname, __filename } = currentLoc(import.meta)\nconsole.log(__dirname, __filename)\n</code></pre>"},{"title":"defaultsDeep","link":"<a href=\"global.html#defaultsDeep\">defaultsDeep</a>","description":"<p>Deep-merges objects while replacing arrays from higher-priority inputs.</p>"},{"title":"delay","link":"<a href=\"global.html#delay\">delay</a>","description":"<p>Waits for a duration and resolves a promise.</p>"},{"title":"extractText","link":"<a href=\"global.html#extractText\">extractText</a>","description":"<p>Extracts text between two boundary patterns.</p>"},{"title":"fillObject","link":"<a href=\"global.html#fillObject\">fillObject</a>","description":"<p>Fill object with keys. <code>defValue</code> is used if the corresponding key doesn't have value</p>"},{"title":"filterDuplicate","link":"<a href=\"global.html#filterDuplicate\">filterDuplicate</a>","description":"<p>Filter array of duplicates</p>"},{"title":"filterIndex","link":"<a href=\"global.html#filterIndex\">filterIndex</a>","description":"<p>Filter array's indexes</p>"},{"title":"formatText","link":"<a href=\"global.html#formatText\">formatText</a>","description":"<p>Format text according using sprintf with extra ability to run its arguments through a serie of modifiers\nModifier must be place right after a token prepended with pipe ``|``` symbols.\nYou can put as many mofifiers as you want.</p>\n<p>E.g:</p>\n<pre class=\"prettyprint source lang-javascript\"><code>const text = 'Collected %s|toLower|upperFirst: %d'\nconst result = this.app.lib.formatText(text, 'iTeMs', 10)\nconsole.log(result) // Collected Items: 10\n</code></pre>"},{"title":"getCallerFilename","link":"<a href=\"global.html#getCallerFilename\">getCallerFilename</a>","description":"<p>Returns the caller file path from the current stack trace.</p>"},{"title":"getGlobalModuleDir","link":"<a href=\"global.html#getGlobalModuleDir\">getGlobalModuleDir</a>","description":"<p>Get the node global module directory.</p>"},{"title":"getIndex","link":"<a href=\"global.html#getIndex\">getIndex</a>","description":"<p>Returns indexes of items that match a predicate.</p>"},{"title":"getKeyByValue","link":"<a href=\"global.html#getKeyByValue\">getKeyByValue</a>","description":"<p>Finds an object key by value.</p>"},{"title":"includes","link":"<a href=\"global.html#includes\">includes</a>","description":"<p>Checks whether at least one matcher value exists in an array.</p>"},{"title":"isClass","link":"<a href=\"global.html#isClass\">isClass</a>","description":"<p>Checks whether a value appears to be a class constructor.</p>"},{"title":"isSet","link":"<a href=\"global.html#isSet\">isSet</a>","description":"<p>Checks whether a value is neither null nor undefined.</p>"},{"title":"mergeObjectsByKey","link":"<a href=\"global.html#mergeObjectsByKey\">mergeObjectsByKey</a>","description":"<p>Merges objects by a shared key, where later objects override earlier fields.</p>"},{"title":"module.exports","link":"<a href=\"module.html#.exports\">exports</a>","description":"<p>Converts seconds (or milliseconds) to HH:MM:SS string.</p>"},{"title":"module:Lib.generateId","link":"<a href=\"module-Lib.html#.generateId\">generateId</a>","description":"<p>Generate unique random characters that can be used as ID. Use {@link https://github.com/ai/nanoid|nanoid} under the hood</p>"},{"title":"paginate","link":"<a href=\"global.html#paginate\">paginate</a>","description":"<p>Paginates and optionally sorts a collection.</p>"},{"title":"parseArgsArgv","link":"<a href=\"global.html#parseArgsArgv\">parseArgsArgv</a>","description":"<p>Parse program arguments (args) & options (argv)</p>"},{"title":"parseDuration","link":"<a href=\"global.html#parseDuration\">parseDuration</a>","description":"<p>Parse duration to its millisecond value. Use {@link https://github.com/vercel/ms|ms} under the hood</p>"},{"title":"parseEnv","link":"<a href=\"global.html#parseEnv\">parseEnv</a>","description":"<p>Parse environment variables</p>"},{"title":"parseKvString","link":"<a href=\"global.html#parseKvString\">parseKvString</a>","description":"<p>Parses key-value text into an object and normalizes primitive types.</p>"},{"title":"parseObject","link":"<a href=\"global.html#parseObject\">parseObject</a>","description":"<p>Parses an object (or JSON string) and recursively normalizes nested values.</p>\n<p>When <code>options.parseValue</code> is enabled, string values are converted using\ndotenv-parse-variables rules (for example booleans, numbers, arrays, and null),\nincluding values inside arrays and nested objects.</p>\n<p>Special key handling:</p>\n<ul>\n<li>Keys ending with <code>Dur</code> are converted to milliseconds using parseDuration.</li>\n<li>Keys ending with <code>Dt</code> are converted to Unix timestamps using Date.parse.</li>\n<li><code>options.translator</code> can translate prefixed keys/values before normalization.</li>\n</ul>"},{"title":"pascalCase","link":"<a href=\"global.html#pascalCase\">pascalCase</a>","description":"<p>Converts text into PascalCase.</p>"},{"title":"randomRange","link":"<a href=\"global.html#randomRange\">randomRange</a>","description":"<p>Generate random value.</p>"},{"title":"resolvePath","link":"<a href=\"global.html#resolvePath\">resolvePath</a>","description":"<p>Resolve file name to filesystem's path. Windows path separator <code>\\</code>\nis normalized to Unix's <code>/</code></p>"},{"title":"round","link":"<a href=\"global.html#round\">round</a>","description":"<p>Rounds a number using decimal precision.</p>"},{"title":"setImmediate","link":"<a href=\"global.html#setImmediate\">setImmediate</a>","description":"<p>Schedules execution on the next immediate cycle and resolves when it runs.</p>"},{"title":"setInterval","link":"<a href=\"global.html#setInterval\">setInterval</a>","description":"<p>Like original setInterval, but repeatedly executes a function after a specified delay asynchronously.</p>\n<p>Function handler will only be executed if the previous execution has completed. This prevents\noverlapping executions.</p>\n<p>Optionally using a lock file. If it is provided and the lock file does not exist, it will be created.\nIf the lock file exists and is locked, the handler will not be executed.</p>"},{"title":"setTimeout","link":"<a href=\"global.html#setTimeout\">setTimeout</a>","description":"<p>Like original setTimeout, but executes a function after a specified delay asynchronously.\nOptionally using a lock file.</p>"},{"title":"shim","link":"<a href=\"global.html#shim\">shim</a>","description":"<p>Attaches missing String polyfills when they are not available in the current runtime.\nAdds <code>String.prototype.replaceAll</code> and <code>String.prototype.splice</code> if needed.</p>"},{"title":"textToArray","link":"<a href=\"global.html#textToArray\">textToArray</a>","description":"<p>Converts multiline text into a cleaned array and removes comments.</p>"},{"title":"titleize","link":"<a href=\"global.html#titleize\">titleize</a>","description":"<p>Converts text to title case with optional ignore and replacement rules.</p>"},{"title":"without","link":"<a href=\"global.html#without\">without</a>","description":"<p>Returns an array without provided values and empty-like entries.</p>"}]}
|
package/docs/global.html
CHANGED
|
@@ -8,5 +8,5 @@ console.log(__dirname, __filename)
|
|
|
8
8
|
</code></pre></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>metaImport</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p><code>import.meta</code> 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="current-loc.js.html">current-loc.js</a>, <a href="current-loc.js.html#line25">line 25</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Object</span></dd></dl></div><h3 class="name has-anchor" id="defaultsDeep"><span class="type-signature"></span>defaultsDeep<span class="signature">(…args)</span><span class="type-signature"> → {Object}</span></h3><div class="description"><p>Deep-merges objects while replacing arrays from higher-priority inputs.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>args</code></td><td class="type"><span class="param-type">Object</span></td><td class="attributes"><repeatable><br></td><td class="description last"><p>Objects to merge.</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="defaults-deep.js.html">defaults-deep.js</a>, <a href="defaults-deep.js.html#line10">line 10</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Merged object.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Object</span></dd></dl></div><h3 class="name has-anchor" id="delay"><span class="type-signature"></span>delay<span class="signature">(ms<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description"><p>Waits for a duration and resolves a promise.</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>ms</code></td><td class="type"><span class="param-type">number</span> |<wbr> <span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="default">1000</td><td class="description last"><p>Delay in milliseconds or a duration string.</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="delay.js.html">delay.js</a>, <a href="delay.js.html#line9">line 9</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Promise resolved after the delay.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><h3 class="name has-anchor" id="extractText"><span class="type-signature"></span>extractText<span class="signature">(text, patternStart, patternEnd)</span><span class="type-signature"> → {Object}</span></h3><div class="description"><p>Extracts text between two boundary patterns.</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>text</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>Source text.</p></td></tr><tr><td class="name"><code>patternStart</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>Start marker.</p></td></tr><tr><td class="name"><code>patternEnd</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>End marker.</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="extract-text.js.html">extract-text.js</a>, <a href="extract-text.js.html#line9">line 9</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Extracted value and matched pattern.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Object</span></dd></dl></div><h3 class="name has-anchor" id="fillObject"><span class="type-signature"></span>fillObject<span class="signature">(obj, keys, defValue)</span><span class="type-signature"> → {Object}</span></h3><div class="description"><p>Fill object with keys. <code>defValue</code> is used if the corresponding key doesn't have value</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>obj</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>Object to fill</p></td></tr><tr><td class="name"><code>keys</code></td><td class="type"><span class="param-type">Array.<string></span></td><td class="description last"><p>Array of keys</p></td></tr><tr><td class="name"><code>defValue</code></td><td class="type"><span class="param-type">any</span></td><td class="description last"><p>Default value</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="fill-object.js.html">fill-object.js</a>, <a href="fill-object.js.html#line9">line 9</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Object</span></dd></dl></div><h3 class="name has-anchor" id="filterDuplicate"><span class="type-signature"></span>filterDuplicate<span class="signature">(inputs, key)</span></h3><div class="description"><p>Filter array of duplicates</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>inputs</code></td><td class="type"><span class="param-type">Array</span></td><td class="description last"><p>Array to filter from. Must be an array of objects</p></td></tr><tr><td class="name"><code>key</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>Key's 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="filter-duplicate.js.html">filter-duplicate.js</a>, <a href="filter-duplicate.js.html#line8">line 8</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="filterIndex"><span class="type-signature"></span>filterIndex<span class="signature">(inputs, matcher)</span><span class="type-signature"> → {Array}</span></h3><div class="description"><p>Filter array's indexes</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>inputs</code></td><td class="type"><span class="param-type">Array</span></td><td class="description last"><p>Array to filter from</p></td></tr><tr><td class="name"><code>matcher</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>Function to match conditions. If returns <code>true</code>, the running index will be added to the result</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="filter-index.js.html">filter-index.js</a>, <a href="filter-index.js.html#line9">line 9</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Filtered indexes</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array</span></dd></dl></div><h3 class="name has-anchor" id="formatText"><span class="type-signature"></span>formatText<span class="signature">(text, …args)</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Format text according using sprintf with extra ability to run its arguments through a serie of modifiers Modifier must be place right after a token prepended with pipe ``|``` symbols. You can put as many mofifiers as you want.</p><p>E.g:</p><pre class="prettyprint source lang-javascript"><code>const text = 'Collected %s|toLower|upperFirst: %d'
|
|
9
9
|
const result = this.app.lib.formatText(text, 'iTeMs', 10)
|
|
10
10
|
console.log(result) // Collected Items: 10
|
|
11
|
-
</code></pre></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 formatted</p></td></tr><tr><td class="name"><code>args</code></td><td class="type"><span class="param-type">any</span></td><td class="attributes"><repeatable><br></td><td class="description last"><p>Argumennts</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="format-text.js.html">format-text.js</a>, <a href="format-text.js.html#line59">line 59</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="getCallerFilename"><span class="type-signature"></span>getCallerFilename<span class="signature">()</span><span class="type-signature"> → {string|undefined}</span></h3><div class="description"><p>Returns the caller file path from the current stack trace.</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="get-caller-filename.js.html">get-caller-filename.js</a>, <a href="get-caller-filename.js.html#line6">line 6</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Caller file path.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span> |<wbr> <span class="param-type">undefined</span></dd></dl></div><h3 class="name has-anchor" id="getGlobalModuleDir"><span class="type-signature"></span>getGlobalModuleDir<span class="signature">()</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Get the node global module directory.</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="get-global-module-dir.js.html">get-global-module-dir.js</a>, <a href="get-global-module-dir.js.html#line9">line 9</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Absolute path to the global module directory</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="getIndex"><span class="type-signature"></span>getIndex<span class="signature">(inputs, matcher)</span><span class="type-signature"> → {Array.<number>}</span></h3><div class="description"><p>Returns indexes of items that match a predicate.</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>inputs</code></td><td class="type"><span class="param-type">Array.<any></span></td><td class="description last"><p>Input array.</p></td></tr><tr><td class="name"><code>matcher</code></td><td class="type"><span class="param-type">function</span></td><td class="description last"><p>Predicate function.</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="get-index.js.html">get-index.js</a>, <a href="get-index.js.html#line8">line 8</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Matching indexes.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array.<number></span></dd></dl></div><h3 class="name has-anchor" id="getKeyByValue"><span class="type-signature"></span>getKeyByValue<span class="signature">(object, value)</span><span class="type-signature"> → {string|undefined}</span></h3><div class="description"><p>Finds an object key by value.</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>object</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>Source object.</p></td></tr><tr><td class="name"><code>value</code></td><td class="type"><span class="param-type">any</span></td><td class="description last"><p>Value to find.</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="get-key-by-value.js.html">get-key-by-value.js</a>, <a href="get-key-by-value.js.html#line8">line 8</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Matching key.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span> |<wbr> <span class="param-type">undefined</span></dd></dl></div><h3 class="name has-anchor" id="includes"><span class="type-signature"></span>includes<span class="signature">(matcher<span class="signature-attributes">opt</span>, array<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Checks whether at least one matcher value exists in an array.</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>matcher</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">Array.<string></span></td><td class="attributes"><optional><br></td><td class="default">[]</td><td class="description last"><p>Single matcher or list of matchers.</p></td></tr><tr><td class="name"><code>array</code></td><td class="type"><span class="param-type">Array.<string></span></td><td class="attributes"><optional><br></td><td class="default">[]</td><td class="description last"><p>Array to inspect.</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="includes.js.html">includes.js</a>, <a href="includes.js.html#line8">line 8</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>True when any matcher is found.</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="isClass"><span class="type-signature"></span>isClass<span class="signature">(item)</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Checks whether a value appears to be a class constructor.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>item</code></td><td class="type"><span class="param-type">any</span></td><td class="description last"><p>Value to test.</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="is-class.js.html">is-class.js</a>, <a href="is-class.js.html#line7">line 7</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>True when item is class-like.</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="isSet"><span class="type-signature"></span>isSet<span class="signature">(item)</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Checks whether a value is neither null nor undefined.</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>item</code></td><td class="type"><span class="param-type">any</span></td><td class="description last"><p>Value to test.</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="is-set.js.html">is-set.js</a>, <a href="is-set.js.html#line7">line 7</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>True when value is set.</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="mergeObjectsByKey"><span class="type-signature"></span>mergeObjectsByKey<span class="signature">(inputs, key)</span><span class="type-signature"> → {Array.<Object>}</span></h3><div class="description"><p>Merges objects by a shared key, where later objects override earlier fields.</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>inputs</code></td><td class="type"><span class="param-type">Array.<Object></span></td><td class="description last"><p>Source objects.</p></td></tr><tr><td class="name"><code>key</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>Field name used for grouping.</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="merge-objects-by-key.js.html">merge-objects-by-key.js</a>, <a href="merge-objects-by-key.js.html#line8">line 8</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Merged objects.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array.<Object></span></dd></dl></div><h3 class="name has-anchor" id="paginate"><span class="type-signature"></span>paginate<span class="signature">(collection<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object|Array.<Object>|number|number|number|number}</span></h3><div class="description"><p>Paginates and optionally sorts a collection.</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>collection</code></td><td class="type"><span class="param-type">Array.<Object></span></td><td class="attributes"><optional><br></td><td class="default">[]</td><td class="description last"><p>Source collection.</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>Pagination options.</p><h6>Properties</h6><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>page</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">1</td><td class="description last"><p>1-based page number.</p></td></tr><tr><td class="name"><code>limit</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">25</td><td class="description last"><p>Items per page.</p></td></tr><tr><td class="name"><code>sort</code></td><td class="type"><span class="param-type">Object.<string, number></span></td><td class="attributes"><optional><br></td><td class="default"></td><td class="description last"><p>Sort descriptor where value < 0 means descending.</p></td></tr></tbody></table></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="paginate.js.html">paginate.js</a>, <a href="paginate.js.html#line21">line 21</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><ul><li><div class="param-desc"><p>Paginated result.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Object</span></dd></dl></li><li><div class="param-desc"><p>return.data Sliced page data.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array.<Object></span></dd></dl></li><li><div class="param-desc"><p>return.page Current page number.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">number</span></dd></dl></li><li><div class="param-desc"><p>return.limit Page size.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">number</span></dd></dl></li><li><div class="param-desc"><p>return.count Total items in source collection.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">number</span></dd></dl></li><li><div class="param-desc"><p>return.pages Total page count.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">number</span></dd></dl></li></ul></div><h3 class="name has-anchor" id="parseArgsArgv"><span class="type-signature">(async) </span>parseArgsArgv<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h3><div class="description"><p>Parse program arguments (args) & options (argv)</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>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><h6>Properties</h6><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>sanitizer</code></td><td class="type"><span class="param-type">function</span></td><td class="attributes"><optional><br></td><td class="description last"><p>If provided, result will be sanitized with this function</p></td></tr><tr><td class="name"><code>useParser</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="description last"><p>If <code>true</code>, skip <a href="https://github.com/yargs/yargs">yargs</a></p></td></tr><tr><td class="name"><code>cwd</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="description last"><p>If provided, current working directory is set to this</p></td></tr></tbody></table></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="parse-args-argv.js.html">parse-args-argv.js</a>, <a href="parse-args-argv.js.html#line61">line 61</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li>App#args</li><li>App#argv</li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>An object containing <code>args</code> and <code>argv</code></p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Object</span></dd></dl></div><h3 class="name has-anchor" id="parseDuration"><span class="type-signature"></span>parseDuration<span class="signature">(dur)</span><span class="type-signature"> → {number}</span></h3><div class="description"><p>Parse duration to its millisecond value. Use <a href="https://github.com/vercel/ms">ms</a> under the hood</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>dur</code></td><td class="type"><span class="param-type">number</span> |<wbr> <span class="param-type">string</span></td><td class="description last"><p>If string is given, parse this to its millisecond value. Otherwise returns as is</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="parse-duration.js.html">parse-duration.js</a>, <a href="parse-duration.js.html#line10">line 10</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://github.com/vercel/ms">ms</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">number</span></dd></dl></div><h3 class="name has-anchor" id="parseEnv"><span class="type-signature"></span>parseEnv<span class="signature">(sanitizer<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h3><div class="description"><p>Parse environment variables</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>sanitizer</code></td><td class="type"><span class="param-type">function</span></td><td class="attributes"><optional><br></td><td class="description last"><p>If provided, result will be sanitized with this function</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="parse-env.js.html">parse-env.js</a>, <a href="parse-env.js.html#line26">line 26</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Object</span></dd></dl></div><h3 class="name has-anchor" id="parseKvString"><span class="type-signature"></span>parseKvString<span class="signature">(text, trimValue<span class="signature-attributes">opt</span>, lineDelimiter<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h3><div class="description"><p>Parses key-value text into an object and normalizes primitive types.</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>Input key-value string.</p></td></tr><tr><td class="name"><code>trimValue</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="default">true</td><td class="description last"><p>Trim value parts.</p></td></tr><tr><td class="name"><code>lineDelimiter</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>Delimiter between lines.</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="parse-kv-string.js.html">parse-kv-string.js</a>, <a href="parse-kv-string.js.html#line11">line 11</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Parsed object.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Object</span></dd></dl></div><h3 class="name has-anchor" id="parseObject"><span class="type-signature"></span>parseObject<span class="signature">(input, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h3><div class="description"><p>Parses an object (or JSON string) and recursively normalizes nested values.</p><p>When <code>options.parseValue</code> is enabled, string values are converted using dotenv-parse-variables rules (for example booleans, numbers, arrays, and null), including values inside arrays and nested objects.</p><p>Special key handling:</p><ul><li>Keys ending with <code>Dur</code> are converted to milliseconds using parseDuration.</li><li>Keys ending with <code>Dt</code> are converted to Unix timestamps using Date.parse.</li><li><code>options.translator</code> can translate prefixed keys/values before normalization.</li></ul></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>input</code></td><td class="type"><span class="param-type">Object</span> |<wbr> <span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>If string is given, parse it first using JSON.parse.</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.</p><h6>Properties</h6><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>silent</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="default">true</td><td class="description last"><p>If <code>true</code>, parsing errors are ignored and values become undefined.</p></td></tr><tr><td class="name"><code>parseValue</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="default">false</td><td class="description last"><p>If <code>true</code>, values are parsed and normalized.</p></td></tr><tr><td class="name"><code>translator</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>Optional translator config for prefixed keys/values.</p></td></tr></tbody></table></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="parse-object.js.html">parse-object.js</a>, <a href="parse-object.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://github.com/ladjs/dotenv-parse-variables">https://github.com/ladjs/dotenv-parse-variables</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Parsed and normalized object.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Object</span></dd></dl></div><h3 class="name has-anchor" id="pascalCase"><span class="type-signature"></span>pascalCase<span class="signature">(text)</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Converts text into PascalCase.</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>text</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>Source text.</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="pascal-case.js.html">pascal-case.js</a>, <a href="pascal-case.js.html#line10">line 10</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Pascal-cased 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="randomRange"><span class="type-signature"></span>randomRange<span class="signature">(min, max, alpha)</span><span class="type-signature"> → {number|string}</span></h3><div class="description"><p>Generate random value.</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>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>min</code></td><td class="type"><span class="param-type">number</span></td><td class="default">0</td><td class="description last"><p>Minimum value (inclusive).</p></td></tr><tr><td class="name"><code>max</code></td><td class="type"><span class="param-type">number</span></td><td class="default">65439</td><td class="description last"><p>Maximum value (inclusive).</p></td></tr><tr><td class="name"><code>alpha</code></td><td class="type"><span class="param-type">boolean</span></td><td class="default">false</td><td class="description last"><p>Set <code>true</code> to return alphanumeric characters.</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="random-range.js.html">random-range.js</a>, <a href="random-range.js.html#line9">line 9</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Random value.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">number</span> |<wbr> <span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="resolvePath"><span class="type-signature"></span>resolvePath<span class="signature">(file, asFileUrl<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Resolve file name to filesystem's path. Windows path separator <code>\</code> is normalized to Unix's <code>/</code></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>file</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>File to resolve.</p></td></tr><tr><td class="name"><code>asFileUrl</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="default">false</td><td class="description last"><p>Return as file URL format <code>file:///<name></code>.</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="resolve-path.js.html">resolve-path.js</a>, <a href="resolve-path.js.html#line13">line 13</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="round"><span class="type-signature"></span>round<span class="signature">(val, scale<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {number}</span></h3><div class="description"><p>Rounds a number using decimal precision.</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>val</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Number to round.</p></td></tr><tr><td class="name"><code>scale</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">0</td><td class="description last"><p>Decimal places.</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="round.js.html">round.js</a>, <a href="round.js.html#line8">line 8</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Rounded number.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">number</span></dd></dl></div><h3 class="name has-anchor" id="setImmediate"><span class="type-signature">(async) </span>setImmediate<span class="signature">()</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description"><p>Schedules execution on the next immediate cycle and resolves when it runs.</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="set-immediate.js.html">set-immediate.js</a>, <a href="set-immediate.js.html#line6">line 6</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Promise resolved on the immediate queue.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><h3 class="name has-anchor" id="setInterval"><span class="type-signature">(async) </span>setInterval<span class="signature">(handler, timeout, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description"><p>Like original setInterval, but repeatedly executes a function after a specified delay asynchronously.</p><p>Function handler will only be executed if the previous execution has completed. This prevents overlapping executions.</p><p>Optionally using a lock file.</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>handler</code></td><td class="type"><span class="param-type">function</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The function to execute after the interval.</p></td></tr><tr><td class="name"><code>timeout</code></td><td class="type"><span class="param-type">number</span> |<wbr> <span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The delay in milliseconds or a duration string.</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>Additional options.</p><h6>Properties</h6><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>lockFile</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>The path to the lock file. If set, the handler will only execute if the lock can be acquired.</p></td></tr><tr><td class="name"><code>args</code></td><td class="type"><span class="param-type">Array</span></td><td class="attributes"><optional><br></td><td class="default">[]</td><td class="description last"><p>Arguments to pass to the handler.</p></td></tr><tr><td class="name"><code>lockFileOpts</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 for the lock file.</p></td></tr><tr><td class="name"><code>silent</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="default">true</td><td class="description last"><p>If true, errors during lock acquisition will be ignored.</p></td></tr><tr><td class="name"><code>maxIterations</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">Infinity</td><td class="description last"><p>Maximum number of times to execute the handler.</p></td></tr><tr><td class="name"><code>scope</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>The scope to bind the handler to.</p></td></tr></tbody></table></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="set-interval.js.html">set-interval.js</a>, <a href="set-interval.js.html#line23">line 23</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Promise resolved after the interval.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><h3 class="name has-anchor" id="setTimeout"><span class="type-signature">(async) </span>setTimeout<span class="signature">(handler, timeout, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description"><p>Like original setTimeout, but executes a function after a specified delay asynchronously. Optionally using a lock file.</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>handler</code></td><td class="type"><span class="param-type">function</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The function to execute after the timeout.</p></td></tr><tr><td class="name"><code>timeout</code></td><td class="type"><span class="param-type">number</span> |<wbr> <span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The delay in milliseconds or a duration string.</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>Additional options.</p><h6>Properties</h6><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>lockFile</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>The path to the lock file. If set, the handler will only execute if the lock can be acquired.</p></td></tr><tr><td class="name"><code>args</code></td><td class="type"><span class="param-type">Array</span></td><td class="attributes"><optional><br></td><td class="default">[]</td><td class="description last"><p>Arguments to pass to the handler.</p></td></tr><tr><td class="name"><code>lockFileOpts</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 for the lock file.</p></td></tr><tr><td class="name"><code>silent</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="default">true</td><td class="description last"><p>If true, errors during lock acquisition will be ignored.</p></td></tr><tr><td class="name"><code>scope</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>The scope to bind the handler to.</p></td></tr></tbody></table></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="set-timeout.js.html">set-timeout.js</a>, <a href="set-timeout.js.html#line18">line 18</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Promise resolved after the delay.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><h3 class="name has-anchor" id="shim"><span class="type-signature"></span>shim<span class="signature">()</span><span class="type-signature"> → {void}</span></h3><div class="description"><p>Attaches missing String polyfills when they are not available in the current runtime. Adds <code>String.prototype.replaceAll</code> and <code>String.prototype.splice</code> if needed.</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="shim.js.html">shim.js</a>, <a href="shim.js.html#line7">line 7</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">void</span></dd></dl></div><h3 class="name has-anchor" id="textToArray"><span class="type-signature"></span>textToArray<span class="signature">(text)</span><span class="type-signature"> → {Array.<string>}</span></h3><div class="description"><p>Converts multiline text into a cleaned array and removes comments.</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>text</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>Input text.</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="text-to-array.js.html">text-to-array.js</a>, <a href="text-to-array.js.html#line9">line 9</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Cleaned lines.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array.<string></span></dd></dl></div><h3 class="name has-anchor" id="titleize"><span class="type-signature"></span>titleize<span class="signature">(text<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Converts text to title case with optional ignore and replacement rules.</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"><optional><br></td><td class="default">''</td><td class="description last"><p>Source text.</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>Transformation options.</p><h6>Properties</h6><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>ignores</code></td><td class="type"><span class="param-type">Array.<string></span></td><td class="attributes"><optional><br></td><td class="default">[]</td><td class="description last"><p>Words that should remain unchanged.</p></td></tr><tr><td class="name"><code>replacement</code></td><td class="type"><span class="param-type">Object.<string, string></span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Exact token replacements.</p></td></tr></tbody></table></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="titleize.js.html">titleize.js</a>, <a href="titleize.js.html#line18">line 18</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Titleized 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="without"><span class="type-signature"></span>without<span class="signature">(arr<span class="signature-attributes">opt</span>, …params)</span><span class="type-signature"> → {Array.<any>}</span></h3><div class="description"><p>Returns an array without provided values and empty-like entries.</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>arr</code></td><td class="type"><span class="param-type">Array.<any></span></td><td class="attributes"><optional><br></td><td class="default">[]</td><td class="description last"><p>Source array.</p></td></tr><tr><td class="name"><code>params</code></td><td class="type"><span class="param-type">any</span></td><td class="attributes"><repeatable><br></td><td class="default"></td><td class="description last"><p>Values to exclude.</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="without.js.html">without.js</a>, <a href="without.js.html#line13">line 13</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Filtered array.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array.<any></span></dd></dl></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Example</strong><div class="rel"><pre class="prettyprint"><code>without([1, 2, null, '', 3, 2], 2)
|
|
11
|
+
</code></pre></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 formatted</p></td></tr><tr><td class="name"><code>args</code></td><td class="type"><span class="param-type">any</span></td><td class="attributes"><repeatable><br></td><td class="description last"><p>Argumennts</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="format-text.js.html">format-text.js</a>, <a href="format-text.js.html#line59">line 59</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="getCallerFilename"><span class="type-signature"></span>getCallerFilename<span class="signature">()</span><span class="type-signature"> → {string|undefined}</span></h3><div class="description"><p>Returns the caller file path from the current stack trace.</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="get-caller-filename.js.html">get-caller-filename.js</a>, <a href="get-caller-filename.js.html#line6">line 6</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Caller file path.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span> |<wbr> <span class="param-type">undefined</span></dd></dl></div><h3 class="name has-anchor" id="getGlobalModuleDir"><span class="type-signature"></span>getGlobalModuleDir<span class="signature">()</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Get the node global module directory.</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="get-global-module-dir.js.html">get-global-module-dir.js</a>, <a href="get-global-module-dir.js.html#line9">line 9</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Absolute path to the global module directory</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="getIndex"><span class="type-signature"></span>getIndex<span class="signature">(inputs, matcher)</span><span class="type-signature"> → {Array.<number>}</span></h3><div class="description"><p>Returns indexes of items that match a predicate.</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>inputs</code></td><td class="type"><span class="param-type">Array.<any></span></td><td class="description last"><p>Input array.</p></td></tr><tr><td class="name"><code>matcher</code></td><td class="type"><span class="param-type">function</span></td><td class="description last"><p>Predicate function.</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="get-index.js.html">get-index.js</a>, <a href="get-index.js.html#line8">line 8</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Matching indexes.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array.<number></span></dd></dl></div><h3 class="name has-anchor" id="getKeyByValue"><span class="type-signature"></span>getKeyByValue<span class="signature">(object, value)</span><span class="type-signature"> → {string|undefined}</span></h3><div class="description"><p>Finds an object key by value.</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>object</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>Source object.</p></td></tr><tr><td class="name"><code>value</code></td><td class="type"><span class="param-type">any</span></td><td class="description last"><p>Value to find.</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="get-key-by-value.js.html">get-key-by-value.js</a>, <a href="get-key-by-value.js.html#line8">line 8</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Matching key.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span> |<wbr> <span class="param-type">undefined</span></dd></dl></div><h3 class="name has-anchor" id="includes"><span class="type-signature"></span>includes<span class="signature">(matcher<span class="signature-attributes">opt</span>, array<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Checks whether at least one matcher value exists in an array.</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>matcher</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">Array.<string></span></td><td class="attributes"><optional><br></td><td class="default">[]</td><td class="description last"><p>Single matcher or list of matchers.</p></td></tr><tr><td class="name"><code>array</code></td><td class="type"><span class="param-type">Array.<string></span></td><td class="attributes"><optional><br></td><td class="default">[]</td><td class="description last"><p>Array to inspect.</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="includes.js.html">includes.js</a>, <a href="includes.js.html#line8">line 8</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>True when any matcher is found.</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="isClass"><span class="type-signature"></span>isClass<span class="signature">(item)</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Checks whether a value appears to be a class constructor.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>item</code></td><td class="type"><span class="param-type">any</span></td><td class="description last"><p>Value to test.</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="is-class.js.html">is-class.js</a>, <a href="is-class.js.html#line7">line 7</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>True when item is class-like.</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="isSet"><span class="type-signature"></span>isSet<span class="signature">(item)</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Checks whether a value is neither null nor undefined.</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>item</code></td><td class="type"><span class="param-type">any</span></td><td class="description last"><p>Value to test.</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="is-set.js.html">is-set.js</a>, <a href="is-set.js.html#line7">line 7</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>True when value is set.</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="mergeObjectsByKey"><span class="type-signature"></span>mergeObjectsByKey<span class="signature">(inputs, key)</span><span class="type-signature"> → {Array.<Object>}</span></h3><div class="description"><p>Merges objects by a shared key, where later objects override earlier fields.</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>inputs</code></td><td class="type"><span class="param-type">Array.<Object></span></td><td class="description last"><p>Source objects.</p></td></tr><tr><td class="name"><code>key</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>Field name used for grouping.</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="merge-objects-by-key.js.html">merge-objects-by-key.js</a>, <a href="merge-objects-by-key.js.html#line8">line 8</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Merged objects.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array.<Object></span></dd></dl></div><h3 class="name has-anchor" id="paginate"><span class="type-signature"></span>paginate<span class="signature">(collection<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object|Array.<Object>|number|number|number|number}</span></h3><div class="description"><p>Paginates and optionally sorts a collection.</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>collection</code></td><td class="type"><span class="param-type">Array.<Object></span></td><td class="attributes"><optional><br></td><td class="default">[]</td><td class="description last"><p>Source collection.</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>Pagination options.</p><h6>Properties</h6><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>page</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">1</td><td class="description last"><p>1-based page number.</p></td></tr><tr><td class="name"><code>limit</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">25</td><td class="description last"><p>Items per page.</p></td></tr><tr><td class="name"><code>sort</code></td><td class="type"><span class="param-type">Object.<string, number></span></td><td class="attributes"><optional><br></td><td class="default"></td><td class="description last"><p>Sort descriptor where value < 0 means descending.</p></td></tr></tbody></table></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="paginate.js.html">paginate.js</a>, <a href="paginate.js.html#line21">line 21</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><ul><li><div class="param-desc"><p>Paginated result.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Object</span></dd></dl></li><li><div class="param-desc"><p>return.data Sliced page data.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array.<Object></span></dd></dl></li><li><div class="param-desc"><p>return.page Current page number.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">number</span></dd></dl></li><li><div class="param-desc"><p>return.limit Page size.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">number</span></dd></dl></li><li><div class="param-desc"><p>return.count Total items in source collection.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">number</span></dd></dl></li><li><div class="param-desc"><p>return.pages Total page count.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">number</span></dd></dl></li></ul></div><h3 class="name has-anchor" id="parseArgsArgv"><span class="type-signature">(async) </span>parseArgsArgv<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h3><div class="description"><p>Parse program arguments (args) & options (argv)</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>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><h6>Properties</h6><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>sanitizer</code></td><td class="type"><span class="param-type">function</span></td><td class="attributes"><optional><br></td><td class="description last"><p>If provided, result will be sanitized with this function</p></td></tr><tr><td class="name"><code>useParser</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="description last"><p>If <code>true</code>, skip <a href="https://github.com/yargs/yargs">yargs</a></p></td></tr><tr><td class="name"><code>cwd</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="description last"><p>If provided, current working directory is set to this</p></td></tr></tbody></table></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="parse-args-argv.js.html">parse-args-argv.js</a>, <a href="parse-args-argv.js.html#line61">line 61</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li>App#args</li><li>App#argv</li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>An object containing <code>args</code> and <code>argv</code></p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Object</span></dd></dl></div><h3 class="name has-anchor" id="parseDuration"><span class="type-signature"></span>parseDuration<span class="signature">(dur)</span><span class="type-signature"> → {number}</span></h3><div class="description"><p>Parse duration to its millisecond value. Use <a href="https://github.com/vercel/ms">ms</a> under the hood</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>dur</code></td><td class="type"><span class="param-type">number</span> |<wbr> <span class="param-type">string</span></td><td class="description last"><p>If string is given, parse this to its millisecond value. Otherwise returns as is</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="parse-duration.js.html">parse-duration.js</a>, <a href="parse-duration.js.html#line10">line 10</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://github.com/vercel/ms">ms</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">number</span></dd></dl></div><h3 class="name has-anchor" id="parseEnv"><span class="type-signature"></span>parseEnv<span class="signature">(sanitizer<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h3><div class="description"><p>Parse environment variables</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>sanitizer</code></td><td class="type"><span class="param-type">function</span></td><td class="attributes"><optional><br></td><td class="description last"><p>If provided, result will be sanitized with this function</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="parse-env.js.html">parse-env.js</a>, <a href="parse-env.js.html#line26">line 26</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Object</span></dd></dl></div><h3 class="name has-anchor" id="parseKvString"><span class="type-signature"></span>parseKvString<span class="signature">(text, trimValue<span class="signature-attributes">opt</span>, lineDelimiter<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h3><div class="description"><p>Parses key-value text into an object and normalizes primitive types.</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>Input key-value string.</p></td></tr><tr><td class="name"><code>trimValue</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="default">true</td><td class="description last"><p>Trim value parts.</p></td></tr><tr><td class="name"><code>lineDelimiter</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>Delimiter between lines.</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="parse-kv-string.js.html">parse-kv-string.js</a>, <a href="parse-kv-string.js.html#line11">line 11</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Parsed object.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Object</span></dd></dl></div><h3 class="name has-anchor" id="parseObject"><span class="type-signature"></span>parseObject<span class="signature">(input, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h3><div class="description"><p>Parses an object (or JSON string) and recursively normalizes nested values.</p><p>When <code>options.parseValue</code> is enabled, string values are converted using dotenv-parse-variables rules (for example booleans, numbers, arrays, and null), including values inside arrays and nested objects.</p><p>Special key handling:</p><ul><li>Keys ending with <code>Dur</code> are converted to milliseconds using parseDuration.</li><li>Keys ending with <code>Dt</code> are converted to Unix timestamps using Date.parse.</li><li><code>options.translator</code> can translate prefixed keys/values before normalization.</li></ul></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>input</code></td><td class="type"><span class="param-type">Object</span> |<wbr> <span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>If string is given, parse it first using JSON.parse.</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.</p><h6>Properties</h6><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>silent</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="default">true</td><td class="description last"><p>If <code>true</code>, parsing errors are ignored and values become undefined.</p></td></tr><tr><td class="name"><code>parseValue</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="default">false</td><td class="description last"><p>If <code>true</code>, values are parsed and normalized.</p></td></tr><tr><td class="name"><code>translator</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>Optional translator config for prefixed keys/values.</p></td></tr></tbody></table></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="parse-object.js.html">parse-object.js</a>, <a href="parse-object.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://github.com/ladjs/dotenv-parse-variables">https://github.com/ladjs/dotenv-parse-variables</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Parsed and normalized object.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Object</span></dd></dl></div><h3 class="name has-anchor" id="pascalCase"><span class="type-signature"></span>pascalCase<span class="signature">(text)</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Converts text into PascalCase.</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>text</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>Source text.</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="pascal-case.js.html">pascal-case.js</a>, <a href="pascal-case.js.html#line10">line 10</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Pascal-cased 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="randomRange"><span class="type-signature"></span>randomRange<span class="signature">(min, max, alpha)</span><span class="type-signature"> → {number|string}</span></h3><div class="description"><p>Generate random value.</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>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>min</code></td><td class="type"><span class="param-type">number</span></td><td class="default">0</td><td class="description last"><p>Minimum value (inclusive).</p></td></tr><tr><td class="name"><code>max</code></td><td class="type"><span class="param-type">number</span></td><td class="default">65439</td><td class="description last"><p>Maximum value (inclusive).</p></td></tr><tr><td class="name"><code>alpha</code></td><td class="type"><span class="param-type">boolean</span></td><td class="default">false</td><td class="description last"><p>Set <code>true</code> to return alphanumeric characters.</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="random-range.js.html">random-range.js</a>, <a href="random-range.js.html#line9">line 9</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Random value.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">number</span> |<wbr> <span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="resolvePath"><span class="type-signature"></span>resolvePath<span class="signature">(file, asFileUrl<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Resolve file name to filesystem's path. Windows path separator <code>\</code> is normalized to Unix's <code>/</code></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>file</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>File to resolve.</p></td></tr><tr><td class="name"><code>asFileUrl</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="default">false</td><td class="description last"><p>Return as file URL format <code>file:///<name></code>.</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="resolve-path.js.html">resolve-path.js</a>, <a href="resolve-path.js.html#line13">line 13</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="round"><span class="type-signature"></span>round<span class="signature">(val, scale<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {number}</span></h3><div class="description"><p>Rounds a number using decimal precision.</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>val</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Number to round.</p></td></tr><tr><td class="name"><code>scale</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">0</td><td class="description last"><p>Decimal places.</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="round.js.html">round.js</a>, <a href="round.js.html#line8">line 8</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Rounded number.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">number</span></dd></dl></div><h3 class="name has-anchor" id="setImmediate"><span class="type-signature">(async) </span>setImmediate<span class="signature">()</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description"><p>Schedules execution on the next immediate cycle and resolves when it runs.</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="set-immediate.js.html">set-immediate.js</a>, <a href="set-immediate.js.html#line6">line 6</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Promise resolved on the immediate queue.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><h3 class="name has-anchor" id="setInterval"><span class="type-signature">(async) </span>setInterval<span class="signature">(handler, timeout, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description"><p>Like original setInterval, but repeatedly executes a function after a specified delay asynchronously.</p><p>Function handler will only be executed if the previous execution has completed. This prevents overlapping executions.</p><p>Optionally using a lock file. If it is provided and the lock file does not exist, it will be created. If the lock file exists and is locked, the handler will not be executed.</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>handler</code></td><td class="type"><span class="param-type">function</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The function to execute after the interval.</p></td></tr><tr><td class="name"><code>timeout</code></td><td class="type"><span class="param-type">number</span> |<wbr> <span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The delay in milliseconds or a duration string.</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>Additional options.</p><h6>Properties</h6><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>lockFile</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>The path to the lock file. If provided, the handler will only execute if the lock can be acquired.</p></td></tr><tr><td class="name"><code>args</code></td><td class="type"><span class="param-type">Array</span></td><td class="attributes"><optional><br></td><td class="default">[]</td><td class="description last"><p>Arguments to pass to the handler.</p></td></tr><tr><td class="name"><code>lockFileOpts</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 for the lock file.</p></td></tr><tr><td class="name"><code>silent</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="default">true</td><td class="description last"><p>If true, errors during lock acquisition will be ignored.</p></td></tr><tr><td class="name"><code>maxIterations</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">Infinity</td><td class="description last"><p>Maximum number of times to execute the handler.</p></td></tr><tr><td class="name"><code>scope</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>The scope to bind the handler to.</p></td></tr></tbody></table></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="set-interval.js.html">set-interval.js</a>, <a href="set-interval.js.html#line25">line 25</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Promise resolved after the interval.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><h3 class="name has-anchor" id="setTimeout"><span class="type-signature">(async) </span>setTimeout<span class="signature">(handler, timeout, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description"><p>Like original setTimeout, but executes a function after a specified delay asynchronously. Optionally using a lock file.</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>handler</code></td><td class="type"><span class="param-type">function</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The function to execute after the timeout.</p></td></tr><tr><td class="name"><code>timeout</code></td><td class="type"><span class="param-type">number</span> |<wbr> <span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The delay in milliseconds or a duration string.</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>Additional options.</p><h6>Properties</h6><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>lockFile</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>The path to the lock file. If set, the handler will only execute if the lock can be acquired.</p></td></tr><tr><td class="name"><code>args</code></td><td class="type"><span class="param-type">Array</span></td><td class="attributes"><optional><br></td><td class="default">[]</td><td class="description last"><p>Arguments to pass to the handler.</p></td></tr><tr><td class="name"><code>lockFileOpts</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 for the lock file.</p></td></tr><tr><td class="name"><code>silent</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="default">true</td><td class="description last"><p>If true, errors during lock acquisition will be ignored.</p></td></tr><tr><td class="name"><code>scope</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>The scope to bind the handler to.</p></td></tr></tbody></table></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="set-timeout.js.html">set-timeout.js</a>, <a href="set-timeout.js.html#line18">line 18</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Promise resolved after the delay.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><h3 class="name has-anchor" id="shim"><span class="type-signature"></span>shim<span class="signature">()</span><span class="type-signature"> → {void}</span></h3><div class="description"><p>Attaches missing String polyfills when they are not available in the current runtime. Adds <code>String.prototype.replaceAll</code> and <code>String.prototype.splice</code> if needed.</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="shim.js.html">shim.js</a>, <a href="shim.js.html#line7">line 7</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">void</span></dd></dl></div><h3 class="name has-anchor" id="textToArray"><span class="type-signature"></span>textToArray<span class="signature">(text)</span><span class="type-signature"> → {Array.<string>}</span></h3><div class="description"><p>Converts multiline text into a cleaned array and removes comments.</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>text</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>Input text.</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="text-to-array.js.html">text-to-array.js</a>, <a href="text-to-array.js.html#line9">line 9</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Cleaned lines.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array.<string></span></dd></dl></div><h3 class="name has-anchor" id="titleize"><span class="type-signature"></span>titleize<span class="signature">(text<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Converts text to title case with optional ignore and replacement rules.</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"><optional><br></td><td class="default">''</td><td class="description last"><p>Source text.</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>Transformation options.</p><h6>Properties</h6><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>ignores</code></td><td class="type"><span class="param-type">Array.<string></span></td><td class="attributes"><optional><br></td><td class="default">[]</td><td class="description last"><p>Words that should remain unchanged.</p></td></tr><tr><td class="name"><code>replacement</code></td><td class="type"><span class="param-type">Object.<string, string></span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Exact token replacements.</p></td></tr></tbody></table></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="titleize.js.html">titleize.js</a>, <a href="titleize.js.html#line18">line 18</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Titleized 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="without"><span class="type-signature"></span>without<span class="signature">(arr<span class="signature-attributes">opt</span>, …params)</span><span class="type-signature"> → {Array.<any>}</span></h3><div class="description"><p>Returns an array without provided values and empty-like entries.</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>arr</code></td><td class="type"><span class="param-type">Array.<any></span></td><td class="attributes"><optional><br></td><td class="default">[]</td><td class="description last"><p>Source array.</p></td></tr><tr><td class="name"><code>params</code></td><td class="type"><span class="param-type">any</span></td><td class="attributes"><repeatable><br></td><td class="default"></td><td class="description last"><p>Values to exclude.</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="without.js.html">without.js</a>, <a href="without.js.html#line13">line 13</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Filtered array.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array.<any></span></dd></dl></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Example</strong><div class="rel"><pre class="prettyprint"><code>without([1, 2, null, '', 3, 2], 2)
|
|
12
12
|
// => [1, 3]</code></pre></div></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">aneka</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/aneka" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/aneka" target="">Github</a></div></div><div class="mobile-sidebar-items-c"><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#arrangeArray">arrangeArray</a></div><div class="sidebar-section-children"><a href="global.html#createClass">createClass</a></div><div class="sidebar-section-children"><a href="global.html#currentLoc">currentLoc</a></div><div class="sidebar-section-children"><a href="global.html#defaultsDeep">defaultsDeep</a></div><div class="sidebar-section-children"><a href="global.html#delay">delay</a></div><div class="sidebar-section-children"><a href="global.html#extractText">extractText</a></div><div class="sidebar-section-children"><a href="global.html#fillObject">fillObject</a></div><div class="sidebar-section-children"><a href="global.html#filterDuplicate">filterDuplicate</a></div><div class="sidebar-section-children"><a href="global.html#filterIndex">filterIndex</a></div><div class="sidebar-section-children"><a href="global.html#formatText">formatText</a></div><div class="sidebar-section-children"><a href="global.html#getCallerFilename">getCallerFilename</a></div><div class="sidebar-section-children"><a href="global.html#getGlobalModuleDir">getGlobalModuleDir</a></div><div class="sidebar-section-children"><a href="global.html#getIndex">getIndex</a></div><div class="sidebar-section-children"><a href="global.html#getKeyByValue">getKeyByValue</a></div><div class="sidebar-section-children"><a href="global.html#includes">includes</a></div><div class="sidebar-section-children"><a href="global.html#isClass">isClass</a></div><div class="sidebar-section-children"><a href="global.html#isSet">isSet</a></div><div class="sidebar-section-children"><a href="global.html#mergeObjectsByKey">mergeObjectsByKey</a></div><div class="sidebar-section-children"><a href="global.html#paginate">paginate</a></div><div class="sidebar-section-children"><a href="global.html#parseArgsArgv">parseArgsArgv</a></div><div class="sidebar-section-children"><a href="global.html#parseDuration">parseDuration</a></div><div class="sidebar-section-children"><a href="global.html#parseEnv">parseEnv</a></div><div class="sidebar-section-children"><a href="global.html#parseKvString">parseKvString</a></div><div class="sidebar-section-children"><a href="global.html#parseObject">parseObject</a></div><div class="sidebar-section-children"><a href="global.html#pascalCase">pascalCase</a></div><div class="sidebar-section-children"><a href="global.html#randomRange">randomRange</a></div><div class="sidebar-section-children"><a href="global.html#resolvePath">resolvePath</a></div><div class="sidebar-section-children"><a href="global.html#round">round</a></div><div class="sidebar-section-children"><a href="global.html#setImmediate">setImmediate</a></div><div class="sidebar-section-children"><a href="global.html#setInterval">setInterval</a></div><div class="sidebar-section-children"><a href="global.html#setTimeout">setTimeout</a></div><div class="sidebar-section-children"><a href="global.html#shim">shim</a></div><div class="sidebar-section-children"><a href="global.html#textToArray">textToArray</a></div><div class="sidebar-section-children"><a href="global.html#titleize">titleize</a></div><div class="sidebar-section-children"><a href="global.html#without">without</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>
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
3
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">aneka</a><div class="sidebar-items-container"><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#arrangeArray">arrangeArray</a></div><div class="sidebar-section-children"><a href="global.html#createClass">createClass</a></div><div class="sidebar-section-children"><a href="global.html#currentLoc">currentLoc</a></div><div class="sidebar-section-children"><a href="global.html#defaultsDeep">defaultsDeep</a></div><div class="sidebar-section-children"><a href="global.html#delay">delay</a></div><div class="sidebar-section-children"><a href="global.html#extractText">extractText</a></div><div class="sidebar-section-children"><a href="global.html#fillObject">fillObject</a></div><div class="sidebar-section-children"><a href="global.html#filterDuplicate">filterDuplicate</a></div><div class="sidebar-section-children"><a href="global.html#filterIndex">filterIndex</a></div><div class="sidebar-section-children"><a href="global.html#formatText">formatText</a></div><div class="sidebar-section-children"><a href="global.html#getCallerFilename">getCallerFilename</a></div><div class="sidebar-section-children"><a href="global.html#getGlobalModuleDir">getGlobalModuleDir</a></div><div class="sidebar-section-children"><a href="global.html#getIndex">getIndex</a></div><div class="sidebar-section-children"><a href="global.html#getKeyByValue">getKeyByValue</a></div><div class="sidebar-section-children"><a href="global.html#includes">includes</a></div><div class="sidebar-section-children"><a href="global.html#isClass">isClass</a></div><div class="sidebar-section-children"><a href="global.html#isSet">isSet</a></div><div class="sidebar-section-children"><a href="global.html#mergeObjectsByKey">mergeObjectsByKey</a></div><div class="sidebar-section-children"><a href="global.html#paginate">paginate</a></div><div class="sidebar-section-children"><a href="global.html#parseArgsArgv">parseArgsArgv</a></div><div class="sidebar-section-children"><a href="global.html#parseDuration">parseDuration</a></div><div class="sidebar-section-children"><a href="global.html#parseEnv">parseEnv</a></div><div class="sidebar-section-children"><a href="global.html#parseKvString">parseKvString</a></div><div class="sidebar-section-children"><a href="global.html#parseObject">parseObject</a></div><div class="sidebar-section-children"><a href="global.html#pascalCase">pascalCase</a></div><div class="sidebar-section-children"><a href="global.html#randomRange">randomRange</a></div><div class="sidebar-section-children"><a href="global.html#resolvePath">resolvePath</a></div><div class="sidebar-section-children"><a href="global.html#round">round</a></div><div class="sidebar-section-children"><a href="global.html#setImmediate">setImmediate</a></div><div class="sidebar-section-children"><a href="global.html#setInterval">setInterval</a></div><div class="sidebar-section-children"><a href="global.html#setTimeout">setTimeout</a></div><div class="sidebar-section-children"><a href="global.html#shim">shim</a></div><div class="sidebar-section-children"><a href="global.html#textToArray">textToArray</a></div><div class="sidebar-section-children"><a href="global.html#titleize">titleize</a></div><div class="sidebar-section-children"><a href="global.html#without">without</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/aneka" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/aneka" target="">Github</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">set-interval.js</h1></header><article><pre class="prettyprint source lang-js"><code>import lockfile from '@bybrave/proper-lockfile2'
|
|
4
4
|
import parseDuration from './parse-duration.js'
|
|
5
|
+
import fs from 'fs-extra'
|
|
5
6
|
|
|
6
7
|
/**
|
|
7
8
|
* Like original setInterval, but repeatedly executes a function after a specified delay asynchronously.
|
|
@@ -9,12 +10,13 @@ import parseDuration from './parse-duration.js'
|
|
|
9
10
|
* Function handler will only be executed if the previous execution has completed. This prevents
|
|
10
11
|
* overlapping executions.
|
|
11
12
|
*
|
|
12
|
-
* Optionally using a lock file.
|
|
13
|
+
* Optionally using a lock file. If it is provided and the lock file does not exist, it will be created.
|
|
14
|
+
* If the lock file exists and is locked, the handler will not be executed.
|
|
13
15
|
*
|
|
14
16
|
* @param {Function} handler The function to execute after the interval.
|
|
15
17
|
* @param {number|string} timeout The delay in milliseconds or a duration string.
|
|
16
18
|
* @param {Object} [options={}] Additional options.
|
|
17
|
-
* @param {string} [options.lockFile] The path to the lock file. If
|
|
19
|
+
* @param {string} [options.lockFile] The path to the lock file. If provided, the handler will only execute if the lock can be acquired.
|
|
18
20
|
* @param {Array} [options.args=[]] Arguments to pass to the handler.
|
|
19
21
|
* @param {Object} [options.lockFileOpts] Options for the lock file.
|
|
20
22
|
* @param {boolean} [options.silent=true] If true, errors during lock acquisition will be ignored.
|
|
@@ -33,6 +35,7 @@ async function setInterval (handler, timeout, options = {}) {
|
|
|
33
35
|
return
|
|
34
36
|
}
|
|
35
37
|
try {
|
|
38
|
+
fs.ensureFileSync(lockFile)
|
|
36
39
|
const release = await lockfile.lock(lockFile, lockFileOpts)
|
|
37
40
|
await handler.call(scope, ...args)
|
|
38
41
|
await release()
|
package/package.json
CHANGED
package/src/set-interval.js
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import lockfile from '@bybrave/proper-lockfile2'
|
|
2
2
|
import parseDuration from './parse-duration.js'
|
|
3
|
+
import fs from 'fs-extra'
|
|
3
4
|
|
|
4
5
|
/**
|
|
5
6
|
* Like original setInterval, but repeatedly executes a function after a specified delay asynchronously.
|
|
@@ -7,12 +8,13 @@ import parseDuration from './parse-duration.js'
|
|
|
7
8
|
* Function handler will only be executed if the previous execution has completed. This prevents
|
|
8
9
|
* overlapping executions.
|
|
9
10
|
*
|
|
10
|
-
* Optionally using a lock file.
|
|
11
|
+
* Optionally using a lock file. If it is provided and the lock file does not exist, it will be created.
|
|
12
|
+
* If the lock file exists and is locked, the handler will not be executed.
|
|
11
13
|
*
|
|
12
14
|
* @param {Function} handler The function to execute after the interval.
|
|
13
15
|
* @param {number|string} timeout The delay in milliseconds or a duration string.
|
|
14
16
|
* @param {Object} [options={}] Additional options.
|
|
15
|
-
* @param {string} [options.lockFile] The path to the lock file. If
|
|
17
|
+
* @param {string} [options.lockFile] The path to the lock file. If provided, the handler will only execute if the lock can be acquired.
|
|
16
18
|
* @param {Array} [options.args=[]] Arguments to pass to the handler.
|
|
17
19
|
* @param {Object} [options.lockFileOpts] Options for the lock file.
|
|
18
20
|
* @param {boolean} [options.silent=true] If true, errors during lock acquisition will be ignored.
|
|
@@ -31,6 +33,7 @@ async function setInterval (handler, timeout, options = {}) {
|
|
|
31
33
|
return
|
|
32
34
|
}
|
|
33
35
|
try {
|
|
36
|
+
fs.ensureFileSync(lockFile)
|
|
34
37
|
const release = await lockfile.lock(lockFile, lockFileOpts)
|
|
35
38
|
await handler.call(scope, ...args)
|
|
36
39
|
await release()
|