Skip to content

Commit 74a04aa

Browse files
jamesgpearcejamesgpearce
committed
[docs] Fix broken alias docs
1 parent db66de1 commit 74a04aa

File tree

462 files changed

+583
-1708
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

462 files changed

+583
-1708
lines changed

‎docs/api/all.html‎

Lines changed: 132 additions & 507 deletions
Large diffs are not rendered by default.

‎docs/api/checkpoints/type-aliases/callback/checkpointcallback/article.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
<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/type-aliases/">Type Aliases</a></li><li><a href="/api/checkpoints/type-aliases/callback/">Callback type aliases</a></li><li><a href="/api/checkpoints/type-aliases/callback/checkpointcallback/"><code>CheckpointCallback</code></a></li></ul></nav><section class="s1" id="/api/checkpoints/type-aliases/callback/checkpointcallback/" data-id="CC5"><h1><code>CheckpointCallback</code></h1><p>The <code>CheckpointCallback</code> type describes a function that takes a Checkpoint&#x27;s <a href="/api/common/type-aliases/identity/id/"><code>Id</code></a>.</p><pre><code><span class="punctuation">(</span>
22
checkpointId<span class="operator">:</span> <span class="type"><a href="/api/common/type-aliases/identity/id/">Id</a></span><span class="punctuation">,</span>
33
label<span class="operator">?</span><span class="operator">:</span> <span class="builtin">string</span><span class="punctuation">,</span>
4-
<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>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 that the callback can operate on.</p></td></tr><tr><th><code>label<span class="operator">?</span></code></th><td><code><span class="builtin">string</span></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><p>A <code>CheckpointCallback</code> is provided when using the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/iterator/foreachcheckpoint/"><code>forEachCheckpoint</code></a> method, so that you can do something based on every Checkpoint in the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object. See that method for specific examples.</p><p>A <code>CheckpointCallback</code> is provided when using the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/iterator/foreachcheckpoint/"><code>forEachCheckpoint</code></a> method, so that you can do something based on every Checkpoint in the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object. See that method for specific examples.</p></section>
4+
<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>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 that the callback can operate on.</p></td></tr><tr><th><code>label<span class="operator">?</span></code></th><td><code><span class="builtin">string</span></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><p>A <code>CheckpointCallback</code> is provided when using the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/iterator/foreachcheckpoint/"><code>forEachCheckpoint</code></a> method, so that you can do something based on every Checkpoint in the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object. See that method for specific examples.</p></section>

‎docs/api/checkpoints/type-aliases/callback/checkpointcallback/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
<!DOCTYPE html><html lang="en"><head><link rel="dns-prefetch" href="https://www.googletagmanager.com/"><link href="https://www.googletagmanager.com/gtag/js?id=G-D1MGR8VRWJ" rel="preload" as="script"><link rel="preload" as="font" href="/fonts/inter.woff2" type="font/woff2" crossorigin="anonymous"><link rel="preload" as="font" href="/fonts/inconsolata.woff2" type="font/woff2" crossorigin="anonymous"><link rel="preload" as="font" href="/fonts/icons.woff2" type="font/woff2" crossorigin="anonymous"><link rel="preload" as="font" href="/fonts/shantell.woff2" type="font/woff2" crossorigin="anonymous"><title>CheckpointCallback | TinyBase</title><meta name="description" content="The CheckpointCallback type describes a function that takes a Checkpoint&#x27;s Id."><meta property="og:type" content="website"><meta property="og:title" content="CheckpointCallback | TinyBase"><meta property="og:description" content="The CheckpointCallback type describes a function that takes a Checkpoint&#x27;s Id."><meta property="og:url" content="https://tinybase.org/api/checkpoints/type-aliases/callback/checkpointcallback/"><meta property="og:image" content="https://tinybase.org/favicon_pad.png"><meta name="twitter:card" content="summary"><meta name="twitter:title" content="CheckpointCallback | TinyBase"><meta name="twitter:description" content="The CheckpointCallback type describes a function that takes a Checkpoint&#x27;s Id."><meta name="twitter:site" content="@tinybasejs"><meta name="twitter:image" content="https://tinybase.org/favicon_pad.png"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="icon" type="image/svg+xml" href="/favicon.svg"><link rel="stylesheet" href="/css/index.css"><link rel="canonical" href="https://tinybase.org/api/checkpoints/type-aliases/callback/checkpointcallback/"><script src="/js/app.js"></script></head><body><header><a href="/"><img src="/favicon.svg" alt="TinyBase logo"><span>TinyBase</span></a><nav><ul><li><a href="/guides/">Guides</a></li><li><a href="/demos/">Demos</a></li><li><a href="/api/">API</a></li><li><a href="https://github.com/tinyplex/tinybase">GitHub</a></li></ul></nav><span id="dark"></span></header><main><nav><ul><li id="root" class="parent open"><span></span><a href="/">TinyBase</a><ul><li id="G" class="parent"><span></span><a href="/guides/">Guides</a></li><li id="D2" class="parent"><span></span><a href="/demos/">Demos</a></li><li id="api" class="parent open"><span></span><a href="/api/">API</a><ul><li id="s" class="parent"><span></span><a href="/api/store/"><code>store</code></a></li><li id="m" class="parent"><span></span><a href="/api/metrics/"><code>metrics</code></a></li><li id="i" class="parent"><span></span><a href="/api/indexes/"><code>indexes</code></a></li><li id="r" class="parent"><span></span><a href="/api/relationships/"><code>relationships</code></a></li><li id="q" class="parent"><span></span><a href="/api/queries/"><code>queries</code></a></li><li id="c" class="parent open"><span></span><a href="/api/checkpoints/"><code>checkpoints</code></a><ul><li id="c/I14" class="parent"><span></span><a href="/api/checkpoints/interfaces/">Interfaces</a></li><li id="c/F6" class="parent"><span></span><a href="/api/checkpoints/functions/">Functions</a></li><li id="c/TA13" class="parent open"><span></span><a href="/api/checkpoints/type-aliases/">Type Aliases</a><ul><li id="c/TA13/L17" class="parent"><span></span><a href="/api/checkpoints/type-aliases/listener/">Listener type aliases</a></li><li id="c/TA13/C24" class="parent open"><span></span><a href="/api/checkpoints/type-aliases/callback/">Callback type aliases</a><ul><li id="CC5" class="current"><span></span><a href="/api/checkpoints/type-aliases/callback/checkpointcallback/"><code>CheckpointCallback</code></a></li></ul></li><li id="c/TA13/I16" class="parent"><span></span><a href="/api/checkpoints/type-aliases/identity/">Identity type aliases</a></li><li id="c/TA13/D17" class="parent"><span></span><a href="/api/checkpoints/type-aliases/development/">Development type aliases</a></li></ul></li></ul></li><li id="c3" class="parent"><span></span><a href="/api/common/"><code>common</code></a></li><li id="p" class="parent"><span></span><a href="/api/persisters/"><code>persisters</code></a></li><li id="p2" class="parent"><span></span><a href="/api/persister-automerge/"><code>persister-automerge</code></a></li><li id="p3" class="parent"><span></span><a href="/api/persister-browser/"><code>persister-browser</code></a></li><li id="p4" class="parent"><span></span><a href="/api/persister-cr-sqlite-wasm/"><code>persister-cr-sqlite-wasm</code></a></li><li id="p5" class="parent"><span></span><a href="/api/persister-electric-sql/"><code>persister-electric-sql</code></a></li><li id="p6" class="parent"><span></span><a href="/api/persister-expo-sqlite/"><code>persister-expo-sqlite</code></a></li><li id="p7" class="parent"><span></span><a href="/api/persister-expo-sqlite-next/"><code>persister-expo-sqlite-next</code></a></li><li id="p8" class="parent"><span></span><a href="/api/persister-file/"><code>persister-file</code></a></li><li id="p9" class="parent"><span></span><a href="/api/persister-indexed-db/"><code>persister-indexed-db</code></a></li><li id="p10" class="parent"><span></span><a href="/api/persister-libsql/"><code>persister-libsql</code></a></li><li id="p11" class="parent"><span></span><a href="/api/persister-partykit-client/"><code>persister-partykit-client</code></a></li><li id="p12" class="parent"><span></span><a href="/api/persister-partykit-server/"><code>persister-partykit-server</code></a></li><li id="p13" class="parent"><span></span><a href="/api/persister-powersync/"><code>persister-powersync</code></a></li><li id="p14" class="parent"><span></span><a href="/api/persister-remote/"><code>persister-remote</code></a></li><li id="p15" class="parent"><span></span><a href="/api/persister-sqlite-wasm/"><code>persister-sqlite-wasm</code></a></li><li id="p16" class="parent"><span></span><a href="/api/persister-sqlite3/"><code>persister-sqlite3</code></a></li><li id="p17" class="parent"><span></span><a href="/api/persister-yjs/"><code>persister-yjs</code></a></li><li id="t2" class="parent"><span></span><a href="/api/tools/"><code>tools</code></a></li><li id="u" class="parent"><span></span><a href="/api/ui-react/"><code>ui-react</code></a></li><li id="u2" class="parent"><span></span><a href="/api/ui-react-dom/"><code>ui-react-dom</code></a></li></ul></li></ul></li></ul></nav><article><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/type-aliases/">Type Aliases</a></li><li><a href="/api/checkpoints/type-aliases/callback/">Callback type aliases</a></li><li><a href="/api/checkpoints/type-aliases/callback/checkpointcallback/"><code>CheckpointCallback</code></a></li></ul></nav><section class="s1" id="/api/checkpoints/type-aliases/callback/checkpointcallback/" data-id="CC5"><h1><code>CheckpointCallback</code></h1><p>The <code>CheckpointCallback</code> type describes a function that takes a Checkpoint&#x27;s <a href="/api/common/type-aliases/identity/id/"><code>Id</code></a>.</p><pre><code><span class="punctuation">(</span>
22
checkpointId<span class="operator">:</span> <span class="type"><a href="/api/common/type-aliases/identity/id/">Id</a></span><span class="punctuation">,</span>
33
label<span class="operator">?</span><span class="operator">:</span> <span class="builtin">string</span><span class="punctuation">,</span>
4-
<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>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 that the callback can operate on.</p></td></tr><tr><th><code>label<span class="operator">?</span></code></th><td><code><span class="builtin">string</span></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><p>A <code>CheckpointCallback</code> is provided when using the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/iterator/foreachcheckpoint/"><code>forEachCheckpoint</code></a> method, so that you can do something based on every Checkpoint in the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object. See that method for specific examples.</p><p>A <code>CheckpointCallback</code> is provided when using the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/iterator/foreachcheckpoint/"><code>forEachCheckpoint</code></a> method, so that you can do something based on every Checkpoint in the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object. See that method for specific examples.</p></section></article><aside></aside></main><footer><nav><a id="tw" href="https://twitter.com/tinybasejs" target="_blank">Twitter</a><a id="fb" href="https://facebook.com/tinybasejs" target="_blank">Facebook</a></nav><nav><a href="/">TinyBase 4.8.14</a> © 2021- All Rights Reserved</nav></footer></body><script async="" src="https://www.googletagmanager.com/gtag/js?id=G-D1MGR8VRWJ"></script><script>window.dataLayer=window.dataLayer||[];function g(){dataLayer.push(arguments);}g('js',new Date());g('config','G-D1MGR8VRWJ');</script></html>
4+
<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>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 that the callback can operate on.</p></td></tr><tr><th><code>label<span class="operator">?</span></code></th><td><code><span class="builtin">string</span></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><p>A <code>CheckpointCallback</code> is provided when using the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/methods/iterator/foreachcheckpoint/"><code>forEachCheckpoint</code></a> method, so that you can do something based on every Checkpoint in the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object. See that method for specific examples.</p></section></article><aside></aside></main><footer><nav><a id="tw" href="https://twitter.com/tinybasejs" target="_blank">Twitter</a><a id="fb" href="https://facebook.com/tinybasejs" target="_blank">Facebook</a></nav><nav><a href="/">TinyBase 4.8.14</a> © 2021- All Rights Reserved</nav></footer></body><script async="" src="https://www.googletagmanager.com/gtag/js?id=G-D1MGR8VRWJ"></script><script>window.dataLayer=window.dataLayer||[];function g(){dataLayer.push(arguments);}g('js',new Date());g('config','G-D1MGR8VRWJ');</script></html>

‎docs/api/checkpoints/type-aliases/development/article.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +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/type-aliases/">Type Aliases</a></li><li><a href="/api/checkpoints/type-aliases/development/">Development type aliases</a></li></ul></nav><section class="s1" id="/api/checkpoints/type-aliases/development/" data-id="c/TA13/D17"><h1>Development type aliases</h1><p>This is the collection of development type aliases within the <a href="/api/checkpoints/"><code>checkpoints</code></a> module. There is only one type alias, <a href="/api/checkpoints/type-aliases/development/checkpointslistenerstats/"><code>CheckpointsListenerStats</code></a>.</p><section class="s2" id="/api/checkpoints/type-aliases/development/checkpointslistenerstats/" data-id="CLS"><h2><a href="/api/checkpoints/type-aliases/development/checkpointslistenerstats/"><code>CheckpointsListenerStats</code></a></h2></section></section>
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/type-aliases/">Type Aliases</a></li><li><a href="/api/checkpoints/type-aliases/development/">Development type aliases</a></li></ul></nav><section class="s1" id="/api/checkpoints/type-aliases/development/" data-id="c/TA13/D17"><h1>Development type aliases</h1><p>This is the collection of development type aliases within the <a href="/api/checkpoints/"><code>checkpoints</code></a> module. There is only one type alias, <a href="/api/checkpoints/type-aliases/development/checkpointslistenerstats/"><code>CheckpointsListenerStats</code></a>.</p><section class="s2" id="/api/checkpoints/type-aliases/development/checkpointslistenerstats/" data-id="CLS"><h2><a href="/api/checkpoints/type-aliases/development/checkpointslistenerstats/"><code>CheckpointsListenerStats</code></a></h2><p>The <code>CheckpointsListenerStats</code> type describes the number of listeners registered with the <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a> object, and can be used for debugging purposes.</p></section></section>

0 commit comments

Comments
 (0)