nanosplash 2.5.0 → 2.5.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/iife/nanosplash.iife.js +1 -1
- package/dist/module/nanosplash.cjs.js +1 -1
- package/dist/module/nanosplash.es.js +88 -53
- package/docs/index.html +16 -14
- package/docs/nanosplash.iife.js +3 -3
- package/docs/typedoc/assets/search.js +1 -1
- package/docs/typedoc/classes/Core_Nanosplash.default.html +16 -18
- package/docs/typedoc/modules/types.html +1 -1
- package/index.html +16 -14
- package/package.json +10 -9
- package/src/Core/Nanosplash.ts +61 -27
- package/src/Core/SplashInstance.ts +25 -18
- package/src/Exceptions/DestinationException.ts +13 -0
- package/src/Exceptions/Exception.ts +9 -0
- package/src/Exceptions/IllegalArgumentException.ts +11 -0
- package/src/Factory/NanosplashFactory.ts +5 -4
- package/src/{repositories → Repositories}/NanosplashRepository.ts +23 -6
- package/src/{utilities → Tests}/dom.spec.ts +2 -1
- package/src/{utilities → Utilities}/dom.ts +0 -0
- package/src/types.d.ts +5 -3
- package/tsconfig.json +1 -0
- package/update-all.sh +2 -2
- package/vite.config.ts +16 -0
- package/vite.mod.config.js +4 -13
- package/jest.config.ts +0 -194
|
@@ -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>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/c2f2e82/src/types.d.ts#L38">types.d.ts:38</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/c2f2e82/src/types.d.ts#L39">types.d.ts:39</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/c2f2e82/src/types.d.ts#L45">types.d.ts:45</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/c2f2e82/src/types.d.ts#L43">types.d.ts:43</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/c2f2e82/src/types.d.ts#L42">types.d.ts:42</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/c2f2e82/src/types.d.ts#L41">types.d.ts:41</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/c2f2e82/src/types.d.ts#L46">types.d.ts:46</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/c2f2e82/src/types.d.ts#L44">types.d.ts:44</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/c2f2e82/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"> => </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/c2f2e82/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"> => </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/c2f2e82/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-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/c2f2e82/src/types.d.ts#L51">types.d.ts:51</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"> => </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/c2f2e82/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><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"> => </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/c2f2e82/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><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"><</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">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/c2f2e82/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/c2f2e82/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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </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/c2f2e82/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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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>
|
|
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/c03bf50/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/c03bf50/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/c03bf50/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/c03bf50/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/c03bf50/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/c03bf50/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/c03bf50/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/c03bf50/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/c03bf50/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"> => </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/c03bf50/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"> => </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/c03bf50/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/c03bf50/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"> => </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/c03bf50/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"> => </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/c03bf50/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"><</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">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/c03bf50/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/c03bf50/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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </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/c03bf50/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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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
|
@@ -106,20 +106,22 @@
|
|
|
106
106
|
<footer>
|
|
107
107
|
<script type="module" src="/src/main.ts"></script>
|
|
108
108
|
<script>
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
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
|
+
})
|
|
123
125
|
</script>
|
|
124
126
|
</footer>
|
|
125
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.5.
|
|
4
|
+
"version": "2.5.3",
|
|
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": "
|
|
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
|
-
"
|
|
62
|
-
"
|
|
63
|
-
"
|
|
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.
|
|
67
|
+
"ts-jest": "^28.0.5",
|
|
68
68
|
"ts-node": "^10.8.1",
|
|
69
69
|
"typedoc": "^0.22.17",
|
|
70
|
-
"typescript": "^4.7.
|
|
71
|
-
"vite": "^2.9.12"
|
|
70
|
+
"typescript": "^4.7.4",
|
|
71
|
+
"vite": "^2.9.12",
|
|
72
|
+
"vitest": "^0.15.1"
|
|
72
73
|
}
|
|
73
74
|
}
|
package/src/Core/Nanosplash.ts
CHANGED
|
@@ -1,11 +1,18 @@
|
|
|
1
1
|
import '../style.sass'
|
|
2
|
-
import {get} from "../
|
|
2
|
+
import {get} from "../Utilities/dom";
|
|
3
3
|
import {SplashInstance} from "./SplashInstance";
|
|
4
4
|
import {ShowInterface} from "../Interfaces/ShowInterface";
|
|
5
5
|
import {NanosplashFactory} from "../Factory/NanosplashFactory";
|
|
6
6
|
import {NanosplashInterface} from "../Interfaces/NanosplashInterface";
|
|
7
|
-
import {
|
|
8
|
-
|
|
7
|
+
import {
|
|
8
|
+
ContextualAPIObject,
|
|
9
|
+
Destination,
|
|
10
|
+
InstanceIterationCallback,
|
|
11
|
+
NanosplashOptions,
|
|
12
|
+
SplashJob,
|
|
13
|
+
} from "../types";
|
|
14
|
+
import Exception from "../Exceptions/Exception";
|
|
15
|
+
import IllegalArgumentException from "../Exceptions/IllegalArgumentException";
|
|
9
16
|
|
|
10
17
|
/**
|
|
11
18
|
* # Nanosplash
|
|
@@ -14,6 +21,8 @@ import {InstanceIterationCallback, NanosplashOptions, SplashJob} from "../types"
|
|
|
14
21
|
class Nanosplash implements NanosplashInterface {
|
|
15
22
|
public static APP_NAME = 'Nanosplash'
|
|
16
23
|
private static SPINNER_DEFAULT_VISIBILITY = true
|
|
24
|
+
private static DEBUG = true
|
|
25
|
+
public debug: boolean
|
|
17
26
|
private imgSrc: string | undefined
|
|
18
27
|
private spinner: boolean
|
|
19
28
|
private fontSize: string
|
|
@@ -24,6 +33,9 @@ class Nanosplash implements NanosplashInterface {
|
|
|
24
33
|
* @param {NanosplashOptions | undefined} options Nanosplash options object.
|
|
25
34
|
*/
|
|
26
35
|
public constructor(options?: NanosplashOptions) {
|
|
36
|
+
this.debug = ((options?.debug === undefined)
|
|
37
|
+
? Nanosplash.DEBUG
|
|
38
|
+
: options.debug) as boolean
|
|
27
39
|
this.imgSrc = options?.imgSrc
|
|
28
40
|
this.spinner = (options?.spinner === undefined)
|
|
29
41
|
? Nanosplash.SPINNER_DEFAULT_VISIBILITY
|
|
@@ -92,23 +104,21 @@ class Nanosplash implements NanosplashInterface {
|
|
|
92
104
|
* # Show
|
|
93
105
|
* @param {string} text
|
|
94
106
|
*/
|
|
95
|
-
public show(text: string):
|
|
107
|
+
public show(text: string): ContextualAPIObject {
|
|
96
108
|
return NanosplashFactory.createShowFunction(this, new SplashInstance(this, text, this.imgSrc))(text)
|
|
97
109
|
}
|
|
98
110
|
|
|
99
111
|
/**
|
|
100
112
|
* # Progress
|
|
101
113
|
* @param {SplashJob[]} jobs An array or list of Splash jobs.
|
|
102
|
-
* @return ContextualAPIInterface
|
|
103
114
|
*/
|
|
104
|
-
public progress(...jobs: SplashJob[]):
|
|
115
|
+
public progress(...jobs: SplashJob[]): ContextualAPIObject {
|
|
105
116
|
return NanosplashFactory.createProgressFunction(this, new SplashInstance(this, '', this.imgSrc))(...jobs)
|
|
106
117
|
}
|
|
107
118
|
|
|
108
119
|
/**
|
|
109
120
|
* # While
|
|
110
121
|
* @param {Promise<any>} asyncTask An asynchronous function or Promise.
|
|
111
|
-
* @return ContextualAPIInterface
|
|
112
122
|
*/
|
|
113
123
|
public while(asyncTask: Promise<any>): ShowInterface {
|
|
114
124
|
return NanosplashFactory.createWhileFunction(this, new SplashInstance(this, '', this.imgSrc))(asyncTask)
|
|
@@ -181,30 +191,54 @@ class Nanosplash implements NanosplashInterface {
|
|
|
181
191
|
* ns.hide();
|
|
182
192
|
* </code>
|
|
183
193
|
* <br>
|
|
184
|
-
* @param
|
|
194
|
+
* @param ref This can either be a SplashInstance ID or a CSS selector referring to the element in which
|
|
185
195
|
* the instance is residing.
|
|
186
196
|
*/
|
|
187
|
-
public hide(
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
197
|
+
public hide(ref?: Destination): void {
|
|
198
|
+
try {
|
|
199
|
+
if (ref) {
|
|
200
|
+
const isString = typeof ref === 'string'
|
|
201
|
+
const isNode = ref instanceof Node
|
|
202
|
+
const deleteInstancesWhereDestination = (destination: Destination) => {
|
|
203
|
+
Array.from(this.instances.values())
|
|
204
|
+
.filter((v: SplashInstance) => v.getDestination() === destination)
|
|
205
|
+
.forEach((v: SplashInstance) => v.delete())
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
if (isString) {
|
|
209
|
+
const splashInstance = this.instances.get(ref)
|
|
210
|
+
if (splashInstance) {
|
|
211
|
+
splashInstance.delete()
|
|
212
|
+
return
|
|
213
|
+
} else {
|
|
214
|
+
const element = get<HTMLElement>(ref)
|
|
215
|
+
if (element) {
|
|
216
|
+
deleteInstancesWhereDestination(element)
|
|
217
|
+
}
|
|
218
|
+
throw new Exception(`The CSS selector (${ref}) points to a non-existing DOM element.`)
|
|
219
|
+
}
|
|
220
|
+
} else if (isNode) {
|
|
221
|
+
deleteInstancesWhereDestination(ref)
|
|
222
|
+
} else {
|
|
223
|
+
throw new IllegalArgumentException(
|
|
224
|
+
'The ref argument must be either a string or Node',
|
|
225
|
+
ref
|
|
226
|
+
)
|
|
227
|
+
}
|
|
192
228
|
} else {
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
229
|
+
const n = this.instances.size
|
|
230
|
+
this.lifoIterate((_: string, splashInstance: SplashInstance, i: number) => {
|
|
231
|
+
const remove = i === n - 1
|
|
232
|
+
if (remove) {
|
|
233
|
+
splashInstance.delete()
|
|
234
|
+
}
|
|
235
|
+
return remove
|
|
236
|
+
})
|
|
237
|
+
}
|
|
238
|
+
} catch (e) {
|
|
239
|
+
if (this.debug) {
|
|
240
|
+
console.warn(e)
|
|
198
241
|
}
|
|
199
|
-
} else {
|
|
200
|
-
const n = this.instances.size
|
|
201
|
-
this.lifoIterate((_: string, splashInstance: SplashInstance, i: number) => {
|
|
202
|
-
const remove = i === n - 1
|
|
203
|
-
if (remove) {
|
|
204
|
-
splashInstance.delete()
|
|
205
|
-
}
|
|
206
|
-
return remove
|
|
207
|
-
})
|
|
208
242
|
}
|
|
209
243
|
}
|
|
210
244
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import {Destination} from "../types";
|
|
2
2
|
import Nanosplash from "./Nanosplash";
|
|
3
|
-
import {addClass, mk, move, setAttr} from "../
|
|
3
|
+
import {addClass, mk, move, setAttr} from "../Utilities/dom";
|
|
4
4
|
import {IdentityInterface} from "../Interfaces/IdentityInterface";
|
|
5
|
-
import {NanosplashRepository} from "../
|
|
5
|
+
import {NanosplashRepository} from "../Repositories/NanosplashRepository";
|
|
6
6
|
|
|
7
7
|
/**
|
|
8
8
|
* SplashInstance
|
|
@@ -216,27 +216,34 @@ export class SplashInstance implements IdentityInterface {
|
|
|
216
216
|
*/
|
|
217
217
|
public moveTo(destination: Destination): void
|
|
218
218
|
{
|
|
219
|
-
|
|
220
|
-
|
|
219
|
+
try {
|
|
220
|
+
// Clean up and restore previous location if any.
|
|
221
|
+
this.cleanAndRestore()
|
|
221
222
|
|
|
222
|
-
|
|
223
|
-
|
|
223
|
+
// Convert the destination into a DOM Node
|
|
224
|
+
this.destinationNode = NanosplashRepository.destinationToNode(destination)
|
|
224
225
|
|
|
225
|
-
|
|
226
|
-
|
|
226
|
+
// Replace splash instances having the same destination node
|
|
227
|
+
this.replaceSplashInstancesHavingSameDestination(this.destinationNode)
|
|
227
228
|
|
|
228
|
-
|
|
229
|
-
|
|
229
|
+
// Assess whether the destination node is the Document body or not
|
|
230
|
+
const targetIsBody = this.destinationNode === document.body
|
|
230
231
|
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
232
|
+
if (targetIsBody) {
|
|
233
|
+
this.moveWithFullscreenStrategy()
|
|
234
|
+
} else {
|
|
235
|
+
this.resetFullscreenAttributes()
|
|
236
|
+
this.moveWithRegularStrategy(this.destinationNode)
|
|
237
|
+
}
|
|
237
238
|
|
|
238
|
-
|
|
239
|
-
|
|
239
|
+
// Assemble the Nanosplash component
|
|
240
|
+
this.assembleNSComponent()
|
|
241
|
+
} catch (e) {
|
|
242
|
+
this.delete()
|
|
243
|
+
if (this.nsInstance.debug) {
|
|
244
|
+
console.warn(e)
|
|
245
|
+
}
|
|
246
|
+
}
|
|
240
247
|
}
|
|
241
248
|
|
|
242
249
|
/**
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import Exception from "./Exception";
|
|
2
|
+
import {Destination} from "../types";
|
|
3
|
+
|
|
4
|
+
class DestinationException extends Exception {
|
|
5
|
+
public destination: Destination
|
|
6
|
+
public constructor(message: string, destination: Destination, cause: Exception) {
|
|
7
|
+
super(message);
|
|
8
|
+
this.destination = destination
|
|
9
|
+
this.cause = cause
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
export default DestinationException
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import Exception from "./Exception";
|
|
2
|
+
|
|
3
|
+
class IllegalArgumentException extends Exception {
|
|
4
|
+
public argument: any
|
|
5
|
+
public constructor(message: string, argument: any) {
|
|
6
|
+
super(message);
|
|
7
|
+
this.argument = argument
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
export default IllegalArgumentException
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import Nanosplash from "../Core/Nanosplash";
|
|
2
2
|
import {SplashInstance} from "../Core/SplashInstance";
|
|
3
|
-
import {NanosplashRepository} from "../
|
|
4
|
-
import {ProgressFunction, ShowFunction, SplashJob, WhileFunction} from "../types";
|
|
3
|
+
import {NanosplashRepository} from "../Repositories/NanosplashRepository";
|
|
4
|
+
import {ContextualAPIObject, ProgressFunction, ShowFunction, SplashJob, WhileFunction} from "../types";
|
|
5
|
+
import {ShowInterface} from "../Interfaces/ShowInterface";
|
|
5
6
|
|
|
6
7
|
/**
|
|
7
8
|
* # Nanosplash Factory
|
|
@@ -38,7 +39,7 @@ export class NanosplashFactory {
|
|
|
38
39
|
*/
|
|
39
40
|
public static createShowFunction(ns: Nanosplash, splash: SplashInstance | null): ShowFunction
|
|
40
41
|
{
|
|
41
|
-
return (text: string) => {
|
|
42
|
+
return (text: string): ContextualAPIObject => {
|
|
42
43
|
splash = NanosplashFactory.ensureInstance(splash, ns, text)
|
|
43
44
|
ns.instances.set(splash.getId(), splash)
|
|
44
45
|
splash.moveTo(document.body)
|
|
@@ -76,7 +77,7 @@ export class NanosplashFactory {
|
|
|
76
77
|
*/
|
|
77
78
|
public static createWhileFunction(ns: Nanosplash, splash: SplashInstance): WhileFunction
|
|
78
79
|
{
|
|
79
|
-
return (asyncTask: Promise<any>) => {
|
|
80
|
+
return (asyncTask: Promise<any>): ShowInterface => {
|
|
80
81
|
splash = NanosplashFactory.ensureInstance(splash, ns, '')
|
|
81
82
|
return {
|
|
82
83
|
show(text: string) {
|