nanosplash 2.4.0 → 2.5.2

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 (33) hide show
  1. package/.github/workflows/production.yml +5 -2
  2. package/README.md +1 -1
  3. package/dist/iife/nanosplash.iife.js +1 -1
  4. package/dist/module/manifest.json +1 -4
  5. package/dist/module/nanosplash.cjs.js +1 -1
  6. package/dist/module/nanosplash.es.js +122 -67
  7. package/dist/module/{Nanosplash.css → style.css} +0 -0
  8. package/docs/index.html +51 -19
  9. package/docs/nanosplash.iife.js +3 -3
  10. package/docs/typedoc/assets/search.js +1 -1
  11. package/docs/typedoc/classes/Core_Nanosplash.default.html +133 -0
  12. package/docs/typedoc/modules/Core_Nanosplash.html +1 -1
  13. package/docs/typedoc/modules/types.html +1 -1
  14. package/index.html +51 -19
  15. package/package.json +10 -9
  16. package/src/Core/Nanosplash.ts +160 -38
  17. package/src/Core/SplashInstance.ts +29 -23
  18. package/src/Exceptions/DestinationException.ts +13 -0
  19. package/src/Exceptions/Exception.ts +9 -0
  20. package/src/Exceptions/IllegalArgumentException.ts +11 -0
  21. package/src/Factory/NanosplashFactory.ts +37 -5
  22. package/src/Interfaces/NanosplashInterface.ts +6 -1
  23. package/src/{repositories → Repositories}/NanosplashRepository.ts +37 -6
  24. package/src/{utilities → Tests}/dom.spec.ts +7 -5
  25. package/src/{utilities → Utilities}/dom.ts +23 -0
  26. package/src/main.ts +2 -5
  27. package/src/types.d.ts +19 -13
  28. package/tsconfig.json +1 -0
  29. package/update-all.sh +2 -2
  30. package/vite.config.ts +16 -0
  31. package/vite.mod.config.js +10 -11
  32. package/docs/typedoc/classes/Core_Nanosplash.Nanosplash.html +0 -59
  33. package/jest.config.ts +0 -194
package/docs/typedoc/modules/types.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>types | nanosplash</title><meta name="description" content="Documentation for nanosplash"/><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">nanosplash</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="../index.html">nanosplash</a></li><li><a href="types.html">types</a></li></ul><h1>Module types </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>Type Aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ContextualAPIObject" class="tsd-kind-icon">ContextualAPIObject</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#Destination" class="tsd-kind-icon">Destination</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ImgFunction" class="tsd-kind-icon">Img<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#InsideFunction" class="tsd-kind-icon">Inside<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#InstanceIterationCallback" class="tsd-kind-icon">Instance<wbr/>Iteration<wbr/>Callback</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#NanosplashOptions" class="tsd-kind-icon">Nanosplash<wbr/>Options</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ProgressFunction" class="tsd-kind-icon">Progress<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ShowFunction" class="tsd-kind-icon">Show<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#SplashJob" class="tsd-kind-icon">Splash<wbr/>Job</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#StrategyObject" class="tsd-kind-icon">Strategy<wbr/>Object</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#WhileFunction" class="tsd-kind-icon">While<wbr/>Function</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="ContextualAPIObject" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ContextualAPIObject<a href="#ContextualAPIObject" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ContextualAPIObject<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>inside<span class="tsd-signature-symbol">?: </span><a href="types.html#InsideFunction" class="tsd-signature-type" data-tsd-kind="Type alias">InsideFunction</a><span class="tsd-signature-symbol">; </span>getId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getImgSrc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getText<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>moveTo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>remove<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>setImgSrc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>setText<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L37">types.d.ts:37</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> inside<span class="tsd-signature-symbol">?: </span><a href="types.html#InsideFunction" class="tsd-signature-type" data-tsd-kind="Type alias">InsideFunction</a></h5></li><li class="tsd-parameter"><h5>get<wbr/>Id<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">get<wbr/>Id<span class="tsd-signature-symbol">(</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/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L38">types.d.ts:38</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li><li class="tsd-parameter"><h5>get<wbr/>Img<wbr/>Src<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">get<wbr/>Img<wbr/>Src<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</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/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L44">types.d.ts:44</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></li><li class="tsd-parameter"><h5>get<wbr/>Text<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">get<wbr/>Text<span class="tsd-signature-symbol">(</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/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L42">types.d.ts:42</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li><li class="tsd-parameter"><h5>move<wbr/>To<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">move<wbr/>To<span class="tsd-signature-symbol">(</span>selector<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">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/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L41">types.d.ts:41</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>selector: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>remove<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">remove<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/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L40">types.d.ts:40</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>set<wbr/>Img<wbr/>Src<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">set<wbr/>Img<wbr/>Src<span class="tsd-signature-symbol">(</span>src<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">SplashInstance</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L45">types.d.ts:45</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> src: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SplashInstance</span></h4></li></ul></li><li class="tsd-parameter"><h5>set<wbr/>Text<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">set<wbr/>Text<span class="tsd-signature-symbol">(</span>text<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">SplashInstance</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L43">types.d.ts:43</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>text: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SplashInstance</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="Destination" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Destination<a href="#Destination" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Destination<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Node</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L14">types.d.ts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="ImgFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Img<wbr/>Function<a href="#ImgFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Img<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>src<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="types.html#StrategyObject" class="tsd-signature-type" data-tsd-kind="Type alias">StrategyObject</a><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L35">types.d.ts:35</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>src<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><a href="types.html#StrategyObject" class="tsd-signature-type" data-tsd-kind="Type alias">StrategyObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>src: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="types.html#StrategyObject" class="tsd-signature-type" data-tsd-kind="Type alias">StrategyObject</a></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="InsideFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Inside<wbr/>Function<a href="#InsideFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Inside<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ContextualAPIInterface</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L36">types.d.ts:36</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>selector<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">ContextualAPIInterface</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>selector: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ContextualAPIInterface</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="InstanceIterationCallback" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Instance<wbr/>Iteration<wbr/>Callback<a href="#InstanceIterationCallback" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Instance<wbr/>Iteration<wbr/>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, splashInstance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SplashInstance</span>, i<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L47">types.d.ts:47</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, splashInstance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SplashInstance</span>, i<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><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5></li><li><h5>splashInstance: <span class="tsd-signature-type">SplashInstance</span></h5></li><li><h5>i: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="NanosplashOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Nanosplash<wbr/>Options<a href="#NanosplashOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Nanosplash<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>fontSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>imgSrc<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>spinner<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L49">types.d.ts:49</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> font<wbr/>Size<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> img<wbr/>Src<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> spinner<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="ProgressFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Progress<wbr/>Function<a href="#ProgressFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Progress<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>[]<span class="tsd-signature-symbol">: </span><a href="types.html#SplashJob" class="tsd-signature-type" data-tsd-kind="Type alias">SplashJob</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ContextualAPIInterface</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L28">types.d.ts:28</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><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><a href="types.html#SplashJob" class="tsd-signature-type" data-tsd-kind="Type alias">SplashJob</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ContextualAPIInterface</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>[]: <a href="types.html#SplashJob" class="tsd-signature-type" data-tsd-kind="Type alias">SplashJob</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ContextualAPIInterface</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="ShowFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Show<wbr/>Function<a href="#ShowFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Show<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ContextualAPIInterface</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L27">types.d.ts:27</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>text<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">ContextualAPIInterface</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>text: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ContextualAPIInterface</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="SplashJob" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Splash<wbr/>Job<a href="#SplashJob" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Splash<wbr/>Job<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">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L15">types.d.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="StrategyObject" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Strategy<wbr/>Object<a href="#StrategyObject" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Strategy<wbr/>Object<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>progress<span class="tsd-signature-symbol">: </span><a href="types.html#ProgressFunction" class="tsd-signature-type" data-tsd-kind="Type alias">ProgressFunction</a><span class="tsd-signature-symbol">; </span>show<span class="tsd-signature-symbol">: </span><a href="types.html#ShowFunction" class="tsd-signature-type" data-tsd-kind="Type alias">ShowFunction</a><span class="tsd-signature-symbol">; </span>while<span class="tsd-signature-symbol">: </span><a href="types.html#WhileFunction" class="tsd-signature-type" data-tsd-kind="Type alias">WhileFunction</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L30">types.d.ts:30</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>progress<span class="tsd-signature-symbol">: </span><a href="types.html#ProgressFunction" class="tsd-signature-type" data-tsd-kind="Type alias">ProgressFunction</a></h5></li><li class="tsd-parameter"><h5>show<span class="tsd-signature-symbol">: </span><a href="types.html#ShowFunction" class="tsd-signature-type" data-tsd-kind="Type alias">ShowFunction</a></h5></li><li class="tsd-parameter"><h5>while<span class="tsd-signature-symbol">: </span><a href="types.html#WhileFunction" class="tsd-signature-type" data-tsd-kind="Type alias">WhileFunction</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="WhileFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">While<wbr/>Function<a href="#WhileFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">While<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>asyncTask<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">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ShowInterface</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L29">types.d.ts:29</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>asyncTask<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">any</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">ShowInterface</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>asyncTask: <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ShowInterface</span></h4></li></ul></li></ul></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Modules</a></li><li class=" tsd-kind-module"><a href="Core_Nanosplash.html">Core/<wbr/>Nanosplash</a></li><li class="current tsd-kind-module"><a href="types.html">types</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ContextualAPIObject" class="tsd-kind-icon">ContextualAPIObject</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#Destination" class="tsd-kind-icon">Destination</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ImgFunction" class="tsd-kind-icon">Img<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#InsideFunction" class="tsd-kind-icon">Inside<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#InstanceIterationCallback" class="tsd-kind-icon">Instance<wbr/>Iteration<wbr/>Callback</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#NanosplashOptions" class="tsd-kind-icon">Nanosplash<wbr/>Options</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ProgressFunction" class="tsd-kind-icon">Progress<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ShowFunction" class="tsd-kind-icon">Show<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#SplashJob" class="tsd-kind-icon">Splash<wbr/>Job</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#StrategyObject" class="tsd-kind-icon">Strategy<wbr/>Object</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#WhileFunction" class="tsd-kind-icon">While<wbr/>Function</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-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</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>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>types | nanosplash</title><meta name="description" content="Documentation for nanosplash"/><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">nanosplash</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="../index.html">nanosplash</a></li><li><a href="types.html">types</a></li></ul><h1>Module types </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>References</h3><ul class="tsd-index-list"><li class="tsd-kind-reference tsd-parent-kind-module"><a href="types.html#default" class="tsd-kind-icon">default</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="types.html#ContextualAPIObject" class="tsd-kind-icon">ContextualAPIObject</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#Destination" class="tsd-kind-icon">Destination</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#InsideFunction" class="tsd-kind-icon">Inside<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#InstanceIterationCallback" class="tsd-kind-icon">Instance<wbr/>Iteration<wbr/>Callback</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#NanosplashOptions" class="tsd-kind-icon">Nanosplash<wbr/>Options</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ProgressFunction" class="tsd-kind-icon">Progress<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ShowFunction" class="tsd-kind-icon">Show<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#SplashJob" class="tsd-kind-icon">Splash<wbr/>Job</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#StrategyObject" class="tsd-kind-icon">Strategy<wbr/>Object</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#WhileFunction" class="tsd-kind-icon">While<wbr/>Function</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>References</h2><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="default" class="tsd-anchor"></a><h3 class="tsd-anchor-link">default<a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3>Re-exports <a href="../classes/Core_Nanosplash.default.html">default</a></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="ContextualAPIObject" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ContextualAPIObject<a href="#ContextualAPIObject" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ContextualAPIObject<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>inside<span class="tsd-signature-symbol">?: </span><a href="types.html#InsideFunction" class="tsd-signature-type" data-tsd-kind="Type alias">InsideFunction</a><span class="tsd-signature-symbol">; </span>getId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getImgSrc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getText<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>moveTo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>remove<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>setImgSrc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>setText<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/22d812b/src/types.d.ts#L39">types.d.ts:39</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> inside<span class="tsd-signature-symbol">?: </span><a href="types.html#InsideFunction" class="tsd-signature-type" data-tsd-kind="Type alias">InsideFunction</a></h5></li><li class="tsd-parameter"><h5>get<wbr/>Id<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">get<wbr/>Id<span class="tsd-signature-symbol">(</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/isakhauge/nanosplash/blob/22d812b/src/types.d.ts#L40">types.d.ts:40</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li><li class="tsd-parameter"><h5>get<wbr/>Img<wbr/>Src<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">get<wbr/>Img<wbr/>Src<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</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/isakhauge/nanosplash/blob/22d812b/src/types.d.ts#L46">types.d.ts:46</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></li><li class="tsd-parameter"><h5>get<wbr/>Text<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">get<wbr/>Text<span class="tsd-signature-symbol">(</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/isakhauge/nanosplash/blob/22d812b/src/types.d.ts#L44">types.d.ts:44</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li><li class="tsd-parameter"><h5>move<wbr/>To<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">move<wbr/>To<span class="tsd-signature-symbol">(</span>selector<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">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/isakhauge/nanosplash/blob/22d812b/src/types.d.ts#L43">types.d.ts:43</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>selector: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>remove<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">remove<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/isakhauge/nanosplash/blob/22d812b/src/types.d.ts#L42">types.d.ts:42</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>set<wbr/>Img<wbr/>Src<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">set<wbr/>Img<wbr/>Src<span class="tsd-signature-symbol">(</span>src<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">SplashInstance</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/22d812b/src/types.d.ts#L47">types.d.ts:47</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> src: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SplashInstance</span></h4></li></ul></li><li class="tsd-parameter"><h5>set<wbr/>Text<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">set<wbr/>Text<span class="tsd-signature-symbol">(</span>text<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">SplashInstance</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/22d812b/src/types.d.ts#L45">types.d.ts:45</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>text: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SplashInstance</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="Destination" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Destination<a href="#Destination" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Destination<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Node</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/22d812b/src/types.d.ts#L15">types.d.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="InsideFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Inside<wbr/>Function<a href="#InsideFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Inside<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ContextualAPIInterface</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/22d812b/src/types.d.ts#L37">types.d.ts:37</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>selector<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">ContextualAPIInterface</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>selector: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ContextualAPIInterface</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="InstanceIterationCallback" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Instance<wbr/>Iteration<wbr/>Callback<a href="#InstanceIterationCallback" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Instance<wbr/>Iteration<wbr/>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, splashInstance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SplashInstance</span>, i<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/22d812b/src/types.d.ts#L50">types.d.ts:50</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, splashInstance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SplashInstance</span>, i<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><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5></li><li><h5>splashInstance: <span class="tsd-signature-type">SplashInstance</span></h5></li><li><h5>i: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="NanosplashOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Nanosplash<wbr/>Options<a href="#NanosplashOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Nanosplash<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>debug<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>fontSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>imgSrc<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>spinner<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/22d812b/src/types.d.ts#L52">types.d.ts:52</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> debug<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> font<wbr/>Size<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> img<wbr/>Src<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> spinner<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="ProgressFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Progress<wbr/>Function<a href="#ProgressFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Progress<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>[]<span class="tsd-signature-symbol">: </span><a href="types.html#SplashJob" class="tsd-signature-type" data-tsd-kind="Type alias">SplashJob</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="types.html#ContextualAPIObject" class="tsd-signature-type" data-tsd-kind="Type alias">ContextualAPIObject</a><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/22d812b/src/types.d.ts#L29">types.d.ts:29</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><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><a href="types.html#SplashJob" class="tsd-signature-type" data-tsd-kind="Type alias">SplashJob</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="types.html#ContextualAPIObject" class="tsd-signature-type" data-tsd-kind="Type alias">ContextualAPIObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>[]: <a href="types.html#SplashJob" class="tsd-signature-type" data-tsd-kind="Type alias">SplashJob</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="types.html#ContextualAPIObject" class="tsd-signature-type" data-tsd-kind="Type alias">ContextualAPIObject</a></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="ShowFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Show<wbr/>Function<a href="#ShowFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Show<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="types.html#ContextualAPIObject" class="tsd-signature-type" data-tsd-kind="Type alias">ContextualAPIObject</a><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/22d812b/src/types.d.ts#L28">types.d.ts:28</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>text<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><a href="types.html#ContextualAPIObject" class="tsd-signature-type" data-tsd-kind="Type alias">ContextualAPIObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>text: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="types.html#ContextualAPIObject" class="tsd-signature-type" data-tsd-kind="Type alias">ContextualAPIObject</a></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="SplashJob" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Splash<wbr/>Job<a href="#SplashJob" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Splash<wbr/>Job<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">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/22d812b/src/types.d.ts#L16">types.d.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="StrategyObject" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Strategy<wbr/>Object<a href="#StrategyObject" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Strategy<wbr/>Object<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>progress<span class="tsd-signature-symbol">: </span><a href="types.html#ProgressFunction" class="tsd-signature-type" data-tsd-kind="Type alias">ProgressFunction</a><span class="tsd-signature-symbol">; </span>show<span class="tsd-signature-symbol">: </span><a href="types.html#ShowFunction" class="tsd-signature-type" data-tsd-kind="Type alias">ShowFunction</a><span class="tsd-signature-symbol">; </span>while<span class="tsd-signature-symbol">: </span><a href="types.html#WhileFunction" class="tsd-signature-type" data-tsd-kind="Type alias">WhileFunction</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/22d812b/src/types.d.ts#L31">types.d.ts:31</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>progress<span class="tsd-signature-symbol">: </span><a href="types.html#ProgressFunction" class="tsd-signature-type" data-tsd-kind="Type alias">ProgressFunction</a></h5></li><li class="tsd-parameter"><h5>show<span class="tsd-signature-symbol">: </span><a href="types.html#ShowFunction" class="tsd-signature-type" data-tsd-kind="Type alias">ShowFunction</a></h5></li><li class="tsd-parameter"><h5>while<span class="tsd-signature-symbol">: </span><a href="types.html#WhileFunction" class="tsd-signature-type" data-tsd-kind="Type alias">WhileFunction</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="WhileFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">While<wbr/>Function<a href="#WhileFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">While<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>asyncTask<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">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ShowInterface</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/22d812b/src/types.d.ts#L30">types.d.ts:30</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>asyncTask<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">any</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">ShowInterface</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>asyncTask: <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ShowInterface</span></h4></li></ul></li></ul></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Modules</a></li><li class=" tsd-kind-module"><a href="Core_Nanosplash.html">Core/<wbr/>Nanosplash</a></li><li class="current tsd-kind-module"><a href="types.html">types</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-reference tsd-parent-kind-module"><a href="types.html#default" class="tsd-kind-icon">default</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ContextualAPIObject" class="tsd-kind-icon">ContextualAPIObject</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#Destination" class="tsd-kind-icon">Destination</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#InsideFunction" class="tsd-kind-icon">Inside<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#InstanceIterationCallback" class="tsd-kind-icon">Instance<wbr/>Iteration<wbr/>Callback</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#NanosplashOptions" class="tsd-kind-icon">Nanosplash<wbr/>Options</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ProgressFunction" class="tsd-kind-icon">Progress<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ShowFunction" class="tsd-kind-icon">Show<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#SplashJob" class="tsd-kind-icon">Splash<wbr/>Job</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#StrategyObject" class="tsd-kind-icon">Strategy<wbr/>Object</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#WhileFunction" class="tsd-kind-icon">While<wbr/>Function</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-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</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/index.html CHANGED
@@ -15,6 +15,21 @@
15
15
  <div class="w-100 min-h-screen flex flex-col justify-center items-center">
16
16
  <div class="text-4xl text-slate-900 drop-shadow-lg">Nanosplash</div>
17
17
  <div class="text-pink-500 mt-3 font-mono text-sm">ns.show('text').inside('#id')</div>
18
+ <div class="flex gap-5">
19
+ <div
20
+ id="demo"
21
+ class="bg-pink-500 text-pink-200 p-3 cursor-pointer hover:text-white rounded-xl shadow-xl mt-8"
22
+ >
23
+ <i class="lni lni-play"></i>
24
+ Display demo
25
+ </div>
26
+ <a
27
+ href="#example"
28
+ class="bg-slate-500 text-slate-200 p-3 cursor-pointer hover:text-white rounded-xl shadow-xl mt-8"
29
+ >
30
+ Show examples
31
+ </a>
32
+ </div>
18
33
  <div class="flex flex-col space-y-2 my-10">
19
34
  <div class="flex space-x-2 justify-center">
20
35
  <img src="https://badgen.net/npm/v/nanosplash" />
@@ -38,9 +53,9 @@
38
53
  <a href="https://www.npmjs.com/package/nanosplash" target="_blank"><i class="lni lni-npm text-4xl hover:text-pink-500 px-5"></i></a>
39
54
  <a href="https://github.com/isakhauge/nanosplash" target="_blank"><i class="lni lni-github-original text-2xl hover:text-pink-500 px-5"></i></a>
40
55
  </div>
41
- <a class="mt-10 text-pink-300 hover:text-pink-500" href="/typedoc">API Reference Documentation</a>
56
+ <a class="mt-10 text-pink-300 hover:text-pink-500" href="https://rawcdn.githack.com/isakhauge/nanosplash/0a6cdef58b0e47c0cad911952b1a329df58d2c24/docs/typedoc/index.html">API Reference Documentation</a>
42
57
  </div>
43
- <div class="grid grid-cols-1 xl:grid-cols-2 gap-1">
58
+ <div id="example" class="grid grid-cols-1 xl:grid-cols-2 gap-1">
44
59
  <div id="a" class="p-20 bg-slate-100 flex flex-col items-center">
45
60
  <div class="text-xl mb-10">Give user progress feedback</div>
46
61
  <div class="text-white bg-slate-800 p-5 rounded-xl shadow-2xl font-mono text-sm break-all">
@@ -60,9 +75,7 @@
60
75
  <div id="c" class="p-20 bg-slate-100 flex flex-col items-center">
61
76
  <div class="text-xl mb-10">Display fullscreen</div>
62
77
  <div class="text-white bg-slate-800 p-5 rounded-xl shadow-2xl font-mono text-sm break-all">
63
- const splash = ns.show('Fullscreen text')<br>
64
- splash.moveTo('#myDiv')<br>
65
- splash.remove()
78
+ ns.show('Fullscreen text')
66
79
  </div>
67
80
  </div>
68
81
  <div id="d" class="p-20 bg-slate-100 flex flex-col items-center">
@@ -70,26 +83,45 @@
70
83
  <div class="text-white bg-slate-800 p-5 rounded-xl shadow-2xl font-mono text-sm break-all">
71
84
  ns.show('Loading component A').inside('#a')<br>
72
85
  ns.show('Loading component B').inside('#b')<br>
73
- ns.show('Loading component C').inside('#c')<br>
74
- <br><br>
75
- ns.hide() // Removes instances in a LIFO manner.<br>
76
- ns.hideAll() // Removes all instances.
86
+ ns.show('Loading component C').inside('#c')
87
+ </div>
88
+ </div>
89
+ <div id="e" class="p-20 bg-slate-100 flex flex-col items-center">
90
+ <div class="text-xl mb-10">Move splash instance to another destination</div>
91
+ <div class="text-white bg-slate-800 p-5 rounded-xl shadow-2xl font-mono text-sm break-all">
92
+ const splash = ns.show('Loading').inside('#a')<br>
93
+ splash.moveTo('#b')
94
+ </div>
95
+ </div>
96
+ <div id="f" class="p-20 bg-slate-100 flex flex-col items-center">
97
+ <div class="text-xl mb-10">Hide splash instances</div>
98
+ <div class="text-white bg-slate-800 p-5 rounded-xl shadow-2xl font-mono text-sm break-all">
99
+ // Hides one instance at a time, in a LIFO-fashion.<br>
100
+ ns.hide()<br><br>
101
+ // Hides all instances.<br>
102
+ ns.hideAll()
77
103
  </div>
78
104
  </div>
79
105
  </div>
80
106
  <footer>
81
107
  <script type="module" src="/src/main.ts"></script>
82
108
  <script>
83
- document.getElementById('copy').onclick = function () {
84
- const text = document.querySelector('[data-copy]').innerText
85
- navigator.clipboard.writeText(text)
86
- alert('Copied to clipboard!')
87
- }
88
- window.onload = () => {
89
- setTimeout(() => {
90
- window.installNanosplash({spinner: true})
91
- }, 100)
92
- }
109
+ window.addEventListener('load', () => {
110
+ document.getElementById('demo').onclick = function () {
111
+ const wait = ms => new Promise(r => setTimeout(r, ms))
112
+ window.ns.progress(
113
+ [wait(2000), 'Loading data from API'],
114
+ [wait(4000), 'Restructuring'],
115
+ [wait(6000), 'Indexing'],
116
+ [wait(8000), 'Give this repo a star']
117
+ )
118
+ }
119
+ document.getElementById('copy').onclick = function () {
120
+ const text = document.querySelector('[data-copy]').innerText
121
+ navigator.clipboard.writeText(text)
122
+ alert('Copied to clipboard!')
123
+ }
124
+ })
93
125
  </script>
94
126
  </footer>
95
127
  <style>
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "nanosplash",
3
3
  "description": "The simple, tiny loading screen",
4
- "version": "2.4.0",
4
+ "version": "2.5.2",
5
5
  "author": {
6
6
  "name": "Isak K. Hauge",
7
7
  "email": "isakhauge@gmail.com",
@@ -52,22 +52,23 @@
52
52
  "doc": "typedoc --readme none --excludePrivate --excludeInternal --out docs/typedoc --entryPoints src/Core/Nanosplash.ts src/types.d.ts",
53
53
  "doc.watch": "yarn doc --watch",
54
54
  "serve": "vite preview",
55
- "test": "jest"
55
+ "test": "vitest",
56
+ "coverage": "vitest run --coverage"
56
57
  },
57
58
  "devDependencies": {
58
59
  "@types/jest": "^28.1.1",
59
60
  "@types/jsdom": "^16.2.14",
60
61
  "autoprefixer": "^10.4.7",
61
- "cssnano": "^5.1.11",
62
- "jest": "^28.1.1",
63
- "jest-environment-jsdom": "^28.1.1",
64
- "jsdom": "^19.0.0",
62
+ "c8": "^7.11.3",
63
+ "cssnano": "^5.1.12",
64
+ "jsdom": "^20.0.0",
65
65
  "postcss": "^8.4.14",
66
66
  "sass": "^1.52.3",
67
- "ts-jest": "^28.0.4",
67
+ "ts-jest": "^28.0.5",
68
68
  "ts-node": "^10.8.1",
69
69
  "typedoc": "^0.22.17",
70
- "typescript": "^4.7.3",
71
- "vite": "^2.9.12"
70
+ "typescript": "^4.7.4",
71
+ "vite": "^2.9.12",
72
+ "vitest": "^0.15.1"
72
73
  }
73
74
  }