v2.1.1

Author: jamesgpearce

coverage.json

@@ -1 +1 @@
-{"tests":2134,"assertions":11009,"lines":{"total":1246,"covered":1246,"skipped":0,"pct":100},"statements":{"total":1347,"covered":1347,"skipped":0,"pct":100},"functions":{"total":507,"covered":507,"skipped":0,"pct":100},"branches":{"total":469,"covered":469,"skipped":0,"pct":100},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":"Unknown"}}
+{"tests":2134,"assertions":11009,"lines":{"total":1247,"covered":1247,"skipped":0,"pct":100},"statements":{"total":1348,"covered":1348,"skipped":0,"pct":100},"functions":{"total":507,"covered":507,"skipped":0,"pct":100},"branches":{"total":469,"covered":469,"skipped":0,"pct":100},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":"Unknown"}}

docs/api/all.html

@@ -9690,4 +9690,4 @@
 <span class="comment">// -> ['c', 'f']</span>
 console<span class="punctuation">.</span><span class="function">log</span><span class="punctuation">(</span>indexes<span class="punctuation">.</span><span class="function"><a href="#/api/indexes/interfaces/indexes/indexes/methods/getter/getslicerowids">getSliceRowIds</a></span><span class="punctuation">(</span><span class="string">'byFirst'</span><span class="punctuation">,</span> <span class="string">'f'</span><span class="punctuation">)</span><span class="punctuation">)</span><span class="punctuation">;</span>
 <span class="comment">// -> ['felix', 'fido']</span>
-</code></pre></section></section></section><section class="s3" id="/api/common/type-aliases" data-id="c3/TA15"><h3>Type Aliases</h3><p>These are the type aliases within the <a href="#/api/common"><code>common</code></a> module.</p><section class="s4" id="/api/common/type-aliases/callback" data-id="c3/TA15/C32"><h4>Callback type aliases</h4><p>This is the collection of callback type aliases within the <a href="#/api/common"><code>common</code></a> module. There are only two callback type aliases, <a href="#/api/common/type-aliases/callback/callback"><code>Callback</code></a> and <a href="#/api/common/type-aliases/callback/parameterizedcallback"><code>ParameterizedCallback</code></a>.</p><section class="s5" id="/api/common/type-aliases/callback/callback" data-id="C33"><h5><code>Callback</code></h5><p>The <code>Callback</code> type represents a function that is used as a callback and which does not take a parameter.</p><pre><code><span class="punctuation">(</span><span class="punctuation">)</span><span class="operator">:</span> <span class="keyword">void</span></code></pre></section><section class="s5" id="/api/common/type-aliases/callback/parameterizedcallback" data-id="PC"><h5><code>ParameterizedCallback</code></h5><p>The <code>ParameterizedCallback</code> type represents a generic function that will take an optional parameter - such as the handler of a DOM event.</p><pre><code><span class="punctuation">(</span>parameter<span class="operator">?</span><span class="operator">:</span> Parameter<span class="punctuation">)</span><span class="operator">:</span> <span class="keyword">void</span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code>parameter<span class="operator">?</span></code></th><td><code>Parameter</code></td><td></td></tr><tr><th class="right">returns</th><td><code><span class="keyword">void</span></code></td><td><p>This has no return value.</p></td></tr></table></div></section></section><section class="s4" id="/api/common/type-aliases/general" data-id="c3/TA15/G10"><h4>General type aliases</h4><p>This is the collection of general type aliases within the <a href="#/api/common"><code>common</code></a> module. There is only one type alias, <a href="#/api/common/type-aliases/general/json"><code>Json</code></a>.</p><section class="s5" id="/api/common/type-aliases/general/json" data-id="J2"><h5><code>Json</code></h5><p>The <code>Json</code> type is a simple alias for a string, but is used to indicate that the string should be considered to be a JSON serialization of an object.</p><pre><code><span class="builtin">string</span></code></pre></section></section><section class="s4" id="/api/common/type-aliases/identity" data-id="c3/TA15/I21"><h4>Identity type aliases</h4><p>This is the collection of identity type aliases within the <a href="#/api/common"><code>common</code></a> module. There are only three identity type aliases, <a href="#/api/common/type-aliases/identity/id"><code>Id</code></a>, <a href="#/api/common/type-aliases/identity/idornull"><code>IdOrNull</code></a>, and <a href="#/api/common/type-aliases/identity/ids"><code>Ids</code></a>.</p><section class="s5" id="/api/common/type-aliases/identity/id" data-id="I22"><h5><code>Id</code></h5><p>The <code>Id</code> type is a simple alias for a string, but is used to indicate that the string should be considered to be the key of an object (such as a <a href="#/api/store/type-aliases/store/row"><code>Row</code></a> <code>Id</code> string used in a <a href="#/api/store/type-aliases/store/table"><code>Table</code></a>).</p><pre><code><span class="builtin">string</span></code></pre></section><section class="s5" id="/api/common/type-aliases/identity/idornull" data-id="ION"><h5><code>IdOrNull</code></h5><p>The <a href="#/api/common/type-aliases/identity/id"><code>Id</code></a> type is a simple alias for the union of a string or <code>null</code> value, where the string should be considered to be the key of an objects (such as a <a href="#/api/store/type-aliases/store/row"><code>Row</code></a> <a href="#/api/common/type-aliases/identity/id"><code>Id</code></a> string used in a <a href="#/api/store/type-aliases/store/table"><code>Table</code></a>), and typically <code>null</code> indicates a wildcard - such as when used in the <a href="#/api/store/interfaces/store/store"><code>Store</code></a> <a href="#/api/store/interfaces/store/store/methods/listener/addrowlistener"><code>addRowListener</code></a> method.</p><pre><code><span class="type"><a href="#/api/common/type-aliases/identity/id">Id</a></span> <span class="operator">|</span> <span class="keyword">null</span></code></pre></section><section class="s5" id="/api/common/type-aliases/identity/ids" data-id="I23"><h5><code>Ids</code></h5><p>The <code>Ids</code> type is a simple alias for an array of strings, but is used to indicate that the strings should be considered to be the keys of objects (such as the <a href="#/api/store/type-aliases/store/row"><code>Row</code></a> <a href="#/api/common/type-aliases/identity/id"><code>Id</code></a> strings used in a <a href="#/api/store/type-aliases/store/table"><code>Table</code></a>).</p><pre><code><span class="type"><a href="#/api/common/type-aliases/identity/id">Id</a></span><span class="punctuation">[</span><span class="punctuation">]</span></code></pre></section></section><section class="s4" id="/api/common/type-aliases/parameter" data-id="c3/TA15/P6"><h4>Parameter type aliases</h4><p>This is the collection of parameter type aliases within the <a href="#/api/common"><code>common</code></a> module. There is only one type alias, <a href="#/api/common/type-aliases/parameter/sortkey"><code>SortKey</code></a>.</p><section class="s5" id="/api/common/type-aliases/parameter/sortkey" data-id="SK"><h5><code>SortKey</code></h5><p>The <code>SortKey</code> type represents a value that can be used by a sort function.</p><pre><code><span class="builtin">string</span> <span class="operator">|</span> <span class="builtin">number</span> <span class="operator">|</span> <span class="builtin">boolean</span></code></pre></section></section></section></section></section></article><aside></aside></main><footer><nav><a id="tw" href="https://twitter.com/tinybasejs" target="_blank"></a><a id="fb" href="https://facebook.com/tinybasejs" target="_blank"></a></nav><nav><a href="/">TinyBase 2.1.0</a> © 2021- All Rights Reserved</nav></footer></body></html>
+</code></pre></section></section></section><section class="s3" id="/api/common/type-aliases" data-id="c3/TA15"><h3>Type Aliases</h3><p>These are the type aliases within the <a href="#/api/common"><code>common</code></a> module.</p><section class="s4" id="/api/common/type-aliases/callback" data-id="c3/TA15/C32"><h4>Callback type aliases</h4><p>This is the collection of callback type aliases within the <a href="#/api/common"><code>common</code></a> module. There are only two callback type aliases, <a href="#/api/common/type-aliases/callback/callback"><code>Callback</code></a> and <a href="#/api/common/type-aliases/callback/parameterizedcallback"><code>ParameterizedCallback</code></a>.</p><section class="s5" id="/api/common/type-aliases/callback/callback" data-id="C33"><h5><code>Callback</code></h5><p>The <code>Callback</code> type represents a function that is used as a callback and which does not take a parameter.</p><pre><code><span class="punctuation">(</span><span class="punctuation">)</span><span class="operator">:</span> <span class="keyword">void</span></code></pre></section><section class="s5" id="/api/common/type-aliases/callback/parameterizedcallback" data-id="PC"><h5><code>ParameterizedCallback</code></h5><p>The <code>ParameterizedCallback</code> type represents a generic function that will take an optional parameter - such as the handler of a DOM event.</p><pre><code><span class="punctuation">(</span>parameter<span class="operator">?</span><span class="operator">:</span> Parameter<span class="punctuation">)</span><span class="operator">:</span> <span class="keyword">void</span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code>parameter<span class="operator">?</span></code></th><td><code>Parameter</code></td><td></td></tr><tr><th class="right">returns</th><td><code><span class="keyword">void</span></code></td><td><p>This has no return value.</p></td></tr></table></div></section></section><section class="s4" id="/api/common/type-aliases/general" data-id="c3/TA15/G10"><h4>General type aliases</h4><p>This is the collection of general type aliases within the <a href="#/api/common"><code>common</code></a> module. There is only one type alias, <a href="#/api/common/type-aliases/general/json"><code>Json</code></a>.</p><section class="s5" id="/api/common/type-aliases/general/json" data-id="J2"><h5><code>Json</code></h5><p>The <code>Json</code> type is a simple alias for a string, but is used to indicate that the string should be considered to be a JSON serialization of an object.</p><pre><code><span class="builtin">string</span></code></pre></section></section><section class="s4" id="/api/common/type-aliases/identity" data-id="c3/TA15/I21"><h4>Identity type aliases</h4><p>This is the collection of identity type aliases within the <a href="#/api/common"><code>common</code></a> module. There are only three identity type aliases, <a href="#/api/common/type-aliases/identity/id"><code>Id</code></a>, <a href="#/api/common/type-aliases/identity/idornull"><code>IdOrNull</code></a>, and <a href="#/api/common/type-aliases/identity/ids"><code>Ids</code></a>.</p><section class="s5" id="/api/common/type-aliases/identity/id" data-id="I22"><h5><code>Id</code></h5><p>The <code>Id</code> type is a simple alias for a string, but is used to indicate that the string should be considered to be the key of an object (such as a <a href="#/api/store/type-aliases/store/row"><code>Row</code></a> <code>Id</code> string used in a <a href="#/api/store/type-aliases/store/table"><code>Table</code></a>).</p><pre><code><span class="builtin">string</span></code></pre></section><section class="s5" id="/api/common/type-aliases/identity/idornull" data-id="ION"><h5><code>IdOrNull</code></h5><p>The <a href="#/api/common/type-aliases/identity/id"><code>Id</code></a> type is a simple alias for the union of a string or <code>null</code> value, where the string should be considered to be the key of an objects (such as a <a href="#/api/store/type-aliases/store/row"><code>Row</code></a> <a href="#/api/common/type-aliases/identity/id"><code>Id</code></a> string used in a <a href="#/api/store/type-aliases/store/table"><code>Table</code></a>), and typically <code>null</code> indicates a wildcard - such as when used in the <a href="#/api/store/interfaces/store/store"><code>Store</code></a> <a href="#/api/store/interfaces/store/store/methods/listener/addrowlistener"><code>addRowListener</code></a> method.</p><pre><code><span class="type"><a href="#/api/common/type-aliases/identity/id">Id</a></span> <span class="operator">|</span> <span class="keyword">null</span></code></pre></section><section class="s5" id="/api/common/type-aliases/identity/ids" data-id="I23"><h5><code>Ids</code></h5><p>The <code>Ids</code> type is a simple alias for an array of strings, but is used to indicate that the strings should be considered to be the keys of objects (such as the <a href="#/api/store/type-aliases/store/row"><code>Row</code></a> <a href="#/api/common/type-aliases/identity/id"><code>Id</code></a> strings used in a <a href="#/api/store/type-aliases/store/table"><code>Table</code></a>).</p><pre><code><span class="type"><a href="#/api/common/type-aliases/identity/id">Id</a></span><span class="punctuation">[</span><span class="punctuation">]</span></code></pre></section></section><section class="s4" id="/api/common/type-aliases/parameter" data-id="c3/TA15/P6"><h4>Parameter type aliases</h4><p>This is the collection of parameter type aliases within the <a href="#/api/common"><code>common</code></a> module. There is only one type alias, <a href="#/api/common/type-aliases/parameter/sortkey"><code>SortKey</code></a>.</p><section class="s5" id="/api/common/type-aliases/parameter/sortkey" data-id="SK"><h5><code>SortKey</code></h5><p>The <code>SortKey</code> type represents a value that can be used by a sort function.</p><pre><code><span class="builtin">string</span> <span class="operator">|</span> <span class="builtin">number</span> <span class="operator">|</span> <span class="builtin">boolean</span></code></pre></section></section></section></section></section></article><aside></aside></main><footer><nav><a id="tw" href="https://twitter.com/tinybasejs" target="_blank"></a><a id="fb" href="https://facebook.com/tinybasejs" target="_blank"></a></nav><nav><a href="/">TinyBase 2.1.1</a> © 2021- All Rights Reserved</nav></footer></body></html>

docs/api/checkpoints/functions/creation/createcheckpoints/index.html

@@ -7,4 +7,4 @@
 <span class="keyword">const</span> checkpoints2 <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>checkpoints1 <span class="operator">===</span> checkpoints2<span class="punctuation">)</span><span class="punctuation">;</span>
 <span class="comment">// -> true</span>
-</code></pre></section></section></article><aside></aside></main><footer><nav><a id="tw" href="https://twitter.com/tinybasejs" target="_blank"></a><a id="fb" href="https://facebook.com/tinybasejs" target="_blank"></a></nav><nav><a href="/">TinyBase 2.1.0</a> © 2021- All Rights Reserved</nav></footer></body></html>
+</code></pre></section></section></article><aside></aside></main><footer><nav><a id="tw" href="https://twitter.com/tinybasejs" target="_blank"></a><a id="fb" href="https://facebook.com/tinybasejs" target="_blank"></a></nav><nav><a href="/">TinyBase 2.1.1</a> © 2021- All Rights Reserved</nav></footer></body></html>