[docs] Fix parameter issues

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/interfaces/">Interfaces</a></li><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a></li><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/">Getter methods</a></li><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpoint/"><code>getCheckpoint</code></a></li></ul></nav><section class="s1" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpoint/" data-id="gC3"><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="type"><a href="/api/common/type-aliases/identity/id/">Id</a></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="type"><a href="/api/common/type-aliases/identity/id/">Id</a></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/store/interfaces/store/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">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="function"><a href="/api/store/interfaces/store/store/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>
+<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/interfaces/">Interfaces</a></li><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a></li><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/">Getter methods</a></li><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpoint/"><code>getCheckpoint</code></a></li></ul></nav><section class="s1" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpoint/" data-id="gC3"><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/store/interfaces/store/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">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="function"><a href="/api/store/interfaces/store/store/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>
 
 <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>
 store<span class="punctuation">.</span><span class="function"><a href="/api/store/interfaces/store/store/methods/setter/setcell/">setCell</a></span><span class="punctuation">(</span><span class="string">'pets'</span><span class="punctuation">,</span> <span class="string">'fido'</span><span class="punctuation">,</span> <span class="string">'sold'</span><span class="punctuation">,</span> <span class="boolean">true</span><span class="punctuation">)</span><span class="punctuation">;</span>

docs/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpoint/article.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/interfaces/">Interfaces</a></li><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a></li><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/">Getter methods</a></li><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/hascheckpoint/"><code>hasCheckpoint</code></a></li></ul></nav><section class="s1" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/hascheckpoint/" data-id="hC2"><h1><code>hasCheckpoint</code></h1><p>The <code>hasCheckpoint</code> method returns a boolean indicating whether a given Checkpoint exists in the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object.</p><pre><code><span class="function"><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/hascheckpoint/">hasCheckpoint</a></span><span class="punctuation">(</span>checkpointId<span class="operator">:</span> <span class="type"><a href="/api/common/type-aliases/identity/id/">Id</a></span><span class="punctuation">)</span><span class="operator">:</span> <span class="builtin">boolean</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="type"><a href="/api/common/type-aliases/identity/id/">Id</a></span></code></td><td><p>The <a href="/api/common/type-aliases/identity/id/"><code>Id</code></a> of a possible Checkpoint in the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object.</p></td></tr><tr><th class="right">returns</th><td><code><span class="builtin">boolean</span></code></td><td><p></p><p>Whether a Checkpoint with that <a href="/api/common/type-aliases/identity/id/"><code>Id</code></a> exists.</p><p></p></td></tr></table></div><section class="s2"><h2>Example</h2><p>This example shows two simple Checkpoint existence checks.</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="function"><a href="/api/store/interfaces/store/store/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>
+<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/interfaces/">Interfaces</a></li><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a></li><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/">Getter methods</a></li><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/hascheckpoint/"><code>hasCheckpoint</code></a></li></ul></nav><section class="s1" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/hascheckpoint/" data-id="hC2"><h1><code>hasCheckpoint</code></h1><p>The <code>hasCheckpoint</code> method returns a boolean indicating whether a given Checkpoint exists in the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object.</p><pre><code><span class="function"><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/hascheckpoint/">hasCheckpoint</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">boolean</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 a possible Checkpoint in the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object.</p></td></tr><tr><th class="right">returns</th><td><code><span class="builtin">boolean</span></code></td><td><p></p><p>Whether a Checkpoint with that <a href="/api/common/type-aliases/identity/id/"><code>Id</code></a> exists.</p><p></p></td></tr></table></div><section class="s2"><h2>Example</h2><p>This example shows two simple Checkpoint existence checks.</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="function"><a href="/api/store/interfaces/store/store/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>
 <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/hascheckpoint/">hasCheckpoint</a></span><span class="punctuation">(</span><span class="string">'0'</span><span class="punctuation">)</span><span class="punctuation">)</span><span class="punctuation">;</span>
 <span class="comment">// -> true</span>