Docs

Author: jamesgpearce

coverage.json

@@ -1 +1 @@
-{"tests":1372,"assertions":6851,"lines":{"total":929,"covered":929,"skipped":0,"pct":100},"statements":{"total":1013,"covered":1013,"skipped":0,"pct":100},"functions":{"total":365,"covered":365,"skipped":0,"pct":100},"branches":{"total":335,"covered":334,"skipped":0,"pct":99.7},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":"Unknown"}}
+{"tests":1712,"assertions":7959,"lines":{"total":933,"covered":933,"skipped":0,"pct":100},"statements":{"total":1018,"covered":1018,"skipped":0,"pct":100},"functions":{"total":366,"covered":366,"skipped":0,"pct":100},"branches":{"total":341,"covered":341,"skipped":0,"pct":100},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":"Unknown"}}

cspell.json

@@ -18,6 +18,7 @@
     "granularities",
     "gulpfile",
     "gzipped",
+    "hypot",
     "jamesgpearce",
     "Lato",
     "lcov",

docs/.nojekyll

@@ -0,0 +1 @@
+tinybase.org

docs/CNAME

@@ -0,0 +1 @@
+<nav><ul><li><a href="/">TinyBase</a></li></ul></nav><section class="s1" id="/api" data-id="api"><h1>API</h1><section class="s2" id="/api/store" data-id="s"><h2><a href="/api/store"><code>store</code></a></h2><p>The <code>store</code> module is the core of the <a href="/">TinyBase</a> project and contains the types, interfaces, and functions to work with <a href="/api/store/interfaces/store/store"><code>Store</code></a> objects.</p><ul><li><a href="/api/store/interfaces">Interfaces</a></li><li><a href="/api/store/functions">Functions</a></li><li><a href="/api/store/type-aliases">Type aliases</a></li></ul></section><section class="s2" id="/api/metrics" data-id="m"><h2><a href="/api/metrics"><code>metrics</code></a></h2><p>The <code>metrics</code> module of the <a href="/">TinyBase</a> project provides the ability to create and track metrics and aggregates of the data in <a href="/api/store/interfaces/store/store"><code>Store</code></a> objects.</p><ul><li><a href="/api/metrics/interfaces">Interfaces</a></li><li><a href="/api/metrics/functions">Functions</a></li><li><a href="/api/metrics/type-aliases">Type aliases</a></li></ul></section><section class="s2" id="/api/indexes" data-id="i"><h2><a href="/api/indexes"><code>indexes</code></a></h2><p>The <code>indexes</code> module of the <a href="/">TinyBase</a> project provides the ability to create and track indexes of the data in <a href="/api/store/interfaces/store/store"><code>Store</code></a> objects.</p><ul><li><a href="/api/indexes/interfaces">Interfaces</a></li><li><a href="/api/indexes/functions">Functions</a></li><li><a href="/api/indexes/type-aliases">Type aliases</a></li></ul></section><section class="s2" id="/api/relationships" data-id="r"><h2><a href="/api/relationships"><code>relationships</code></a></h2><p>The <code>relationships</code> module of the <a href="/">TinyBase</a> project provides the ability to create and track relationships between the data in <a href="/api/store/interfaces/store/store"><code>Store</code></a> objects.</p><ul><li><a href="/api/relationships/interfaces">Interfaces</a></li><li><a href="/api/relationships/functions">Functions</a></li><li><a href="/api/relationships/type-aliases">Type aliases</a></li></ul></section><section class="s2" id="/api/checkpoints" data-id="c"><h2><a href="/api/checkpoints"><code>checkpoints</code></a></h2><p>The <code>checkpoints</code> module of the <a href="/">TinyBase</a> project provides the ability to create and track checkpoints made to the data in <a href="/api/store/interfaces/store/store"><code>Store</code></a> objects.</p><ul><li><a href="/api/checkpoints/interfaces">Interfaces</a></li><li><a href="/api/checkpoints/functions">Functions</a></li><li><a href="/api/checkpoints/type-aliases">Type aliases</a></li></ul></section><section class="s2" id="/api/persisters" data-id="p"><h2><a href="/api/persisters"><code>persisters</code></a></h2><p>The <code>persisters</code> module of the <a href="/">TinyBase</a> project provides a simple framework for saving and loading <a href="/api/store/interfaces/store/store"><code>Store</code></a> data, to and from different destinations, or underlying storage types.</p><ul><li><a href="/api/persisters/interfaces">Interfaces</a></li><li><a href="/api/persisters/functions">Functions</a></li><li><a href="/api/persisters/type-aliases">Type aliases</a></li></ul></section><section class="s2" id="/api/ui-react" data-id="u"><h2><a href="/api/ui-react"><code>ui-react</code></a></h2><p>The <code>ui-react</code> module of the <a href="/">TinyBase</a> project provides both hooks and components to make it easy to create reactive apps with <a href="/api/store/interfaces/store/store"><code>Store</code></a> objects.</p><ul><li><a href="/api/ui-react/functions">Functions</a></li><li><a href="/api/ui-react/type-aliases">Type aliases</a></li></ul></section><section class="s2" id="/api/common" data-id="c3"><h2><a href="/api/common"><code>common</code></a></h2><p>The <code>common</code> module of the <a href="/">TinyBase</a> project provides a small collection of common types used across other modules.</p><ul><li><a href="/api/common/functions">Functions</a></li><li><a href="/api/common/type-aliases">Type aliases</a></li></ul></section></section>

docs/api/all.html

@@ -0,0 +1 @@
+<nav><ul><li><a href="/">TinyBase</a></li><li><a href="/api">API</a></li></ul></nav><section class="s1" id="/api/checkpoints" data-id="c"><h1><code>checkpoints</code></h1><p>The <code>checkpoints</code> module of the <a href="/">TinyBase</a> project provides the ability to create and track checkpoints made to the data in <a href="/api/store/interfaces/store/store"><code>Store</code></a> objects.</p><p>The main entry point to this module is the <a href="/api/checkpoints/functions/creation/createcheckpoints"><code>createCheckpoints</code></a> function, which returns a new <a href="/api/checkpoints/interfaces/checkpoints/checkpoints"><code>Checkpoints</code></a> object. From there, you can create new checkpoints, go forwards or backwards to others, and register listeners for when the list of checkpoints change.</p><section class="s2" id="/api/checkpoints/interfaces" data-id="c/0"><h2><a href="/api/checkpoints/interfaces">Interfaces</a></h2><p>There is one interface, <a href="/api/checkpoints/interfaces/checkpoints/checkpoints"><code>Checkpoints</code></a>, within the <a href="/api/checkpoints"><code>checkpoints</code></a> module.</p><ul><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints"><code>Checkpoints</code></a></li></ul></section><section class="s2" id="/api/checkpoints/functions" data-id="c/1"><h2><a href="/api/checkpoints/functions">Functions</a></h2><p>There is one function, <a href="/api/checkpoints/functions/creation/createcheckpoints"><code>createCheckpoints</code></a>, within the <a href="/api/checkpoints"><code>checkpoints</code></a> module.</p><ul><li><a href="/api/checkpoints/functions/creation/createcheckpoints"><code>createCheckpoints</code></a></li></ul></section><section class="s2" id="/api/checkpoints/type-aliases" data-id="c/2"><h2><a href="/api/checkpoints/type-aliases">Type aliases</a></h2><p>These are the type aliases within the <a href="/api/checkpoints"><code>checkpoints</code></a> module.</p><ul><li><a href="/api/checkpoints/type-aliases/listener">Listener type aliases</a></li><li><a href="/api/checkpoints/type-aliases/identity">Identity type aliases</a></li><li><a href="/api/checkpoints/type-aliases/development">Development type aliases</a></li></ul></section></section>

docs/api/article.html

@@ -0,0 +1 @@
+<nav><ul><li><a href="/">TinyBase</a></li><li><a href="/api">API</a></li><li><a href="/api/checkpoints"><code>checkpoints</code></a></li></ul></nav><section class="s1" id="/api/checkpoints/functions" data-id="c/1"><h1>Functions</h1><p>There is one function, <a href="/api/checkpoints/functions/creation/createcheckpoints"><code>createCheckpoints</code></a>, within the <a href="/api/checkpoints"><code>checkpoints</code></a> module.</p><section class="s2" id="/api/checkpoints/functions/creation/createcheckpoints" data-id="cC"><h2><a href="/api/checkpoints/functions/creation/createcheckpoints"><code>createCheckpoints</code></a></h2><p>The <code>createCheckpoints</code> function creates a <a href="/api/checkpoints/interfaces/checkpoints/checkpoints"><code>Checkpoints</code></a> object, and is the main entry point into the <a href="/api/checkpoints"><code>checkpoints</code></a> module.</p></section></section>

docs/api/checkpoints/article.html

@@ -0,0 +1 @@
+<nav><ul><li><a href="/">TinyBase</a></li><li><a href="/api">API</a></li><li><a href="/api/checkpoints"><code>checkpoints</code></a></li><li><a href="/api/checkpoints/functions">Functions</a></li></ul></nav><section class="s1" id="/api/checkpoints/functions/creation" data-id="c/1/0"><h1>Creation functions</h1><p>This is the collection of creation functions within the <a href="/api/checkpoints"><code>checkpoints</code></a> module. There is only one function, <a href="/api/checkpoints/functions/creation/createcheckpoints"><code>createCheckpoints</code></a>.</p><section class="s2" id="/api/checkpoints/functions/creation/createcheckpoints" data-id="cC"><h2><a href="/api/checkpoints/functions/creation/createcheckpoints"><code>createCheckpoints</code></a></h2><p>The <code>createCheckpoints</code> function creates a <a href="/api/checkpoints/interfaces/checkpoints/checkpoints"><code>Checkpoints</code></a> object, and is the main entry point into the <a href="/api/checkpoints"><code>checkpoints</code></a> module.</p></section></section>

docs/api/checkpoints/functions/article.html

@@ -0,0 +1,10 @@
+<nav><ul><li><a href="/">TinyBase</a></li><li><a href="/api">API</a></li><li><a href="/api/checkpoints"><code>checkpoints</code></a></li><li><a href="/api/checkpoints/functions">Functions</a></li></ul></nav><section class="s1" id="/api/checkpoints/functions/creation/createcheckpoints" data-id="cC"><h1><code>createCheckpoints</code></h1><p>The <code>createCheckpoints</code> function creates a <a href="/api/checkpoints/interfaces/checkpoints/checkpoints"><code>Checkpoints</code></a> object, and is the main entry point into the <a href="/api/checkpoints"><code>checkpoints</code></a> module.</p><pre><code><span class="function"><a href="/api/checkpoints/functions/creation/createcheckpoints">createCheckpoints</a></span><span class="punctuation">(</span>store<span class="operator">:</span> <span class="type"><a href="/api/store/interfaces/store/store">Store</a></span><span class="punctuation">)</span><span class="operator">:</span> <span class="type"><a href="/api/checkpoints/interfaces/checkpoints/checkpoints">Checkpoints</a></span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code>store</code></th><td><code><span class="type"><a href="/api/store/interfaces/store/store">Store</a></span></code></td><td><p>The <a href="/api/store/interfaces/store/store"><code>Store</code></a> for which to set <a href="/api/checkpoints/interfaces/checkpoints/checkpoints"><code>Checkpoints</code></a>.</p></td></tr><tr><th class="right">returns</th><td><code><span class="type"><a href="/api/checkpoints/interfaces/checkpoints/checkpoints">Checkpoints</a></span></code></td><td><p>A reference to the new Checkpoints object.</p></td></tr></table></div><p>It is trivially simple.</p><p>A given <a href="/api/store/interfaces/store/store"><code>Store</code></a> can only have one <a href="/api/checkpoints/interfaces/checkpoints/checkpoints"><code>Checkpoints</code></a> object associated with it. If you call this function twice on the same <a href="/api/store/interfaces/store/store"><code>Store</code></a>, your second call will return a reference to the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints"><code>Checkpoints</code></a> object created by the first.</p><section class="s2"><h2>Examples</h2><p>This example creates a <a href="/api/checkpoints/interfaces/checkpoints/checkpoints"><code>Checkpoints</code></a> object.</p><pre><code><span class="keyword">const</span> store <span class="operator">=</span> <span class="function"><a href="/api/store/functions/creation/createstore">createStore</a></span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">;</span>
+<span class="keyword">const</span> checkpoints <span class="operator">=</span> <span class="function"><a href="/api/checkpoints/functions/creation/createcheckpoints">createCheckpoints</a></span><span class="punctuation">(</span>store<span class="punctuation">)</span><span class="punctuation">;</span>
+console<span class="punctuation">.</span><span class="function">log</span><span class="punctuation">(</span>checkpoints<span class="punctuation">.</span><span class="function"><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpointids">getCheckpointIds</a></span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">)</span><span class="punctuation">;</span>
+<span class="comment">// -> [[], '0', []]</span>
+</code></pre><p>This example creates a <a href="/api/checkpoints/interfaces/checkpoints/checkpoints"><code>Checkpoints</code></a> object, and calls the method a second time for the same <a href="/api/store/interfaces/store/store"><code>Store</code></a> to return the same object.</p><pre><code><span class="keyword">const</span> store <span class="operator">=</span> <span class="function"><a href="/api/store/functions/creation/createstore">createStore</a></span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">;</span>
+<span class="keyword">const</span> checkpoints1 <span class="operator">=</span> <span class="function"><a href="/api/checkpoints/functions/creation/createcheckpoints">createCheckpoints</a></span><span class="punctuation">(</span>store<span class="punctuation">)</span><span class="punctuation">;</span>
+<span class="keyword">const</span> checkpoints2 <span class="operator">=</span> <span class="function"><a href="/api/checkpoints/functions/creation/createcheckpoints">createCheckpoints</a></span><span class="punctuation">(</span>store<span class="punctuation">)</span><span class="punctuation">;</span>
+console<span class="punctuation">.</span><span class="function">log</span><span class="punctuation">(</span>checkpoints1 <span class="operator">===</span> checkpoints2<span class="punctuation">)</span><span class="punctuation">;</span>
+<span class="comment">// -> true</span>
+</code></pre></section></section>