[docs] Bump

Author: jamesgpearce

docs/api/all.html

@@ -1 +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/" data-id="c"><h1><code>checkpoints</code></h1><p>The <code>checkpoints</code> module of the TinyBase 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"><h2>Since</h2><p>v1.0.0</p></section><section class="s2" id="/api/checkpoints/interfaces/" data-id="c/I17"><h2>Interfaces</h2><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/F7"><h2>Functions</h2><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/TA14"><h2>Type Aliases</h2><ul><li><a href="/api/checkpoints/type-aliases/listener/">Listener type aliases</a></li><li><a href="/api/checkpoints/type-aliases/callback/checkpointcallback/"><code>CheckpointCallback</code></a> type alias</li><li><a href="/api/checkpoints/type-aliases/identity/checkpointids/"><code>CheckpointIds</code></a> type alias</li><li><a href="/api/checkpoints/type-aliases/development/checkpointslistenerstats/"><code>CheckpointsListenerStats</code></a> type alias</li></ul></section></section>
+<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/" data-id="c"><h1><code>checkpoints</code></h1><p>The <code>checkpoints</code> module of the TinyBase project provides the ability to create and track checkpoints made to the data in <a href="/api/the-essentials/creating-stores/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"><h2>Since</h2><p>v1.0.0</p></section><section class="s2" id="/api/checkpoints/interfaces/" data-id="c/I17"><h2>Interfaces</h2><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/F7"><h2>Functions</h2><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/TA14"><h2>Type Aliases</h2><ul><li><a href="/api/checkpoints/type-aliases/listener/">Listener type aliases</a></li><li><a href="/api/checkpoints/type-aliases/callback/checkpointcallback/"><code>CheckpointCallback</code></a> type alias</li><li><a href="/api/checkpoints/type-aliases/identity/checkpointids/"><code>CheckpointIds</code></a> type alias</li><li><a href="/api/checkpoints/type-aliases/development/checkpointslistenerstats/"><code>CheckpointsListenerStats</code></a> type alias</li></ul></section></section>

docs/api/article.html

@@ -1 +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/F7/C26"><h1>Creation functions</h1><section class="s2" id="/api/checkpoints/functions/creation/createcheckpoints/" data-id="cC"><h2><code>createCheckpoints</code></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. <a href="/api/checkpoints/functions/creation/createcheckpoints/">Read more</a>.</p></section></section>
+<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/F7/C27"><h1>Creation functions</h1><section class="s2" id="/api/checkpoints/functions/creation/createcheckpoints/" data-id="cC"><h2><code>createCheckpoints</code></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. <a href="/api/checkpoints/functions/creation/createcheckpoints/">Read more</a>.</p></section></section>

docs/api/checkpoints/article.html

@@ -1,10 +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><li><a href="/api/checkpoints/functions/creation/createcheckpoints/"><code>createCheckpoints</code></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></p><p>A reference to the new <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object.</p><p></p></td></tr></table></div><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">import</span> <span class="punctuation">{</span>createCheckpoints<span class="punctuation">,</span> createStore<span class="punctuation">}</span> <span class="keyword">from</span> <span class="string">'tinybase'</span><span class="punctuation">;</span>
+<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><li><a href="/api/checkpoints/functions/creation/createcheckpoints/"><code>createCheckpoints</code></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/the-essentials/creating-stores/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/the-essentials/creating-stores/store/">Store</a></span></code></td><td><p>The <a href="/api/the-essentials/creating-stores/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></p><p>A reference to the new <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object.</p><p></p></td></tr></table></div><p>A given <a href="/api/the-essentials/creating-stores/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/the-essentials/creating-stores/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">import</span> <span class="punctuation">{</span>createCheckpoints<span class="punctuation">,</span> createStore<span class="punctuation">}</span> <span class="keyword">from</span> <span class="string">'tinybase'</span><span class="punctuation">;</span>
 
 <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">import</span> <span class="punctuation">{</span>createCheckpoints<span class="punctuation">,</span> createStore<span class="punctuation">}</span> <span class="keyword">from</span> <span class="string">'tinybase'</span><span class="punctuation">;</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/the-essentials/creating-stores/store/"><code>Store</code></a> to return the same object.</p><pre><code><span class="keyword">import</span> <span class="punctuation">{</span>createCheckpoints<span class="punctuation">,</span> createStore<span class="punctuation">}</span> <span class="keyword">from</span> <span class="string">'tinybase'</span><span class="punctuation">;</span>
 
 <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>