v3.0.4

Author: jamesgpearce

docs/api/all.html

@@ -1,4 +1,4 @@
-<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>A reference to the new Checkpoints object.</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">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>
+<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">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>