v4.3.0-beta.1

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></ul></nav><section class="s1" id="/api/checkpoints/" data-id="c"><h1><code>checkpoints</code></h1><p>The <code>checkpoints</code> module of the <a href="/">TinyBase</a> project provides the ability to create and track checkpoints made to the data in <a href="/api/store/interfaces/store/store/"><code>Store</code></a> objects.</p><p>The main entry point to this module is the <a href="/api/checkpoints/functions/creation/createcheckpoints/"><code>createCheckpoints</code></a> function, which returns a new <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object. From there, you can create new checkpoints, go forwards or backwards to others, and register listeners for when the list of checkpoints change.</p><section class="s2" id="/api/checkpoints/interfaces/" data-id="c/I14"><h2><a href="/api/checkpoints/interfaces/">Interfaces</a></h2><p>There is one interface, <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a>, within the <a href="/api/checkpoints/"><code>checkpoints</code></a> module.</p><ul><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a></li></ul></section><section class="s2" id="/api/checkpoints/functions/" data-id="c/F6"><h2><a href="/api/checkpoints/functions/">Functions</a></h2><p>There is one function, <a href="/api/checkpoints/functions/creation/createcheckpoints/"><code>createCheckpoints</code></a>, within the <a href="/api/checkpoints/"><code>checkpoints</code></a> module.</p><ul><li><a href="/api/checkpoints/functions/creation/createcheckpoints/"><code>createCheckpoints</code></a></li></ul></section><section class="s2" id="/api/checkpoints/type-aliases/" data-id="c/TA12"><h2><a href="/api/checkpoints/type-aliases/">Type Aliases</a></h2><p>These are the type aliases within the <a href="/api/checkpoints/"><code>checkpoints</code></a> module.</p><ul><li><a href="/api/checkpoints/type-aliases/listener/">Listener type aliases</a></li><li><a href="/api/checkpoints/type-aliases/callback/">Callback type aliases</a></li><li><a href="/api/checkpoints/type-aliases/identity/">Identity type aliases</a></li><li><a href="/api/checkpoints/type-aliases/development/">Development type aliases</a></li></ul></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></ul></nav><section class="s1" id="/api/checkpoints/" data-id="c"><h1><code>checkpoints</code></h1><p>The <code>checkpoints</code> module of the <a href="/">TinyBase</a> project provides the ability to create and track checkpoints made to the data in <a href="/api/store/interfaces/store/store/"><code>Store</code></a> objects.</p><p>The main entry point to this module is the <a href="/api/checkpoints/functions/creation/createcheckpoints/"><code>createCheckpoints</code></a> function, which returns a new <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object. From there, you can create new checkpoints, go forwards or backwards to others, and register listeners for when the list of checkpoints change.</p><section class="s2" id="/api/checkpoints/interfaces/" data-id="c/I14"><h2><a href="/api/checkpoints/interfaces/">Interfaces</a></h2><p>There is one interface, <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a>, within the <a href="/api/checkpoints/"><code>checkpoints</code></a> module.</p><ul><li><a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a></li></ul></section><section class="s2" id="/api/checkpoints/functions/" data-id="c/F6"><h2><a href="/api/checkpoints/functions/">Functions</a></h2><p>There is one function, <a href="/api/checkpoints/functions/creation/createcheckpoints/"><code>createCheckpoints</code></a>, within the <a href="/api/checkpoints/"><code>checkpoints</code></a> module.</p><ul><li><a href="/api/checkpoints/functions/creation/createcheckpoints/"><code>createCheckpoints</code></a></li></ul></section><section class="s2" id="/api/checkpoints/type-aliases/" data-id="c/TA13"><h2><a href="/api/checkpoints/type-aliases/">Type Aliases</a></h2><p>These are the type aliases within the <a href="/api/checkpoints/"><code>checkpoints</code></a> module.</p><ul><li><a href="/api/checkpoints/type-aliases/listener/">Listener type aliases</a></li><li><a href="/api/checkpoints/type-aliases/callback/">Callback type aliases</a></li><li><a href="/api/checkpoints/type-aliases/identity/">Identity type aliases</a></li><li><a href="/api/checkpoints/type-aliases/development/">Development type aliases</a></li></ul></section></section>

docs/api/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":"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,"o":1,"_":[{"i":"c/I14","n":"Interfaces","u":"/api/checkpoints/interfaces/","p":1},{"i":"c/F6","n":"Functions","u":"/api/checkpoints/functions/","p":1,"o":1,"_":[{"i":"cC","n":"createCheckpoints","u":"/api/checkpoints/functions/creation/createcheckpoints/","r":1,"c":1}]},{"i":"c/TA12","n":"Type Aliases","u":"/api/checkpoints/type-aliases/","p":1}]},{"i":"c3","n":"common","u":"/api/common/","r":1,"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-expo-sqlite","u":"/api/persister-expo-sqlite/","r":1,"p":1},{"i":"p6","n":"persister-file","u":"/api/persister-file/","r":1,"p":1},{"i":"p7","n":"persister-indexed-db","u":"/api/persister-indexed-db/","r":1,"p":1},{"i":"p8","n":"persister-remote","u":"/api/persister-remote/","r":1,"p":1},{"i":"p9","n":"persister-sqlite-wasm","u":"/api/persister-sqlite-wasm/","r":1,"p":1},{"i":"p10","n":"persister-sqlite3","u":"/api/persister-sqlite3/","r":1,"p":1},{"i":"p11","n":"persister-yjs","u":"/api/persister-yjs/","r":1,"p":1},{"i":"t2","n":"tools","u":"/api/tools/","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":"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":"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,"o":1,"_":[{"i":"c/I14","n":"Interfaces","u":"/api/checkpoints/interfaces/","p":1},{"i":"c/F6","n":"Functions","u":"/api/checkpoints/functions/","p":1,"o":1,"_":[{"i":"cC","n":"createCheckpoints","u":"/api/checkpoints/functions/creation/createcheckpoints/","r":1,"c":1}]},{"i":"c/TA13","n":"Type Aliases","u":"/api/checkpoints/type-aliases/","p":1}]},{"i":"c3","n":"common","u":"/api/common/","r":1,"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-expo-sqlite","u":"/api/persister-expo-sqlite/","r":1,"p":1},{"i":"p6","n":"persister-file","u":"/api/persister-file/","r":1,"p":1},{"i":"p7","n":"persister-indexed-db","u":"/api/persister-indexed-db/","r":1,"p":1},{"i":"p8","n":"persister-partykit-client","u":"/api/persister-partykit-client/","r":1,"p":1},{"i":"p9","n":"persister-partykit-server","u":"/api/persister-partykit-server/","r":1,"p":1},{"i":"p10","n":"persister-remote","u":"/api/persister-remote/","r":1,"p":1},{"i":"p11","n":"persister-sqlite-wasm","u":"/api/persister-sqlite-wasm/","r":1,"p":1},{"i":"p12","n":"persister-sqlite3","u":"/api/persister-sqlite3/","r":1,"p":1},{"i":"p13","n":"persister-yjs","u":"/api/persister-yjs/","r":1,"p":1},{"i":"t2","n":"tools","u":"/api/tools/","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}]}]}