tool-shack 0.0.10 → 0.0.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. package/dist/dom/createElement.d.ts +1 -1
  2. package/dist/dom/createElement.js +5 -0
  3. package/dist/dom/createElement.js.map +1 -1
  4. package/dist/dom/interfaces/createElement.d.ts +1 -0
  5. package/docs/interfaces/dateTime.IDuration.html +0 -0
  6. package/docs/interfaces/dom.IExtendingElementProps.html +0 -0
  7. package/docs/modules/browser.html +22 -22
  8. package/docs/modules/dateTime.html +10 -10
  9. package/docs/modules/dom.html +51 -51
  10. package/docs/modules/general.html +15 -15
  11. package/docs/modules/schedule.html +12 -12
  12. package/docs/modules/string.html +26 -26
  13. package/package.json +1 -1
  14. package/src/dom/createElement.ts +5 -1
  15. package/src/dom/interfaces/createElement.ts +36 -35
package/dist/dom/createElement.d.ts CHANGED
@@ -6,4 +6,4 @@ import { IExtendingElementProps } from './interfaces/createElement';
6
6
  * @param props List of attributes, event listeners or/and children to assign to the newly created element
7
7
  * @returns Resulting Node element
8
8
  */
9
- export declare const createElement: <T = HTMLElement>(tagName: string, props?: (Partial<Omit<T, "children" | "dataset">> & IExtendingElementProps) | undefined) => T;
9
+ export declare const createElement: <T = HTMLElement>(tagName: string, props?: (Partial<Omit<T, "style" | "children" | "dataset">> & IExtendingElementProps) | undefined) => T;
package/dist/dom/createElement.js CHANGED
@@ -18,6 +18,11 @@ export const createElement = (tagName, props) => {
18
18
  element.setAttribute(`aria-${ariaKey}`, value[ariaKey]);
19
19
  }
20
20
  }
21
+ else if (key === 'style') {
22
+ for (let styleKey in props.style) {
23
+ element.style[styleKey] = value[styleKey];
24
+ }
25
+ }
21
26
  else if (key === 'children') {
22
27
  props.children.forEach((child) => element.appendChild(child));
23
28
  }
package/dist/dom/createElement.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"createElement.js","sourceRoot":"","sources":["../../src/dom/createElement.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,OAAe,EACf,KAAyE,EACtE,EAAE;IACL,MAAM,OAAO,GAAgB,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAE7D,IAAI,KAAK,EAAE;QACT,KAAK,IAAI,GAAG,IAAI,KAAK,EAAE;YACrB,MAAM,KAAK,GAAI,KAAa,CAAC,GAAG,CAAC,CAAC;YAElC,IAAI,GAAG,KAAK,MAAM,EAAE;gBAClB,OAAO,CAAC,YAAY,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;aAClC;iBAAM,IAAI,GAAG,KAAK,MAAM,EAAE;gBACzB,KAAK,IAAI,OAAO,IAAI,KAAK,CAAC,IAAK,EAAE;oBAC/B,OAAO,CAAC,YAAY,CAAC,QAAQ,OAAO,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;iBACzD;aACF;iBAAM,IAAI,GAAG,KAAK,UAAU,EAAE;gBAC7B,KAAK,CAAC,QAAS,CAAC,OAAO,CAAC,CAAC,KAAkB,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;aAC7E;iBAAM,IAAI,GAAG,KAAK,WAAW,EAAE;gBAC9B,KAAK,IAAI,SAAS,IAAI,KAAK,CAAC,SAAU,EAAE;oBACtC,MAAM,YAAY,GAAG,CACnB,KAAK,CAAC,SAAU,CAAC,SAAS,CAAC,YAAY,KAAK;wBAC1C,CAAC,CAAC,KAAK,CAAC,SAAU,CAAC,SAAS,CAAC;wBAC7B,CAAC,CAAC,CAAC,KAAK,CAAC,SAAU,CAAC,SAAS,CAAC,CAAC,CACM,CAAC;oBAE1C,YAAY,CAAC,OAAO,CAAC,CAAC,EAAsC,EAAE,EAAE,CAC9D,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,EAAE,CAAC,CACxC,CAAC;iBACH;aACF;iBAAM,IAAI,GAAG,KAAK,SAAS,EAAE;gBAC5B,KAAK,IAAI,UAAU,IAAI,KAAK,CAAC,OAAO,EAAE;oBACpC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;iBACzD;aACF;iBAAM;gBACJ,OAAe,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;aAC/B;SACF;KACF;IAED,OAAO,OAAuB,CAAC;AACjC,CAAC,CAAC"}
1
+ {"version":3,"file":"createElement.js","sourceRoot":"","sources":["../../src/dom/createElement.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,OAAe,EACf,KAAmF,EAChF,EAAE;IACL,MAAM,OAAO,GAAgB,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAE7D,IAAI,KAAK,EAAE;QACT,KAAK,IAAI,GAAG,IAAI,KAAK,EAAE;YACrB,MAAM,KAAK,GAAI,KAAa,CAAC,GAAG,CAAC,CAAC;YAElC,IAAI,GAAG,KAAK,MAAM,EAAE;gBAClB,OAAO,CAAC,YAAY,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;aAClC;iBAAM,IAAI,GAAG,KAAK,MAAM,EAAE;gBACzB,KAAK,IAAI,OAAO,IAAI,KAAK,CAAC,IAAK,EAAE;oBAC/B,OAAO,CAAC,YAAY,CAAC,QAAQ,OAAO,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;iBACzD;aACF;iBAAM,IAAI,GAAG,KAAK,OAAO,EAAE;gBAC1B,KAAK,IAAI,QAAQ,IAAI,KAAK,CAAC,KAAM,EAAE;oBAChC,OAAO,CAAC,KAAa,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;iBACpD;aACF;iBAAM,IAAI,GAAG,KAAK,UAAU,EAAE;gBAC7B,KAAK,CAAC,QAAS,CAAC,OAAO,CAAC,CAAC,KAAkB,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;aAC7E;iBAAM,IAAI,GAAG,KAAK,WAAW,EAAE;gBAC9B,KAAK,IAAI,SAAS,IAAI,KAAK,CAAC,SAAU,EAAE;oBACtC,MAAM,YAAY,GAAG,CACnB,KAAK,CAAC,SAAU,CAAC,SAAS,CAAC,YAAY,KAAK;wBAC1C,CAAC,CAAC,KAAK,CAAC,SAAU,CAAC,SAAS,CAAC;wBAC7B,CAAC,CAAC,CAAC,KAAK,CAAC,SAAU,CAAC,SAAS,CAAC,CAAC,CACM,CAAC;oBAE1C,YAAY,CAAC,OAAO,CAAC,CAAC,EAAsC,EAAE,EAAE,CAC9D,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,EAAE,CAAC,CACxC,CAAC;iBACH;aACF;iBAAM,IAAI,GAAG,KAAK,SAAS,EAAE;gBAC5B,KAAK,IAAI,UAAU,IAAI,KAAK,CAAC,OAAO,EAAE;oBACpC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;iBACzD;aACF;iBAAM;gBACJ,OAAe,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;aAC/B;SACF;KACF;IAED,OAAO,OAAuB,CAAC;AACjC,CAAC,CAAC"}
package/dist/dom/interfaces/createElement.d.ts CHANGED
@@ -5,4 +5,5 @@ export interface IExtendingElementProps {
5
5
  role?: string;
6
6
  aria?: Partial<Record<TAriaLabelKey, string>>;
7
7
  dataset?: Record<string, string>;
8
+ style?: Record<string, string | number>;
8
9
  }
package/docs/interfaces/dateTime.IDuration.html CHANGED
File without changes
package/docs/interfaces/dom.IExtendingElementProps.html CHANGED
File without changes
package/docs/modules/browser.html CHANGED
@@ -1,23 +1,23 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>browser | Tool-Shack</title><meta name="description" content="Documentation for Tool-Shack"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Tool-Shack</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Tool-Shack</a></li><li><a href="browser.html">browser</a></li></ul><h1>Module browser</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="browser.html#isTabFocused" class="tsd-kind-icon">is<wbr/>Tab<wbr/>Focused</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="browser.html#isTouchSupported" class="tsd-kind-icon">is<wbr/>Touch<wbr/>Supported</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="browser.html#preferColorScheme" class="tsd-kind-icon">prefer<wbr/>Color<wbr/>Scheme</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="browser.html#preferDarkColorScheme" class="tsd-kind-icon">prefer<wbr/>Dark<wbr/>Color<wbr/>Scheme</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="browser.html#preferLightColorScheme" class="tsd-kind-icon">prefer<wbr/>Light<wbr/>Color<wbr/>Scheme</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="browser.html#tabFocusListener" class="tsd-kind-icon">tab<wbr/>Focus<wbr/>Listener</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="isTabFocused" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> is<wbr/>Tab<wbr/>Focused</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">is<wbr/>Tab<wbr/>Focused<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/browser/isTabFocused.ts#L6">browser/isTabFocused.ts:6</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
- <p>Check if current browser tab is in focus</p>
3
- </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Boolean indicating if current browser tab is in focus</p>
4
- </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="isTouchSupported" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> is<wbr/>Touch<wbr/>Supported</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">is<wbr/>Touch<wbr/>Supported<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/browser/isTouchSupported.ts#L8">browser/isTouchSupported.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
5
- <p>Check if user&#39;s browser supports touch events</p>
6
- </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Boolean indicating if user&#39;s browser support touch events</p>
7
- </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="preferColorScheme" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> prefer<wbr/>Color<wbr/>Scheme</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">prefer<wbr/>Color<wbr/>Scheme<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;light&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;dark&quot;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/browser/preferColorScheme.ts#L20">browser/preferColorScheme.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
8
- <p>Check what color scheme (light or dark) is prefered by user</p>
9
- </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;light&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;dark&quot;</span></h4><div><p>String indicating prefered light color scheme (&#39;light&#39;) or dark color scheme (&#39;dark&#39;)</p>
10
- </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="preferDarkColorScheme" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> prefer<wbr/>Dark<wbr/>Color<wbr/>Scheme</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">prefer<wbr/>Dark<wbr/>Color<wbr/>Scheme<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/browser/preferColorScheme.ts#L13">browser/preferColorScheme.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
11
- <p>Check if user prefers dark color scheme</p>
12
- </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Boolean indicating if user prefers dark color scheme</p>
13
- </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="preferLightColorScheme" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> prefer<wbr/>Light<wbr/>Color<wbr/>Scheme</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">prefer<wbr/>Light<wbr/>Color<wbr/>Scheme<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/browser/preferColorScheme.ts#L6">browser/preferColorScheme.ts:6</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
14
- <p>Check if user prefers light color scheme</p>
15
- </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Boolean indicating if user prefers light color scheme</p>
16
- </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="tabFocusListener" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> tab<wbr/>Focus<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">tab<wbr/>Focus<wbr/>Listener<span class="tsd-signature-symbol">(</span>focusCallback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span>, blurCallback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/browser/tabFocusListener.ts#L10">browser/tabFocusListener.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
17
- <p>Set callbacks for if current browser tab is in focus</p>
18
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> focusCallback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
19
- <p>Function to be called when current browser tab goes into focus</p>
20
- </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> blurCallback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
21
- <p>Function to be called when current browser tab goes out of focus</p>
22
- </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div><p>void</p>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>browser | Tool-Shack</title><meta name="description" content="Documentation for Tool-Shack"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Tool-Shack</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Tool-Shack</a></li><li><a href="browser.html">browser</a></li></ul><h1>Module browser</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="browser.html#isTabFocused" class="tsd-kind-icon">is<wbr/>Tab<wbr/>Focused</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="browser.html#isTouchSupported" class="tsd-kind-icon">is<wbr/>Touch<wbr/>Supported</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="browser.html#preferColorScheme" class="tsd-kind-icon">prefer<wbr/>Color<wbr/>Scheme</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="browser.html#preferDarkColorScheme" class="tsd-kind-icon">prefer<wbr/>Dark<wbr/>Color<wbr/>Scheme</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="browser.html#preferLightColorScheme" class="tsd-kind-icon">prefer<wbr/>Light<wbr/>Color<wbr/>Scheme</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="browser.html#tabFocusListener" class="tsd-kind-icon">tab<wbr/>Focus<wbr/>Listener</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="isTabFocused" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> is<wbr/>Tab<wbr/>Focused</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">is<wbr/>Tab<wbr/>Focused<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/browser/isTabFocused.ts#L6">browser/isTabFocused.ts:6</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>Check if current browser tab is in focus</p>
3
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Boolean indicating if current browser tab is in focus</p>
4
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="isTouchSupported" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> is<wbr/>Touch<wbr/>Supported</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">is<wbr/>Touch<wbr/>Supported<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/browser/isTouchSupported.ts#L8">browser/isTouchSupported.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
5
+ <p>Check if user&#39;s browser supports touch events</p>
6
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Boolean indicating if user&#39;s browser support touch events</p>
7
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="preferColorScheme" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> prefer<wbr/>Color<wbr/>Scheme</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">prefer<wbr/>Color<wbr/>Scheme<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;light&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;dark&quot;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/browser/preferColorScheme.ts#L20">browser/preferColorScheme.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
8
+ <p>Check what color scheme (light or dark) is prefered by user</p>
9
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;light&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;dark&quot;</span></h4><div><p>String indicating prefered light color scheme (&#39;light&#39;) or dark color scheme (&#39;dark&#39;)</p>
10
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="preferDarkColorScheme" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> prefer<wbr/>Dark<wbr/>Color<wbr/>Scheme</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">prefer<wbr/>Dark<wbr/>Color<wbr/>Scheme<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/browser/preferColorScheme.ts#L13">browser/preferColorScheme.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
11
+ <p>Check if user prefers dark color scheme</p>
12
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Boolean indicating if user prefers dark color scheme</p>
13
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="preferLightColorScheme" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> prefer<wbr/>Light<wbr/>Color<wbr/>Scheme</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">prefer<wbr/>Light<wbr/>Color<wbr/>Scheme<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/browser/preferColorScheme.ts#L6">browser/preferColorScheme.ts:6</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
14
+ <p>Check if user prefers light color scheme</p>
15
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Boolean indicating if user prefers light color scheme</p>
16
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="tabFocusListener" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> tab<wbr/>Focus<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">tab<wbr/>Focus<wbr/>Listener<span class="tsd-signature-symbol">(</span>focusCallback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span>, blurCallback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/browser/tabFocusListener.ts#L10">browser/tabFocusListener.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
17
+ <p>Set callbacks for if current browser tab is in focus</p>
18
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> focusCallback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
19
+ <p>Function to be called when current browser tab goes into focus</p>
20
+ </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> blurCallback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
21
+ <p>Function to be called when current browser tab goes out of focus</p>
22
+ </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div><p>void</p>
23
23
  </div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class="current tsd-kind-module"><a href="browser.html">browser</a></li><li class=" tsd-kind-module"><a href="dateTime.html">date<wbr/>Time</a></li><li class=" tsd-kind-module"><a href="dom.html">dom</a></li><li class=" tsd-kind-module"><a href="general.html">general</a></li><li class=" tsd-kind-module"><a href="schedule.html">schedule</a></li><li class=" tsd-kind-module"><a href="string.html">string</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-function tsd-parent-kind-module"><a href="browser.html#isTabFocused" class="tsd-kind-icon">is<wbr/>Tab<wbr/>Focused</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="browser.html#isTouchSupported" class="tsd-kind-icon">is<wbr/>Touch<wbr/>Supported</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="browser.html#preferColorScheme" class="tsd-kind-icon">prefer<wbr/>Color<wbr/>Scheme</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="browser.html#preferDarkColorScheme" class="tsd-kind-icon">prefer<wbr/>Dark<wbr/>Color<wbr/>Scheme</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="browser.html#preferLightColorScheme" class="tsd-kind-icon">prefer<wbr/>Light<wbr/>Color<wbr/>Scheme</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="browser.html#tabFocusListener" class="tsd-kind-icon">tab<wbr/>Focus<wbr/>Listener</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs/modules/dateTime.html CHANGED
@@ -1,11 +1,11 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>dateTime | Tool-Shack</title><meta name="description" content="Documentation for Tool-Shack"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Tool-Shack</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Tool-Shack</a></li><li><a href="dateTime.html">dateTime</a></li></ul><h1>Module dateTime</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/dateTime.IDuration.html" class="tsd-kind-icon">IDuration</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="dateTime.html#dateAsIso" class="tsd-kind-icon">date<wbr/>As<wbr/>Iso</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="dateTime.html#parseDuration" class="tsd-kind-icon">parse<wbr/>Duration</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="dateAsIso" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> date<wbr/>As<wbr/>Iso</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">date<wbr/>As<wbr/>Iso<span class="tsd-signature-symbol">(</span>date<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/dateTime/dateAsIso.ts#L7">dateTime/dateAsIso.ts:7</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
- <p>Return date in ISO format with timezone</p>
3
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>date: <span class="tsd-signature-type">Date</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
4
- <p>Date to be converted</p>
5
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>ISO format with timezone</p>
6
- </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="parseDuration" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> parse<wbr/>Duration</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">parse<wbr/>Duration<span class="tsd-signature-symbol">(</span>durationInMs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/dateTime.IDuration.html" class="tsd-signature-type" data-tsd-kind="Interface">IDuration</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/dateTime/parseDuration.ts#L9">dateTime/parseDuration.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
7
- <p>Parse duration in milliseconds into days, hours, minutes, seconds, milliseconds</p>
8
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>durationInMs: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
9
- <p>Integer of duration in milliseconds</p>
10
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="../interfaces/dateTime.IDuration.html" class="tsd-signature-type" data-tsd-kind="Interface">IDuration</a></h4><div><p>Object containing days, hours, minutes, seconds and milliseconds of provided duration</p>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>dateTime | Tool-Shack</title><meta name="description" content="Documentation for Tool-Shack"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Tool-Shack</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Tool-Shack</a></li><li><a href="dateTime.html">dateTime</a></li></ul><h1>Module dateTime</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/dateTime.IDuration.html" class="tsd-kind-icon">IDuration</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="dateTime.html#dateAsIso" class="tsd-kind-icon">date<wbr/>As<wbr/>Iso</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="dateTime.html#parseDuration" class="tsd-kind-icon">parse<wbr/>Duration</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="dateAsIso" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> date<wbr/>As<wbr/>Iso</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">date<wbr/>As<wbr/>Iso<span class="tsd-signature-symbol">(</span>date<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/dateTime/dateAsIso.ts#L7">dateTime/dateAsIso.ts:7</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>Return date in ISO format with timezone</p>
3
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>date: <span class="tsd-signature-type">Date</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>Date to be converted</p>
5
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>ISO format with timezone</p>
6
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="parseDuration" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> parse<wbr/>Duration</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">parse<wbr/>Duration<span class="tsd-signature-symbol">(</span>durationInMs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/dateTime.IDuration.html" class="tsd-signature-type" data-tsd-kind="Interface">IDuration</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/dateTime/parseDuration.ts#L9">dateTime/parseDuration.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
7
+ <p>Parse duration in milliseconds into days, hours, minutes, seconds, milliseconds</p>
8
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>durationInMs: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
9
+ <p>Integer of duration in milliseconds</p>
10
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="../interfaces/dateTime.IDuration.html" class="tsd-signature-type" data-tsd-kind="Interface">IDuration</a></h4><div><p>Object containing days, hours, minutes, seconds and milliseconds of provided duration</p>
11
11
  </div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="browser.html">browser</a></li><li class="current tsd-kind-module"><a href="dateTime.html">date<wbr/>Time</a></li><li class=" tsd-kind-module"><a href="dom.html">dom</a></li><li class=" tsd-kind-module"><a href="general.html">general</a></li><li class=" tsd-kind-module"><a href="schedule.html">schedule</a></li><li class=" tsd-kind-module"><a href="string.html">string</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/dateTime.IDuration.html" class="tsd-kind-icon">IDuration</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="dateTime.html#dateAsIso" class="tsd-kind-icon">date<wbr/>As<wbr/>Iso</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="dateTime.html#parseDuration" class="tsd-kind-icon">parse<wbr/>Duration</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs/modules/dom.html CHANGED
@@ -1,52 +1,52 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>dom | Tool-Shack</title><meta name="description" content="Documentation for Tool-Shack"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Tool-Shack</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Tool-Shack</a></li><li><a href="dom.html">dom</a></li></ul><h1>Module dom</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/dom.IExtendingElementProps.html" class="tsd-kind-icon">IExtending<wbr/>Element<wbr/>Props</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="dom.html#TAriaLabelKey" class="tsd-kind-icon">TAria<wbr/>Label<wbr/>Key</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="dom.html#addAsyncEventListener" class="tsd-kind-icon">add<wbr/>Async<wbr/>Event<wbr/>Listener</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="dom.html#addClickOutsideListener" class="tsd-kind-icon">add<wbr/>Click<wbr/>Outside<wbr/>Listener</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="dom.html#addEventListener" class="tsd-kind-icon">add<wbr/>Event<wbr/>Listener</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="dom.html#appendAfter" class="tsd-kind-icon">append<wbr/>After</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="dom.html#appendBefore" class="tsd-kind-icon">append<wbr/>Before</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="dom.html#createElement" class="tsd-kind-icon">create<wbr/>Element</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="dom.html#fireEvent" class="tsd-kind-icon">fire<wbr/>Event</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="TAriaLabelKey" class="tsd-anchor"></a><h3>TAria<wbr/>Label<wbr/>Key</h3><div class="tsd-signature tsd-kind-icon">TAria<wbr/>Label<wbr/>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;atomic&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;busy&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;controls&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;current&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;describedby&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;details&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;disables&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;dropeffect&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;errormessage&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;expanded&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;flowto&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;grabbed&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;haspopup&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;hidden&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;invalid&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;keyshortcuts&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;label&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;labelledby&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;live&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;modal&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;owns&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;relevant&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;roledescription&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/dom/interfaces/createElement.ts#L1">dom/interfaces/createElement.ts:1</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="addAsyncEventListener" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> add<wbr/>Async<wbr/>Event<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">add<wbr/>Async<wbr/>Event<wbr/>Listener<span class="tsd-signature-symbol">(</span>elementSelector<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, listeners<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">EventListener</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventListener</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span>, acceptBubbling<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/dom/addAsyncEventListener.ts#L9">dom/addAsyncEventListener.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
- <p>Listen to events fired on elements that may currently not exist in the DOM</p>
3
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>elementSelector: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
4
- <p>Selector for element(s) to match event target</p>
5
- </div></div></li><li><h5>listeners: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">EventListener</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventListener</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
6
- <p>List of event types and related callback(s)</p>
7
- </div></div></li><li><h5>acceptBubbling: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
8
- <p>Boolean switch to allow bubbling or accept only direct element match</p>
9
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div><p>void</p>
10
- </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="addClickOutsideListener" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> add<wbr/>Click<wbr/>Outside<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">add<wbr/>Click<wbr/>Outside<wbr/>Listener<span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span>, fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/dom/addClickOutsideListener.ts#L8">dom/addClickOutsideListener.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
11
- <p>Add event listener to listen to clicks outside of given element</p>
12
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>element: <span class="tsd-signature-type">HTMLElement</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
13
- <p>Node element outside which to listen to clicks</p>
14
- </div></div></li><li><h5>fn: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
15
- <p>Function to trigger when clicked outside</p>
16
- </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div><p>void</p>
17
- </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="addEventListener" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> add<wbr/>Event<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">add<wbr/>Event<wbr/>Listener<span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NodeListOf</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCollectionOf</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">&gt;</span>, listeners<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">EventListenerOrEventListenerObject</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventListenerOrEventListenerObject</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/dom/addEventListener.ts#L8">dom/addEventListener.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
18
- <p>Add event listener(s) to one or more Node elements</p>
19
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>element: <span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NodeListOf</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCollectionOf</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
20
- <p>One or multiple Node element(s) to set listener(s) for</p>
21
- </div></div></li><li><h5>listeners: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">EventListenerOrEventListenerObject</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventListenerOrEventListenerObject</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
22
- <p>List of event types and related callback(s)</p>
23
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div><p>void</p>
24
- </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="appendAfter" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> append<wbr/>After</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">append<wbr/>After<span class="tsd-signature-symbol">(</span>newNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span>, referenceNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/dom/appendAfter.ts#L8">dom/appendAfter.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
25
- <p>Append given node after reference node in the DOM</p>
26
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>newNode: <span class="tsd-signature-type">HTMLElement</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
27
- <p>New node element to be appended</p>
28
- </div></div></li><li><h5>referenceNode: <span class="tsd-signature-type">HTMLElement</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
29
- <p>Reference node element</p>
30
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Result of the action</p>
31
- </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="appendBefore" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> append<wbr/>Before</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">append<wbr/>Before<span class="tsd-signature-symbol">(</span>newNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span>, referenceNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/dom/appendBefore.ts#L8">dom/appendBefore.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
32
- <p>Append given node before reference node in the DOM</p>
33
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>newNode: <span class="tsd-signature-type">HTMLElement</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
34
- <p>New node element to be appended</p>
35
- </div></div></li><li><h5>referenceNode: <span class="tsd-signature-type">HTMLElement</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
36
- <p>Reference node element</p>
37
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Result of the action</p>
38
- </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a id="createElement" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> create<wbr/>Element</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">create<wbr/>Element<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>tagName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, props<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;children&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;dataset&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><a href="../interfaces/dom.IExtendingElementProps.html" class="tsd-signature-type" data-tsd-kind="Interface">IExtendingElementProps</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/dom/createElement.ts#L10">dom/createElement.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
39
- <p>Method for creating Node element and assigning multiple parameters, event listeners &amp; children in one method call</p>
40
- </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T = <span class="tsd-signature-type">HTMLElement</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>tagName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
41
- <p>Node tag name</p>
42
- </div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> props: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;children&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;dataset&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><a href="../interfaces/dom.IExtendingElementProps.html" class="tsd-signature-type" data-tsd-kind="Interface">IExtendingElementProps</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
43
- <p>List of attributes, event listeners or/and children to assign to the newly created element</p>
44
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h4><div><p>Resulting Node element</p>
45
- </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="fireEvent" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> fire<wbr/>Event</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">fire<wbr/>Event<span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span>, eventType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/dom/fireEvent.ts#L8">dom/fireEvent.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
46
- <p>Manually fire event on Node element</p>
47
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>element: <span class="tsd-signature-type">HTMLElement</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
48
- <p>Node element on which should be fired event</p>
49
- </div></div></li><li><h5>eventType: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
50
- <p>Type name of event that should be fired</p>
51
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Result of the action</p>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>dom | Tool-Shack</title><meta name="description" content="Documentation for Tool-Shack"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Tool-Shack</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Tool-Shack</a></li><li><a href="dom.html">dom</a></li></ul><h1>Module dom</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/dom.IExtendingElementProps.html" class="tsd-kind-icon">IExtending<wbr/>Element<wbr/>Props</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="dom.html#TAriaLabelKey" class="tsd-kind-icon">TAria<wbr/>Label<wbr/>Key</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="dom.html#addAsyncEventListener" class="tsd-kind-icon">add<wbr/>Async<wbr/>Event<wbr/>Listener</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="dom.html#addClickOutsideListener" class="tsd-kind-icon">add<wbr/>Click<wbr/>Outside<wbr/>Listener</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="dom.html#addEventListener" class="tsd-kind-icon">add<wbr/>Event<wbr/>Listener</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="dom.html#appendAfter" class="tsd-kind-icon">append<wbr/>After</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="dom.html#appendBefore" class="tsd-kind-icon">append<wbr/>Before</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="dom.html#createElement" class="tsd-kind-icon">create<wbr/>Element</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="dom.html#fireEvent" class="tsd-kind-icon">fire<wbr/>Event</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="TAriaLabelKey" class="tsd-anchor"></a><h3>TAria<wbr/>Label<wbr/>Key</h3><div class="tsd-signature tsd-kind-icon">TAria<wbr/>Label<wbr/>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;atomic&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;busy&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;controls&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;current&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;describedby&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;details&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;disables&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;dropeffect&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;errormessage&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;expanded&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;flowto&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;grabbed&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;haspopup&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;hidden&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;invalid&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;keyshortcuts&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;label&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;labelledby&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;live&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;modal&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;owns&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;relevant&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;roledescription&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/dom/interfaces/createElement.ts#L1">dom/interfaces/createElement.ts:1</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="addAsyncEventListener" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> add<wbr/>Async<wbr/>Event<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">add<wbr/>Async<wbr/>Event<wbr/>Listener<span class="tsd-signature-symbol">(</span>elementSelector<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, listeners<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">EventListener</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventListener</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span>, acceptBubbling<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/dom/addAsyncEventListener.ts#L9">dom/addAsyncEventListener.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>Listen to events fired on elements that may currently not exist in the DOM</p>
3
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>elementSelector: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>Selector for element(s) to match event target</p>
5
+ </div></div></li><li><h5>listeners: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">EventListener</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventListener</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>List of event types and related callback(s)</p>
7
+ </div></div></li><li><h5>acceptBubbling: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
8
+ <p>Boolean switch to allow bubbling or accept only direct element match</p>
9
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div><p>void</p>
10
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="addClickOutsideListener" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> add<wbr/>Click<wbr/>Outside<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">add<wbr/>Click<wbr/>Outside<wbr/>Listener<span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span>, fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/dom/addClickOutsideListener.ts#L8">dom/addClickOutsideListener.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
11
+ <p>Add event listener to listen to clicks outside of given element</p>
12
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>element: <span class="tsd-signature-type">HTMLElement</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
13
+ <p>Node element outside which to listen to clicks</p>
14
+ </div></div></li><li><h5>fn: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
15
+ <p>Function to trigger when clicked outside</p>
16
+ </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div><p>void</p>
17
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="addEventListener" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> add<wbr/>Event<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">add<wbr/>Event<wbr/>Listener<span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NodeListOf</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCollectionOf</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">&gt;</span>, listeners<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">EventListenerOrEventListenerObject</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventListenerOrEventListenerObject</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/dom/addEventListener.ts#L8">dom/addEventListener.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
18
+ <p>Add event listener(s) to one or more Node elements</p>
19
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>element: <span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NodeListOf</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCollectionOf</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
20
+ <p>One or multiple Node element(s) to set listener(s) for</p>
21
+ </div></div></li><li><h5>listeners: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">EventListenerOrEventListenerObject</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventListenerOrEventListenerObject</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
22
+ <p>List of event types and related callback(s)</p>
23
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div><p>void</p>
24
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="appendAfter" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> append<wbr/>After</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">append<wbr/>After<span class="tsd-signature-symbol">(</span>newNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span>, referenceNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/dom/appendAfter.ts#L8">dom/appendAfter.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
25
+ <p>Append given node after reference node in the DOM</p>
26
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>newNode: <span class="tsd-signature-type">HTMLElement</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
27
+ <p>New node element to be appended</p>
28
+ </div></div></li><li><h5>referenceNode: <span class="tsd-signature-type">HTMLElement</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
29
+ <p>Reference node element</p>
30
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Result of the action</p>
31
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="appendBefore" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> append<wbr/>Before</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">append<wbr/>Before<span class="tsd-signature-symbol">(</span>newNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span>, referenceNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/dom/appendBefore.ts#L8">dom/appendBefore.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
32
+ <p>Append given node before reference node in the DOM</p>
33
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>newNode: <span class="tsd-signature-type">HTMLElement</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
34
+ <p>New node element to be appended</p>
35
+ </div></div></li><li><h5>referenceNode: <span class="tsd-signature-type">HTMLElement</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
36
+ <p>Reference node element</p>
37
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Result of the action</p>
38
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a id="createElement" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> create<wbr/>Element</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">create<wbr/>Element<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>tagName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, props<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;children&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;dataset&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><a href="../interfaces/dom.IExtendingElementProps.html" class="tsd-signature-type" data-tsd-kind="Interface">IExtendingElementProps</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/dom/createElement.ts#L10">dom/createElement.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
39
+ <p>Method for creating Node element and assigning multiple parameters, event listeners &amp; children in one method call</p>
40
+ </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T = <span class="tsd-signature-type">HTMLElement</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>tagName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
41
+ <p>Node tag name</p>
42
+ </div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> props: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;children&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;dataset&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><a href="../interfaces/dom.IExtendingElementProps.html" class="tsd-signature-type" data-tsd-kind="Interface">IExtendingElementProps</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
43
+ <p>List of attributes, event listeners or/and children to assign to the newly created element</p>
44
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h4><div><p>Resulting Node element</p>
45
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="fireEvent" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> fire<wbr/>Event</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">fire<wbr/>Event<span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span>, eventType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/dom/fireEvent.ts#L8">dom/fireEvent.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
46
+ <p>Manually fire event on Node element</p>
47
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>element: <span class="tsd-signature-type">HTMLElement</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
48
+ <p>Node element on which should be fired event</p>
49
+ </div></div></li><li><h5>eventType: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
50
+ <p>Type name of event that should be fired</p>
51
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Result of the action</p>
52
52
  </div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="browser.html">browser</a></li><li class=" tsd-kind-module"><a href="dateTime.html">date<wbr/>Time</a></li><li class="current tsd-kind-module"><a href="dom.html">dom</a></li><li class=" tsd-kind-module"><a href="general.html">general</a></li><li class=" tsd-kind-module"><a href="schedule.html">schedule</a></li><li class=" tsd-kind-module"><a href="string.html">string</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/dom.IExtendingElementProps.html" class="tsd-kind-icon">IExtending<wbr/>Element<wbr/>Props</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="dom.html#TAriaLabelKey" class="tsd-kind-icon">TAria<wbr/>Label<wbr/>Key</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="dom.html#addAsyncEventListener" class="tsd-kind-icon">add<wbr/>Async<wbr/>Event<wbr/>Listener</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="dom.html#addClickOutsideListener" class="tsd-kind-icon">add<wbr/>Click<wbr/>Outside<wbr/>Listener</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="dom.html#addEventListener" class="tsd-kind-icon">add<wbr/>Event<wbr/>Listener</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="dom.html#appendAfter" class="tsd-kind-icon">append<wbr/>After</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="dom.html#appendBefore" class="tsd-kind-icon">append<wbr/>Before</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="dom.html#createElement" class="tsd-kind-icon">create<wbr/>Element</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="dom.html#fireEvent" class="tsd-kind-icon">fire<wbr/>Event</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs/modules/general.html CHANGED
@@ -1,16 +1,16 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>general | Tool-Shack</title><meta name="description" content="Documentation for Tool-Shack"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Tool-Shack</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Tool-Shack</a></li><li><a href="general.html">general</a></li></ul><h1>Module general</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="general.html#isEmpty" class="tsd-kind-icon">is<wbr/>Empty</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="general.html#isNil" class="tsd-kind-icon">is<wbr/>Nil</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="general.html#isValidJson" class="tsd-kind-icon">is<wbr/>Valid<wbr/>Json</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="isEmpty" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> is<wbr/>Empty</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">is<wbr/>Empty<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/general/isEmpty.ts#L9">general/isEmpty.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
- <p>Check if given value is empty</p>
3
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
4
- <p>Value to be checked</p>
5
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Boolean indicating if given value is empty</p>
6
- </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="isNil" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> is<wbr/>Nil</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">is<wbr/>Nil<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/general/isNil.ts#L7">general/isNil.ts:7</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
7
- <p>Check if value is equal to null or undefined</p>
8
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
9
- <p>Value to be checked</p>
10
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Boolean indicating if value is equal to null or undefined</p>
11
- </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="isValidJson" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> is<wbr/>Valid<wbr/>Json</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">is<wbr/>Valid<wbr/>Json<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/general/isValidJson.ts#L7">general/isValidJson.ts:7</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
12
- <p>Check if string is valid JSON</p>
13
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
14
- <p>String value to be checked</p>
15
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Boolean indicating if string value is a valid JSON</p>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>general | Tool-Shack</title><meta name="description" content="Documentation for Tool-Shack"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Tool-Shack</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Tool-Shack</a></li><li><a href="general.html">general</a></li></ul><h1>Module general</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="general.html#isEmpty" class="tsd-kind-icon">is<wbr/>Empty</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="general.html#isNil" class="tsd-kind-icon">is<wbr/>Nil</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="general.html#isValidJson" class="tsd-kind-icon">is<wbr/>Valid<wbr/>Json</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="isEmpty" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> is<wbr/>Empty</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">is<wbr/>Empty<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/general/isEmpty.ts#L9">general/isEmpty.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>Check if given value is empty</p>
3
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>Value to be checked</p>
5
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Boolean indicating if given value is empty</p>
6
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="isNil" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> is<wbr/>Nil</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">is<wbr/>Nil<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/general/isNil.ts#L7">general/isNil.ts:7</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
7
+ <p>Check if value is equal to null or undefined</p>
8
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
9
+ <p>Value to be checked</p>
10
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Boolean indicating if value is equal to null or undefined</p>
11
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="isValidJson" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> is<wbr/>Valid<wbr/>Json</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">is<wbr/>Valid<wbr/>Json<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/general/isValidJson.ts#L7">general/isValidJson.ts:7</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
12
+ <p>Check if string is valid JSON</p>
13
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
14
+ <p>String value to be checked</p>
15
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Boolean indicating if string value is a valid JSON</p>
16
16
  </div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="browser.html">browser</a></li><li class=" tsd-kind-module"><a href="dateTime.html">date<wbr/>Time</a></li><li class=" tsd-kind-module"><a href="dom.html">dom</a></li><li class="current tsd-kind-module"><a href="general.html">general</a></li><li class=" tsd-kind-module"><a href="schedule.html">schedule</a></li><li class=" tsd-kind-module"><a href="string.html">string</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-function tsd-parent-kind-module"><a href="general.html#isEmpty" class="tsd-kind-icon">is<wbr/>Empty</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="general.html#isNil" class="tsd-kind-icon">is<wbr/>Nil</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="general.html#isValidJson" class="tsd-kind-icon">is<wbr/>Valid<wbr/>Json</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs/modules/schedule.html CHANGED
@@ -1,13 +1,13 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>schedule | Tool-Shack</title><meta name="description" content="Documentation for Tool-Shack"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Tool-Shack</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Tool-Shack</a></li><li><a href="schedule.html">schedule</a></li></ul><h1>Module schedule</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="schedule.html#runAnimation" class="tsd-kind-icon">run<wbr/>Animation</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="schedule.html#runAsync" class="tsd-kind-icon">run<wbr/>Async</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="runAnimation" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> run<wbr/>Animation</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">run<wbr/>Animation<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span>, autoStart<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>startAnimation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>stopAnimation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/schedule/runAnimation.ts#L8">schedule/runAnimation.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
- <p>Run function as animation using requestAnimationFrame</p>
3
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>fn: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
4
- <p>Function to be run as animation</p>
5
- </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></li><li><h5>autoStart: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
6
- <p>If animation should start right away or just return callbacks</p>
7
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>startAnimation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>stopAnimation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h4><div><p>Callbacks to start animation (startAnimation) and stop animation (stopAnimation)</p>
8
- </div><ul class="tsd-parameters"><li class="tsd-parameter"><h5>start<wbr/>Animation<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">start<wbr/>Animation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/schedule/runAnimation.ts#L11">schedule/runAnimation.ts:11</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>stop<wbr/>Animation<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">stop<wbr/>Animation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/schedule/runAnimation.ts#L11">schedule/runAnimation.ts:11</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a id="runAsync" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> run<wbr/>Async</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">run<wbr/>Async<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/schedule/runAsync.ts#L7">schedule/runAsync.ts:7</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
9
- <p>Run function in asynchronously in Worker</p>
10
- </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>fn: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
11
- <p>Function to be run asynchronously</p>
12
- </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>Promise of expected result</p>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>schedule | Tool-Shack</title><meta name="description" content="Documentation for Tool-Shack"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Tool-Shack</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Tool-Shack</a></li><li><a href="schedule.html">schedule</a></li></ul><h1>Module schedule</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="schedule.html#runAnimation" class="tsd-kind-icon">run<wbr/>Animation</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="schedule.html#runAsync" class="tsd-kind-icon">run<wbr/>Async</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="runAnimation" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> run<wbr/>Animation</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">run<wbr/>Animation<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span>, autoStart<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>startAnimation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>stopAnimation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/schedule/runAnimation.ts#L8">schedule/runAnimation.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>Run function as animation using requestAnimationFrame</p>
3
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>fn: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>Function to be run as animation</p>
5
+ </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></li><li><h5>autoStart: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>If animation should start right away or just return callbacks</p>
7
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>startAnimation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>stopAnimation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h4><div><p>Callbacks to start animation (startAnimation) and stop animation (stopAnimation)</p>
8
+ </div><ul class="tsd-parameters"><li class="tsd-parameter"><h5>start<wbr/>Animation<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">start<wbr/>Animation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/schedule/runAnimation.ts#L11">schedule/runAnimation.ts:11</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>stop<wbr/>Animation<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">stop<wbr/>Animation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/schedule/runAnimation.ts#L11">schedule/runAnimation.ts:11</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a id="runAsync" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> run<wbr/>Async</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">run<wbr/>Async<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/schedule/runAsync.ts#L7">schedule/runAsync.ts:7</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
9
+ <p>Run function in asynchronously in Worker</p>
10
+ </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>fn: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
11
+ <p>Function to be run asynchronously</p>
12
+ </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>Promise of expected result</p>
13
13
  </div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="browser.html">browser</a></li><li class=" tsd-kind-module"><a href="dateTime.html">date<wbr/>Time</a></li><li class=" tsd-kind-module"><a href="dom.html">dom</a></li><li class=" tsd-kind-module"><a href="general.html">general</a></li><li class="current tsd-kind-module"><a href="schedule.html">schedule</a></li><li class=" tsd-kind-module"><a href="string.html">string</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-function tsd-parent-kind-module"><a href="schedule.html#runAnimation" class="tsd-kind-icon">run<wbr/>Animation</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="schedule.html#runAsync" class="tsd-kind-icon">run<wbr/>Async</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs/modules/string.html CHANGED
@@ -1,27 +1,27 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>string | Tool-Shack</title><meta name="description" content="Documentation for Tool-Shack"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Tool-Shack</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Tool-Shack</a></li><li><a href="string.html">string</a></li></ul><h1>Module string</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="string.html#escapeHTML" class="tsd-kind-icon">escapeHTML</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="string.html#removeDiacritics" class="tsd-kind-icon">remove<wbr/>Diacritics</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="string.html#slugify" class="tsd-kind-icon">slugify</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="string.html#truncate" class="tsd-kind-icon">truncate</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="escapeHTML" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> escapeHTML</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">escapeHTML<span class="tsd-signature-symbol">(</span>html<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/string/escapeHTML.ts#L7">string/escapeHTML.ts:7</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
- <p>Escape special HTML related characters from string</p>
3
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>html: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
4
- <p>String containing HTML related characters</p>
5
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>Safe string with escaped HTML related characters</p>
6
- </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="removeDiacritics" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> remove<wbr/>Diacritics</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">remove<wbr/>Diacritics<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/string/removeDiacritics.ts#L7">string/removeDiacritics.ts:7</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
7
- <p>Remove diacritics &amp; accents from string</p>
8
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
9
- <p>String from which should be removed diacritics &amp; accents</p>
10
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>ASCII string with removed diacritics &amp; accents</p>
11
- </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="slugify" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> slugify</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">slugify<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, separator<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/string/slugify.ts#L10">string/slugify.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
12
- <p>Create slug from given string</p>
13
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
14
- <p>String to be slugified</p>
15
- </div></div></li><li><h5>separator: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;-&#39;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
16
- <p>One character to be used as separator (if provided longer than one character, will be automatically shortened), dash (&#39;-&#39;) by default</p>
17
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>Slugified string</p>
18
- </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="truncate" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> truncate</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">truncate<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, maxLength<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, appendedString<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/string/truncate.ts#L9">string/truncate.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
19
- <p>Truncate string to maximum given length if needed and append string at the end (by default &quot;...&quot;)</p>
20
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
21
- <p>String value to be truncated</p>
22
- </div></div></li><li><h5>maxLength: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
23
- <p>Maximum allowed length</p>
24
- </div></div></li><li><h5>appendedString: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;...&#39;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
25
- <p>String to append at the end, be default &quot;...&quot;</p>
26
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>Truncated value if needed otherwise original value</p>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>string | Tool-Shack</title><meta name="description" content="Documentation for Tool-Shack"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Tool-Shack</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Tool-Shack</a></li><li><a href="string.html">string</a></li></ul><h1>Module string</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="string.html#escapeHTML" class="tsd-kind-icon">escapeHTML</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="string.html#removeDiacritics" class="tsd-kind-icon">remove<wbr/>Diacritics</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="string.html#slugify" class="tsd-kind-icon">slugify</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="string.html#truncate" class="tsd-kind-icon">truncate</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="escapeHTML" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> escapeHTML</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">escapeHTML<span class="tsd-signature-symbol">(</span>html<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/string/escapeHTML.ts#L7">string/escapeHTML.ts:7</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>Escape special HTML related characters from string</p>
3
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>html: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>String containing HTML related characters</p>
5
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>Safe string with escaped HTML related characters</p>
6
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="removeDiacritics" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> remove<wbr/>Diacritics</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">remove<wbr/>Diacritics<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/string/removeDiacritics.ts#L7">string/removeDiacritics.ts:7</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
7
+ <p>Remove diacritics &amp; accents from string</p>
8
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
9
+ <p>String from which should be removed diacritics &amp; accents</p>
10
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>ASCII string with removed diacritics &amp; accents</p>
11
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="slugify" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> slugify</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">slugify<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, separator<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/string/slugify.ts#L10">string/slugify.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
12
+ <p>Create slug from given string</p>
13
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
14
+ <p>String to be slugified</p>
15
+ </div></div></li><li><h5>separator: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;-&#39;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
16
+ <p>One character to be used as separator (if provided longer than one character, will be automatically shortened), dash (&#39;-&#39;) by default</p>
17
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>Slugified string</p>
18
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="truncate" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> truncate</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">truncate<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, maxLength<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, appendedString<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/miskith/utensils/blob/44739d7/src/string/truncate.ts#L9">string/truncate.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
19
+ <p>Truncate string to maximum given length if needed and append string at the end (by default &quot;...&quot;)</p>
20
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
21
+ <p>String value to be truncated</p>
22
+ </div></div></li><li><h5>maxLength: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
23
+ <p>Maximum allowed length</p>
24
+ </div></div></li><li><h5>appendedString: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;...&#39;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
25
+ <p>String to append at the end, be default &quot;...&quot;</p>
26
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>Truncated value if needed otherwise original value</p>
27
27
  </div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="browser.html">browser</a></li><li class=" tsd-kind-module"><a href="dateTime.html">date<wbr/>Time</a></li><li class=" tsd-kind-module"><a href="dom.html">dom</a></li><li class=" tsd-kind-module"><a href="general.html">general</a></li><li class=" tsd-kind-module"><a href="schedule.html">schedule</a></li><li class="current tsd-kind-module"><a href="string.html">string</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-function tsd-parent-kind-module"><a href="string.html#escapeHTML" class="tsd-kind-icon">escapeHTML</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="string.html#removeDiacritics" class="tsd-kind-icon">remove<wbr/>Diacritics</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="string.html#slugify" class="tsd-kind-icon">slugify</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="string.html#truncate" class="tsd-kind-icon">truncate</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tool-shack",
3
- "version": "0.0.10",
3
+ "version": "0.0.11",
4
4
  "description": "Collection of usefull functions to ease work",
5
5
  "main": "dist",
6
6
  "author": "David Myška",
package/src/dom/createElement.ts CHANGED
@@ -9,7 +9,7 @@ import { IExtendingElementProps } from './interfaces/createElement';
9
9
  */
10
10
  export const createElement = <T = HTMLElement>(
11
11
  tagName: string,
12
- props?: Partial<Omit<T, 'children' | 'dataset'>> & IExtendingElementProps,
12
+ props?: Partial<Omit<T, 'children' | 'dataset' | 'style'>> & IExtendingElementProps,
13
13
  ): T => {
14
14
  const element: HTMLElement = document.createElement(tagName);
15
15
 
@@ -23,6 +23,10 @@ export const createElement = <T = HTMLElement>(
23
23
  for (let ariaKey in props.aria!) {
24
24
  element.setAttribute(`aria-${ariaKey}`, value[ariaKey]);
25
25
  }
26
+ } else if (key === 'style') {
27
+ for (let styleKey in props.style!) {
28
+ (element.style as any)[styleKey] = value[styleKey];
29
+ }
26
30
  } else if (key === 'children') {
27
31
  props.children!.forEach((child: HTMLElement) => element.appendChild(child));
28
32
  } else if (key === 'listeners') {
package/src/dom/interfaces/createElement.ts CHANGED
@@ -1,35 +1,36 @@
1
- export type TAriaLabelKey =
2
- | 'atomic'
3
- | 'busy'
4
- | 'controls'
5
- | 'current'
6
- | 'describedby'
7
- | 'details'
8
- | 'disables'
9
- | 'dropeffect'
10
- | 'errormessage'
11
- | 'expanded'
12
- | 'flowto'
13
- | 'grabbed'
14
- | 'haspopup'
15
- | 'hidden'
16
- | 'invalid'
17
- | 'keyshortcuts'
18
- | 'label'
19
- | 'labelledby'
20
- | 'live'
21
- | 'modal'
22
- | 'owns'
23
- | 'relevant'
24
- | 'roledescription';
25
-
26
- export interface IExtendingElementProps {
27
- children?: HTMLElement[];
28
- listeners?: Record<
29
- string,
30
- EventListenerOrEventListenerObject | EventListenerOrEventListenerObject[]
31
- >;
32
- role?: string;
33
- aria?: Partial<Record<TAriaLabelKey, string>>;
34
- dataset?: Record<string, string>;
35
- }
1
+ export type TAriaLabelKey =
2
+ | 'atomic'
3
+ | 'busy'
4
+ | 'controls'
5
+ | 'current'
6
+ | 'describedby'
7
+ | 'details'
8
+ | 'disables'
9
+ | 'dropeffect'
10
+ | 'errormessage'
11
+ | 'expanded'
12
+ | 'flowto'
13
+ | 'grabbed'
14
+ | 'haspopup'
15
+ | 'hidden'
16
+ | 'invalid'
17
+ | 'keyshortcuts'
18
+ | 'label'
19
+ | 'labelledby'
20
+ | 'live'
21
+ | 'modal'
22
+ | 'owns'
23
+ | 'relevant'
24
+ | 'roledescription';
25
+
26
+ export interface IExtendingElementProps {
27
+ children?: HTMLElement[];
28
+ listeners?: Record<
29
+ string,
30
+ EventListenerOrEventListenerObject | EventListenerOrEventListenerObject[]
31
+ >;
32
+ role?: string;
33
+ aria?: Partial<Record<TAriaLabelKey, string>>;
34
+ dataset?: Record<string, string>;
35
+ style?: Record<string, string | number>;
36
+ }