v6.2.0-beta.2

Author: jamesgpearce

coverage.json

@@ -1 +1 @@
-{"tests":7082,"assertions":32840,"lines":{"total":2308,"covered":2308,"skipped":0,"pct":100},"statements":{"total":2494,"covered":2494,"skipped":0,"pct":100},"functions":{"total":997,"covered":997,"skipped":0,"pct":100},"branches":{"total":876,"covered":876,"skipped":0,"pct":100},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":100}}
+{"tests":7084,"assertions":32850,"lines":{"total":2312,"covered":2312,"skipped":0,"pct":100},"statements":{"total":2501,"covered":2501,"skipped":0,"pct":100},"functions":{"total":1000,"covered":1000,"skipped":0,"pct":100},"branches":{"total":878,"covered":878,"skipped":0,"pct":100},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":100}}

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/common/"><code>common</code></a></li></ul></nav><section class="s1" id="/api/common/" data-id="c3"><h1><code>common</code></h1><p>The <code>common</code> module of the TinyBase project provides a small collection of common types used across other modules.</p><section class="s2"><h2>Since</h2><p>v1.0.0</p></section><section class="s2" id="/api/common/functions/" data-id="c3/F8"><h2>Functions</h2><ul><li><a href="/api/common/functions/convenience/defaultsorter/"><code>defaultSorter</code></a></li><li><a href="/api/common/functions/convenience/getuniqueid/"><code>getUniqueId</code></a></li></ul></section><section class="s2" id="/api/common/type-aliases/" data-id="c3/TA15"><h2>Type Aliases</h2><ul><li><a href="/api/common/type-aliases/callback/">Callback type aliases</a></li><li><a href="/api/common/type-aliases/general/json/"><code>Json</code></a> type alias</li><li><a href="/api/common/type-aliases/identity/">Identity type aliases</a></li><li><a href="/api/common/type-aliases/parameter/sortkey/"><code>SortKey</code></a> type alias</li></ul></section></section>
+<nav><ul><li><a href="/">TinyBase</a></li><li><a href="/api/">API</a></li><li><a href="/api/common/"><code>common</code></a></li></ul></nav><section class="s1" id="/api/common/" data-id="c3"><h1><code>common</code></h1><p>The <code>common</code> module of the TinyBase project provides a small collection of common types used across other modules.</p><section class="s2"><h2>Since</h2><p>v1.0.0</p></section><section class="s2" id="/api/common/functions/" data-id="c3/F8"><h2>Functions</h2><ul><li><a href="/api/common/functions/convenience/">Convenience functions</a></li><li><a href="/api/common/functions/stamps/gethlcfunctions/"><code>getHlcFunctions</code></a> function</li></ul></section><section class="s2" id="/api/common/type-aliases/" data-id="c3/TA15"><h2>Type Aliases</h2><ul><li><a href="/api/common/type-aliases/callback/">Callback type aliases</a></li><li><a href="/api/common/type-aliases/general/json/"><code>Json</code></a> type alias</li><li><a href="/api/common/type-aliases/identity/">Identity type aliases</a></li><li><a href="/api/common/type-aliases/parameter/sortkey/"><code>SortKey</code></a> type alias</li><li><a href="/api/common/type-aliases/stamps/">Stamps type aliases</a></li></ul></section></section>

docs/api/common/article.html

@@ -1 +1 @@
-<nav><ul><li><a href="/">TinyBase</a></li><li><a href="/api/">API</a></li><li><a href="/api/common/"><code>common</code></a></li><li><a href="/api/common/functions/">Functions</a></li></ul></nav><section class="s1" id="/api/common/functions/" data-id="c3/F8"><h1>Functions</h1><section class="s2" id="/api/common/functions/convenience/defaultsorter/" data-id="dS3"><h2><code>defaultSorter</code></h2><p>The <code>defaultSorter</code> function is provided as a convenience to sort keys alphanumerically, and can be provided to the <code>sliceIdSorter</code> and <code>rowIdSorter</code> parameters of the <a href="/api/indexes/interfaces/indexes/indexes/methods/configuration/setindexdefinition/"><code>setIndexDefinition</code></a> method in the <a href="/api/indexes/"><code>indexes</code></a> module, for example. <a href="/api/common/functions/convenience/defaultsorter/">Read more</a>.</p></section><section class="s2" id="/api/common/functions/convenience/getuniqueid/" data-id="gUI"><h2><code>getUniqueId</code></h2><p>The <code>getUniqueId</code> function returns a unique string of a given length. <a href="/api/common/functions/convenience/getuniqueid/">Read more</a>.</p></section></section>
+<nav><ul><li><a href="/">TinyBase</a></li><li><a href="/api/">API</a></li><li><a href="/api/common/"><code>common</code></a></li><li><a href="/api/common/functions/">Functions</a></li></ul></nav><section class="s1" id="/api/common/functions/" data-id="c3/F8"><h1>Functions</h1><section class="s2" id="/api/common/functions/convenience/" data-id="c3/F8/C28"><h2>Convenience functions</h2><ul><li><a href="/api/common/functions/convenience/defaultsorter/"><code>defaultSorter</code></a></li><li><a href="/api/common/functions/convenience/getuniqueid/"><code>getUniqueId</code></a></li></ul></section><section class="s2" id="/api/common/functions/stamps/" data-id="c3/F8/S16"><h2>Stamps functions</h2><ul><li><a href="/api/common/functions/stamps/gethlcfunctions/"><code>getHlcFunctions</code></a></li></ul></section></section>

docs/api/common/functions/article.html

@@ -1 +1 @@
-<nav><ul><li><a href="/">TinyBase</a></li><li><a href="/api/">API</a></li><li><a href="/api/common/"><code>common</code></a></li><li><a href="/api/common/functions/">Functions</a></li></ul></nav><section class="s1" id="/api/common/functions/convenience/" data-id="c3/F8/C28"><h1>Convenience functions</h1><section class="s2" id="/api/common/functions/convenience/defaultsorter/" data-id="dS3"><h2><code>defaultSorter</code></h2><p>The <code>defaultSorter</code> function is provided as a convenience to sort keys alphanumerically, and can be provided to the <code>sliceIdSorter</code> and <code>rowIdSorter</code> parameters of the <a href="/api/indexes/interfaces/indexes/indexes/methods/configuration/setindexdefinition/"><code>setIndexDefinition</code></a> method in the <a href="/api/indexes/"><code>indexes</code></a> module, for example. <a href="/api/common/functions/convenience/defaultsorter/">Read more</a>.</p></section><section class="s2" id="/api/common/functions/convenience/getuniqueid/" data-id="gUI"><h2><code>getUniqueId</code></h2><p>The <code>getUniqueId</code> function returns a unique string of a given length. <a href="/api/common/functions/convenience/getuniqueid/">Read more</a>.</p></section></section>
+<nav><ul><li><a href="/">TinyBase</a></li><li><a href="/api/">API</a></li><li><a href="/api/common/"><code>common</code></a></li><li><a href="/api/common/functions/">Functions</a></li><li><a href="/api/common/functions/convenience/">Convenience functions</a></li></ul></nav><section class="s1" id="/api/common/functions/convenience/" data-id="c3/F8/C28"><h1>Convenience functions</h1><section class="s2" id="/api/common/functions/convenience/defaultsorter/" data-id="dS3"><h2><code>defaultSorter</code></h2><p>The <code>defaultSorter</code> function is provided as a convenience to sort keys alphanumerically, and can be provided to the <code>sliceIdSorter</code> and <code>rowIdSorter</code> parameters of the <a href="/api/indexes/interfaces/indexes/indexes/methods/configuration/setindexdefinition/"><code>setIndexDefinition</code></a> method in the <a href="/api/indexes/"><code>indexes</code></a> module, for example. <a href="/api/common/functions/convenience/defaultsorter/">Read more</a>.</p></section><section class="s2" id="/api/common/functions/convenience/getuniqueid/" data-id="gUI"><h2><code>getUniqueId</code></h2><p>The <code>getUniqueId</code> function returns a unique string of a given length. <a href="/api/common/functions/convenience/getuniqueid/">Read more</a>.</p></section></section>

docs/api/common/functions/convenience/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/common/"><code>common</code></a></li><li><a href="/api/common/functions/">Functions</a></li><li><a href="/api/common/functions/convenience/defaultsorter/"><code>defaultSorter</code></a></li></ul></nav><section class="s1" id="/api/common/functions/convenience/defaultsorter/" data-id="dS3"><h1><code>defaultSorter</code></h1><p>The <code>defaultSorter</code> function is provided as a convenience to sort keys alphanumerically, and can be provided to the <code>sliceIdSorter</code> and <code>rowIdSorter</code> parameters of the <a href="/api/indexes/interfaces/indexes/indexes/methods/configuration/setindexdefinition/"><code>setIndexDefinition</code></a> method in the <a href="/api/indexes/"><code>indexes</code></a> module, for example.</p><pre><code><span class="function"><a href="/api/common/functions/convenience/defaultsorter/">defaultSorter</a></span><span class="punctuation">(</span>
+<nav><ul><li><a href="/">TinyBase</a></li><li><a href="/api/">API</a></li><li><a href="/api/common/"><code>common</code></a></li><li><a href="/api/common/functions/">Functions</a></li><li><a href="/api/common/functions/convenience/">Convenience functions</a></li><li><a href="/api/common/functions/convenience/defaultsorter/"><code>defaultSorter</code></a></li></ul></nav><section class="s1" id="/api/common/functions/convenience/defaultsorter/" data-id="dS3"><h1><code>defaultSorter</code></h1><p>The <code>defaultSorter</code> function is provided as a convenience to sort keys alphanumerically, and can be provided to the <code>sliceIdSorter</code> and <code>rowIdSorter</code> parameters of the <a href="/api/indexes/interfaces/indexes/indexes/methods/configuration/setindexdefinition/"><code>setIndexDefinition</code></a> method in the <a href="/api/indexes/"><code>indexes</code></a> module, for example.</p><pre><code><span class="function"><a href="/api/common/functions/convenience/defaultsorter/">defaultSorter</a></span><span class="punctuation">(</span>
   sortKey1<span class="operator">:</span> <span class="type"><a href="/api/common/type-aliases/parameter/sortkey/">SortKey</a></span><span class="punctuation">,</span>
   sortKey2<span class="operator">:</span> <span class="type"><a href="/api/common/type-aliases/parameter/sortkey/">SortKey</a></span><span class="punctuation">,</span>
 <span class="punctuation">)</span><span class="operator">:</span> <span class="builtin">number</span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code>sortKey1</code></th><td><code><span class="type"><a href="/api/common/type-aliases/parameter/sortkey/">SortKey</a></span></code></td><td><p>The first item of the pair to compare.</p></td></tr><tr><th><code>sortKey2</code></th><td><code><span class="type"><a href="/api/common/type-aliases/parameter/sortkey/">SortKey</a></span></code></td><td><p>The second item of the pair to compare.</p></td></tr><tr><th class="right">returns</th><td><code><span class="builtin">number</span></code></td><td><p></p><p>A number indicating how to sort the pair.</p><p></p></td></tr></table></div><section class="s2"><h2>Examples</h2><p>This example creates an <a href="/api/indexes/interfaces/indexes/indexes/"><code>Indexes</code></a> object.</p><pre><code><span class="keyword">import</span> <span class="punctuation">{</span>createIndexes<span class="punctuation">,</span> createStore<span class="punctuation">}</span> <span class="keyword">from</span> <span class="string">'tinybase'</span><span class="punctuation">;</span>

docs/api/common/functions/convenience/defaultsorter/article.html

@@ -1 +1 @@
-{"i":"root","n":"TinyBase","u":"/","p":1,"o":1,"_":[{"i":"G","n":"Guides","u":"/guides/","p":1},{"i":"D2","n":"Demos","u":"/demos/","p":1},{"i":"api","n":"API","u":"/api/","p":1,"o":1,"_":[{"i":"s","n":"store","u":"/api/store/","r":1,"p":1},{"i":"m","n":"mergeable-store","u":"/api/mergeable-store/","r":1,"p":1},{"i":"m3","n":"metrics","u":"/api/metrics/","r":1,"p":1},{"i":"i","n":"indexes","u":"/api/indexes/","r":1,"p":1},{"i":"r","n":"relationships","u":"/api/relationships/","r":1,"p":1},{"i":"q","n":"queries","u":"/api/queries/","r":1,"p":1},{"i":"c","n":"checkpoints","u":"/api/checkpoints/","r":1,"p":1},{"i":"c3","n":"common","u":"/api/common/","r":1,"p":1,"o":1,"_":[{"i":"c3/F8","n":"Functions","u":"/api/common/functions/","p":1,"o":1,"_":[{"i":"dS3","n":"defaultSorter","u":"/api/common/functions/convenience/defaultsorter/","r":1,"c":1},{"i":"gUI","n":"getUniqueId","u":"/api/common/functions/convenience/getuniqueid/","r":1}]},{"i":"c3/TA15","n":"Type Aliases","u":"/api/common/type-aliases/","p":1}]},{"i":"p","n":"persisters","u":"/api/persisters/","r":1,"p":1},{"i":"p2","n":"persister-automerge","u":"/api/persister-automerge/","r":1,"p":1},{"i":"p3","n":"persister-browser","u":"/api/persister-browser/","r":1,"p":1},{"i":"p4","n":"persister-cr-sqlite-wasm","u":"/api/persister-cr-sqlite-wasm/","r":1,"p":1},{"i":"p5","n":"persister-durable-object-storage","u":"/api/persister-durable-object-storage/","r":1,"p":1},{"i":"p6","n":"persister-electric-sql","u":"/api/persister-electric-sql/","r":1,"p":1},{"i":"p7","n":"persister-expo-sqlite","u":"/api/persister-expo-sqlite/","r":1,"p":1},{"i":"p8","n":"persister-file","u":"/api/persister-file/","r":1,"p":1},{"i":"p9","n":"persister-indexed-db","u":"/api/persister-indexed-db/","r":1,"p":1},{"i":"p10","n":"persister-libsql","u":"/api/persister-libsql/","r":1,"p":1},{"i":"p11","n":"persister-partykit-client","u":"/api/persister-partykit-client/","r":1,"p":1},{"i":"p12","n":"persister-partykit-server","u":"/api/persister-partykit-server/","r":1,"p":1},{"i":"p13","n":"persister-pglite","u":"/api/persister-pglite/","r":1,"p":1},{"i":"p14","n":"persister-postgres","u":"/api/persister-postgres/","r":1,"p":1},{"i":"p15","n":"persister-powersync","u":"/api/persister-powersync/","r":1,"p":1},{"i":"p16","n":"persister-remote","u":"/api/persister-remote/","r":1,"p":1},{"i":"p17","n":"persister-sqlite-bun","u":"/api/persister-sqlite-bun/","r":1,"p":1},{"i":"p18","n":"persister-sqlite-wasm","u":"/api/persister-sqlite-wasm/","r":1,"p":1},{"i":"p19","n":"persister-sqlite3","u":"/api/persister-sqlite3/","r":1,"p":1},{"i":"p20","n":"persister-yjs","u":"/api/persister-yjs/","r":1,"p":1},{"i":"s42","n":"synchronizers","u":"/api/synchronizers/","r":1,"p":1},{"i":"s45","n":"synchronizer-broadcast-channel","u":"/api/synchronizer-broadcast-channel/","r":1,"p":1},{"i":"s48","n":"synchronizer-local","u":"/api/synchronizer-local/","r":1,"p":1},{"i":"s51","n":"synchronizer-ws-client","u":"/api/synchronizer-ws-client/","r":1,"p":1},{"i":"s54","n":"synchronizer-ws-server","u":"/api/synchronizer-ws-server/","r":1,"p":1},{"i":"s55","n":"synchronizer-ws-server-durable-object","u":"/api/synchronizer-ws-server-durable-object/","r":1,"p":1},{"i":"s56","n":"synchronizer-ws-server-simple","u":"/api/synchronizer-ws-server-simple/","r":1,"p":1},{"i":"u","n":"ui-react","u":"/api/ui-react/","r":1,"p":1},{"i":"u2","n":"ui-react-dom","u":"/api/ui-react-dom/","r":1,"p":1},{"i":"u3","n":"ui-react-inspector","u":"/api/ui-react-inspector/","r":1,"p":1}]}]}
+{"i":"root","n":"TinyBase","u":"/","p":1,"o":1,"_":[{"i":"G","n":"Guides","u":"/guides/","p":1},{"i":"D2","n":"Demos","u":"/demos/","p":1},{"i":"api","n":"API","u":"/api/","p":1,"o":1,"_":[{"i":"s","n":"store","u":"/api/store/","r":1,"p":1},{"i":"m","n":"mergeable-store","u":"/api/mergeable-store/","r":1,"p":1},{"i":"m3","n":"metrics","u":"/api/metrics/","r":1,"p":1},{"i":"i","n":"indexes","u":"/api/indexes/","r":1,"p":1},{"i":"r","n":"relationships","u":"/api/relationships/","r":1,"p":1},{"i":"q","n":"queries","u":"/api/queries/","r":1,"p":1},{"i":"c","n":"checkpoints","u":"/api/checkpoints/","r":1,"p":1},{"i":"c3","n":"common","u":"/api/common/","r":1,"p":1,"o":1,"_":[{"i":"c3/F8","n":"Functions","u":"/api/common/functions/","p":1,"o":1,"_":[{"i":"c3/F8/C28","n":"Convenience functions","u":"/api/common/functions/convenience/","p":1,"o":1,"_":[{"i":"dS3","n":"defaultSorter","u":"/api/common/functions/convenience/defaultsorter/","r":1,"c":1},{"i":"gUI","n":"getUniqueId","u":"/api/common/functions/convenience/getuniqueid/","r":1}]},{"i":"c3/F8/S16","n":"Stamps functions","u":"/api/common/functions/stamps/","p":1}]},{"i":"c3/TA15","n":"Type Aliases","u":"/api/common/type-aliases/","p":1}]},{"i":"p","n":"persisters","u":"/api/persisters/","r":1,"p":1},{"i":"p2","n":"persister-automerge","u":"/api/persister-automerge/","r":1,"p":1},{"i":"p3","n":"persister-browser","u":"/api/persister-browser/","r":1,"p":1},{"i":"p4","n":"persister-cr-sqlite-wasm","u":"/api/persister-cr-sqlite-wasm/","r":1,"p":1},{"i":"p5","n":"persister-durable-object-storage","u":"/api/persister-durable-object-storage/","r":1,"p":1},{"i":"p6","n":"persister-electric-sql","u":"/api/persister-electric-sql/","r":1,"p":1},{"i":"p7","n":"persister-expo-sqlite","u":"/api/persister-expo-sqlite/","r":1,"p":1},{"i":"p8","n":"persister-file","u":"/api/persister-file/","r":1,"p":1},{"i":"p9","n":"persister-indexed-db","u":"/api/persister-indexed-db/","r":1,"p":1},{"i":"p10","n":"persister-libsql","u":"/api/persister-libsql/","r":1,"p":1},{"i":"p11","n":"persister-partykit-client","u":"/api/persister-partykit-client/","r":1,"p":1},{"i":"p12","n":"persister-partykit-server","u":"/api/persister-partykit-server/","r":1,"p":1},{"i":"p13","n":"persister-pglite","u":"/api/persister-pglite/","r":1,"p":1},{"i":"p14","n":"persister-postgres","u":"/api/persister-postgres/","r":1,"p":1},{"i":"p15","n":"persister-powersync","u":"/api/persister-powersync/","r":1,"p":1},{"i":"p16","n":"persister-remote","u":"/api/persister-remote/","r":1,"p":1},{"i":"p17","n":"persister-sqlite-bun","u":"/api/persister-sqlite-bun/","r":1,"p":1},{"i":"p18","n":"persister-sqlite-wasm","u":"/api/persister-sqlite-wasm/","r":1,"p":1},{"i":"p19","n":"persister-sqlite3","u":"/api/persister-sqlite3/","r":1,"p":1},{"i":"p20","n":"persister-yjs","u":"/api/persister-yjs/","r":1,"p":1},{"i":"s42","n":"synchronizers","u":"/api/synchronizers/","r":1,"p":1},{"i":"s45","n":"synchronizer-broadcast-channel","u":"/api/synchronizer-broadcast-channel/","r":1,"p":1},{"i":"s48","n":"synchronizer-local","u":"/api/synchronizer-local/","r":1,"p":1},{"i":"s51","n":"synchronizer-ws-client","u":"/api/synchronizer-ws-client/","r":1,"p":1},{"i":"s54","n":"synchronizer-ws-server","u":"/api/synchronizer-ws-server/","r":1,"p":1},{"i":"s55","n":"synchronizer-ws-server-durable-object","u":"/api/synchronizer-ws-server-durable-object/","r":1,"p":1},{"i":"s56","n":"synchronizer-ws-server-simple","u":"/api/synchronizer-ws-server-simple/","r":1,"p":1},{"i":"u","n":"ui-react","u":"/api/ui-react/","r":1,"p":1},{"i":"u2","n":"ui-react-dom","u":"/api/ui-react-dom/","r":1,"p":1},{"i":"u3","n":"ui-react-inspector","u":"/api/ui-react-inspector/","r":1,"p":1}]}]}