Skip to content

Commit ae06174

Browse files
committed
[docs] Bump again
1 parent e3dbbea commit ae06174

567 files changed

Lines changed: 1715 additions & 1826 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/api/all.html‎

Lines changed: 534 additions & 534 deletions
Large diffs are not rendered by default.

‎docs/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpoint/article.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<nav><ul><li><a href="/" aria-current="true">TinyBase</a></li><li><a href="/api/" aria-current="true">API</a></li><li><a href="/api/checkpoints/" aria-current="true"><code>checkpoints</code></a></li><li><a href="/api/checkpoints/interfaces/" aria-current="true">Interfaces</a></li><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/" aria-current="true"><code>Checkpoints</code></a></li><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/" aria-current="true">Getter methods</a></li><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpoint/" aria-current="page"><code>getCheckpoint</code></a></li></ul></nav><section class="s1" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpoint/" data-id="gC"><h1><code>getCheckpoint</code></h1><p>The <code>getCheckpoint</code> method fetches the label for a checkpoint, if it had been provided at the time of the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/setter/addcheckpoint/"><code>addCheckpoint</code></a> method or set subsequently with the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/setter/setcheckpoint/"><code>setCheckpoint</code></a> method.</p><pre><code><span class="function"><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpoint/">getCheckpoint</a></span><span class="punctuation">(</span>checkpointId<span class="operator">:</span> <span class="builtin">string</span><span class="punctuation">)</span><span class="operator">:</span> <span class="keyword">undefined</span> <span class="operator">|</span> <span class="builtin">string</span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code>checkpointId</code></th><td><code><span class="builtin">string</span></code></td><td><p>The <a href="/api/common/type-aliases/identity/id/"><code>Id</code></a> of the checkpoint to get the label for.</p></td></tr><tr><th class="right">returns</th><td><code><span class="keyword">undefined</span> <span class="operator">|</span> <span class="builtin">string</span></code></td><td><p></p><p>A string label for the requested checkpoint, an empty string if it was never set, or <code>undefined</code> if the checkpoint does not exist.</p><p></p></td></tr></table></div><p>If the checkpoint has had no label provided, this method will return an empty string.</p><section class="s2"><h2>Examples</h2><p>This example creates a <a href="/api/the-essentials/creating-stores/store/"><code>Store</code></a>, adds a <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object, and sets a checkpoint with a label, before retrieving it again.</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>
1+
<nav><ul><li><a href="/" aria-current="true">TinyBase</a></li><li><a href="/api/" aria-current="true">API</a></li><li><a href="/api/checkpoints/" aria-current="true"><code>checkpoints</code></a></li><li><a href="/api/checkpoints/interfaces/" aria-current="true">Interfaces</a></li><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/" aria-current="true"><code>Checkpoints</code></a></li><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/" aria-current="true">Getter methods</a></li><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpoint/" aria-current="page"><code>getCheckpoint</code></a></li></ul></nav><section class="s1" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpoint/" data-id="gC"><h1><code>getCheckpoint</code></h1><p>The <code>getCheckpoint</code> method fetches the label for a checkpoint, if it had been provided at the time of the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/setter/addcheckpoint/"><code>addCheckpoint</code></a> method or set subsequently with the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/setter/setcheckpoint/"><code>setCheckpoint</code></a> method.</p><pre><code><span class="function"><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpoint/">getCheckpoint</a></span><span class="punctuation">(</span>checkpointId<span class="operator">:</span> <span class="builtin">string</span><span class="punctuation">)</span><span class="operator">:</span> <span class="builtin">string</span> <span class="operator">|</span> <span class="keyword">undefined</span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code>checkpointId</code></th><td><code><span class="builtin">string</span></code></td><td><p>The <a href="/api/common/type-aliases/identity/id/"><code>Id</code></a> of the checkpoint to get the label for.</p></td></tr><tr><th class="right">returns</th><td><code><span class="builtin">string</span> <span class="operator">|</span> <span class="keyword">undefined</span></code></td><td><p></p><p>A string label for the requested checkpoint, an empty string if it was never set, or <code>undefined</code> if the checkpoint does not exist.</p><p></p></td></tr></table></div><p>If the checkpoint has had no label provided, this method will return an empty string.</p><section class="s2"><h2>Examples</h2><p>This example creates a <a href="/api/the-essentials/creating-stores/store/"><code>Store</code></a>, adds a <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object, and sets a checkpoint with a label, before retrieving it again.</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>
22

33
<span class="keyword">const</span> store <span class="operator">=</span> <span class="function"><a href="/api/the-essentials/creating-stores/createstore/">createStore</a></span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">.</span><span class="function"><a href="/api/mergeable-store/interfaces/mergeable/mergeablestore/methods/setter/settables/">setTables</a></span><span class="punctuation">(</span><span class="punctuation">{</span><span class="literal-property">pets</span><span class="operator">:</span> <span class="punctuation">{</span><span class="literal-property">fido</span><span class="operator">:</span> <span class="punctuation">{</span><span class="literal-property">sold</span><span class="operator">:</span> <span class="boolean">false</span><span class="punctuation">}</span><span class="punctuation">}</span><span class="punctuation">}</span><span class="punctuation">)</span><span class="punctuation">;</span>
44

0 commit comments

Comments
 (0)