add prose links

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><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/development/">Development methods</a></li></ul></nav><section class="s1" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/development/" data-id="C21/M10/D16"><h1>Development methods</h1><p>This is the collection of development methods within the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> interface. There is only one method, <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/development/getlistenerstats/"><code>getListenerStats</code></a>.</p><section class="s2" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/development/getlistenerstats/" data-id="gLS6"><h2><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/development/getlistenerstats/"><code>getListenerStats</code></a></h2><p>The getListenerStats method provides a set of statistics about the listeners registered with the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object, and is used for debugging purposes.</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/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/development/">Development methods</a></li></ul></nav><section class="s1" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/development/" data-id="C21/M10/D16"><h1>Development methods</h1><p>This is the collection of development methods within the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> interface. There is only one method, <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/development/getlistenerstats/"><code>getListenerStats</code></a>.</p><section class="s2" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/development/getlistenerstats/" data-id="gLS6"><h2><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/development/getlistenerstats/"><code>getListenerStats</code></a></h2><p>The <code>getListenerStats</code> method provides a set of statistics about the listeners registered with the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object, and is used for debugging purposes.</p></section></section>

docs/api/checkpoints/interfaces/checkpoints/checkpoints/methods/development/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/development/">Development methods</a></li><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/development/getlistenerstats/"><code>getListenerStats</code></a></li></ul></nav><section class="s1" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/development/getlistenerstats/" data-id="gLS6"><h1><code>getListenerStats</code></h1><p>The getListenerStats method provides a set of statistics about the listeners registered with the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object, and is used for debugging purposes.</p><pre><code><span class="function">getListenerStats</span><span class="punctuation">(</span><span class="punctuation">)</span><span class="operator">:</span> <span class="type"><a href="/api/checkpoints/type-aliases/development/checkpointslistenerstats/">CheckpointsListenerStats</a></span></code></pre><div class="table"><table><tr><th class="right">returns</th><td><code><span class="type"><a href="/api/checkpoints/type-aliases/development/checkpointslistenerstats/">CheckpointsListenerStats</a></span></code></td><td><p></p><p>A <a href="/api/checkpoints/type-aliases/development/checkpointslistenerstats/"><code>CheckpointsListenerStats</code></a> object containing <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> listener statistics.</p><p></p></td></tr></table></div><p>The <a href="/api/checkpoints/type-aliases/development/checkpointslistenerstats/"><code>CheckpointsListenerStats</code></a> object contains a breakdown of the different types of listener.</p><p>The statistics are only populated in a debug build: production builds return an empty object. The method is intended to be used during development to ensure your application is not leaking listener registrations, for example.</p><section class="s2"><h2>Example</h2><p>This example gets the listener statistics of 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/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/development/">Development methods</a></li><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/development/getlistenerstats/"><code>getListenerStats</code></a></li></ul></nav><section class="s1" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/development/getlistenerstats/" data-id="gLS6"><h1><code>getListenerStats</code></h1><p>The <code>getListenerStats</code> method provides a set of statistics about the listeners registered with the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object, and is used for debugging purposes.</p><pre><code><span class="function">getListenerStats</span><span class="punctuation">(</span><span class="punctuation">)</span><span class="operator">:</span> <span class="type"><a href="/api/checkpoints/type-aliases/development/checkpointslistenerstats/">CheckpointsListenerStats</a></span></code></pre><div class="table"><table><tr><th class="right">returns</th><td><code><span class="type"><a href="/api/checkpoints/type-aliases/development/checkpointslistenerstats/">CheckpointsListenerStats</a></span></code></td><td><p></p><p>A <a href="/api/checkpoints/type-aliases/development/checkpointslistenerstats/"><code>CheckpointsListenerStats</code></a> object containing <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> listener statistics.</p><p></p></td></tr></table></div><p>The <a href="/api/checkpoints/type-aliases/development/checkpointslistenerstats/"><code>CheckpointsListenerStats</code></a> object contains a breakdown of the different types of listener.</p><p>The statistics are only populated in a debug build: production builds return an empty object. The method is intended to be used during development to ensure your application is not leaking listener registrations, for example.</p><section class="s2"><h2>Example</h2><p>This example gets the listener statistics of 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>
 checkpoints<span class="punctuation">.</span><span class="function"><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/listener/addcheckpointidslistener/">addCheckpointIdsListener</a></span><span class="punctuation">(</span><span class="punctuation">(</span><span class="punctuation">)</span> <span class="operator">=></span> <span class="punctuation">{</span>
   console<span class="punctuation">.</span><span class="function">log</span><span class="punctuation">(</span><span class="string">'Checkpoint Ids changed'</span><span class="punctuation">)</span><span class="punctuation">;</span>

docs/api/checkpoints/interfaces/checkpoints/checkpoints/methods/development/getlistenerstats/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/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></ul></nav><section class="s1" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/" data-id="C21/M10/G8"><h1>Getter methods</h1><p>This is the collection of getter methods within the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> interface. There are 4 getter methods in total.</p><section class="s2" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getstore/" data-id="gS5"><h2><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getstore/"><code>getStore</code></a></h2><p>The getStore method returns a reference to the underlying <a href="/api/store/interfaces/store/store/"><code>Store</code></a> that is backing this <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object.</p></section><section class="s2" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpoint/" data-id="gC3"><h2><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpoint/"><code>getCheckpoint</code></a></h2><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></section><section class="s2" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpointids/" data-id="gCI2"><h2><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpointids/"><code>getCheckpointIds</code></a></h2><p>The <code>getCheckpointIds</code> method returns an array of the checkpoint <a href="/api/common/type-aliases/identity/ids/"><code>Ids</code></a> being managed by this <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object.</p></section><section class="s2" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/hascheckpoint/" data-id="hC2"><h2><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/hascheckpoint/"><code>hasCheckpoint</code></a></h2><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></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/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></ul></nav><section class="s1" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/" data-id="C21/M10/G8"><h1>Getter methods</h1><p>This is the collection of getter methods within the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> interface. There are 4 getter methods in total.</p><section class="s2" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getstore/" data-id="gS5"><h2><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getstore/"><code>getStore</code></a></h2><p>The <code>getStore</code> method returns a reference to the underlying <a href="/api/store/interfaces/store/store/"><code>Store</code></a> that is backing this <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object.</p></section><section class="s2" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpoint/" data-id="gC3"><h2><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpoint/"><code>getCheckpoint</code></a></h2><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></section><section class="s2" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpointids/" data-id="gCI2"><h2><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/getcheckpointids/"><code>getCheckpointIds</code></a></h2><p>The <code>getCheckpointIds</code> method returns an array of the checkpoint <a href="/api/common/type-aliases/identity/ids/"><code>Ids</code></a> being managed by this <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object.</p></section><section class="s2" id="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/hascheckpoint/" data-id="hC2"><h2><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/getter/hascheckpoint/"><code>hasCheckpoint</code></a></h2><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></section></section>