Skip to content

Commit 3462925

Browse files
committed
Docs bumps
1 parent 26e077d commit 3462925

170 files changed

Lines changed: 176 additions & 178 deletions

File tree

Some content is hidden

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

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,4 +105,4 @@ unsubscribe();
105105
await db.close();
106106
```
107107

108-
<section><h2 id="go-deeper-when-you-need-to">Go deeper when you need to</h2><ul><li>Follow the <a href="https://tinyjoin.org/guides/getting-started/">getting started guide</a>.</li><li>Browse the <a href="https://tinyjoin.org/api/">API reference</a>.</li><li>Understand the <a href="https://tinyjoin.org/guides/caveats/">caveats</a>.</li><li>Review the <a href="https://tinyjoin.org/guides/releases/">release notes</a>.</li><li>Start an app with <a href="https://github.com/tinyplex/create-tinyjoin">create-tinyjoin</a>.</li><li>Read the <a href="https://github.com/tinyplex/tinyjoin">source</a>.</li></ul><p>TinyJoin is MIT licensed.</p></section><section><h2 id="local-by-design">Local by design</h2><p>TinyJoin keeps your database in the browser. Your app reads and writes data locally, without waiting for a database server. Keep data in memory or save it across reloads with OPFS; tabs opening the same persistent database share access automatically.</p><p>Your app can keep working when the network drops. Apps created with the starter can also <a href="https://tinyjoin.org/guides/offline/">reopen offline</a> once their production build has been cached.</p></section><section id="limits" aria-labelledby="know-the-limits"><h2 id="know-the-limits">Know the limits</h2><p>TinyJoin is experimental, with a bounded SQL dialect and no built-in remote synchronization. Browser storage can be lost, so use it for data you can reconstruct. Read the <a href="https://tinyjoin.org/guides/caveats/">caveats</a> and <a href="https://tinyjoin.org/guides/sql-compatibility/">SQL compatibility guide</a> to check whether it fits your app.</p></section><hr><section id="family"><h2 id="meet-the-family">Meet the family</h2><p>TinyJoin is one of a group of small libraries that make rich client and local-first apps easier to build. Take a look at the others!</p><ul><li><a href="https://tinybase.org/"><img src="https://tinybase.org/favicon.svg?asImg" alt="" width="40" height="40"> <b>TinyBase</b> </a>A reactive data store with persistence and synchronization.</li><li><a href="https://synclets.org/"><img src="https://synclets.org/favicon.svg?asImg" alt="" width="40" height="40"> <b>Synclets</b> </a>An open, storage-agnostic sync engine development kit.</li><li><a href="https://tinywidgets.org/"><img src="https://tinywidgets.org/favicon.svg?asImg" alt="" width="40" height="40"> <b>TinyWidgets</b> </a>A collection of tiny, reusable UI components.</li><li><a href="https://tinytick.org/"><img src="https://tinytick.org/favicon.svg?asImg" alt="" width="40" height="40"> <b>TinyTick</b> </a>A tiny but very useful task orchestrator.</li></ul></section>
108+
<section><h2 id="go-deeper-when-you-need-to">Go deeper when you need to</h2><ul><li>Follow the <a href="https://tinyjoin.org/guides/getting-started/">getting started guide</a>.</li><li>Browse the <a href="https://tinyjoin.org/api/">API reference</a>.</li><li>Understand the <a href="https://tinyjoin.org/guides/caveats/">caveats</a>.</li><li>Review the <a href="https://tinyjoin.org/guides/releases/">release notes</a>.</li><li>Start an app with <a href="https://github.com/tinyplex/create-tinyjoin">create-tinyjoin</a>.</li><li>Read the <a href="https://github.com/tinyplex/tinyjoin">source</a>.</li></ul></section><section><h2 id="local-by-design">Local by design</h2><p>TinyJoin keeps your database in the browser. Your app reads and writes data locally, without waiting for a database server. Keep data in memory or save it across reloads with OPFS; tabs opening the same persistent database share access automatically.</p><p>Your app can keep working when the network drops. Apps created with the starter can also <a href="https://tinyjoin.org/guides/offline/">reopen offline</a> once their production build has been cached.</p></section><section id="warning" aria-labelledby="an-important-warning"><h2 id="an-important-warning">An important warning!</h2><p>TinyJoin is experimental, with a bounded SQL dialect and no built-in remote synchronization. Browser storage can be lost, so use it for data you can reconstruct. Read the <a href="https://tinyjoin.org/guides/caveats/">caveats</a> and <a href="https://tinyjoin.org/guides/sql-compatibility/">SQL compatibility guide</a> to check whether this project currently fits your app. We&#x27;re working on it though, so keep checking back!</p></section><hr><section id="family"><h2 id="meet-the-family">Meet the family</h2><p>TinyJoin is one of a group of small libraries that make rich client and local-first apps easier to build. Take a look at the others!</p><ul><li><a href="https://tinybase.org/"><img src="https://tinybase.org/favicon.svg?asImg" alt="" width="40" height="40"> <b>TinyBase</b> </a>A reactive data store with persistence and synchronization.</li><li><a href="https://synclets.org/"><img src="https://synclets.org/favicon.svg?asImg" alt="" width="40" height="40"> <b>Synclets</b> </a>An open, storage-agnostic sync engine development kit.</li><li><a href="https://tinywidgets.org/"><img src="https://tinywidgets.org/favicon.svg?asImg" alt="" width="40" height="40"> <b>TinyWidgets</b> </a>A collection of tiny, reusable UI components.</li><li><a href="https://tinytick.org/"><img src="https://tinytick.org/favicon.svg?asImg" alt="" width="40" height="40"> <b>TinyTick</b> </a>A tiny but very useful task orchestrator.</li></ul></section>

‎docs/api/all.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,4 +91,4 @@
9191
<span class="keyword">import</span> <span class="punctuation">{</span>tinyjoinOffline<span class="punctuation">}</span> <span class="keyword">from</span> <span class="string">'tinyjoin/vite'</span><span class="punctuation">;</span>
9292

9393
<span class="keyword">export</span> <span class="keyword">default</span> <span class="function">defineConfig</span><span class="punctuation">(</span><span class="punctuation">{</span>plugins<span class="operator">:</span> <span class="punctuation">[</span><span class="function"><a href="#/api/vite/functions/offline/tinyjoinoffline/">tinyjoinOffline</a></span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">]</span><span class="punctuation">}</span><span class="punctuation">)</span><span class="punctuation">;</span>
94-
</code></pre></section><section class="s6"><h6>Since</h6><p>v0.0.6</p></section></section></section></section></section></section></article><aside aria-hidden="true"></aside></main><footer><nav><a id="gh" href="https://github.com/tinyplex/tinyjoin" target="_blank" rel="noreferrer">GitHub</a></nav><nav><a href="/">TinyJoin</a> © 2026 James Pearce</nav></footer><script>window.dataLayer=window.dataLayer||[];function g(){dataLayer.push(arguments);}g('js',new Date());g('config','G-40B96SPQX2');</script></body></html>
94+
</code></pre></section><section class="s6"><h6>Since</h6><p>v0.0.6</p></section></section></section></section></section></section></article><aside aria-hidden="true"></aside></main><footer><nav><a id="gh" href="https://github.com/tinyplex/tinyjoin" target="_blank" rel="noreferrer">GitHub</a></nav><nav><a href="/">TinyJoin</a> © 2026 James Pearce. MIT License.</nav></footer><script>window.dataLayer=window.dataLayer||[];function g(){dataLayer.push(arguments);}g('js',new Date());g('config','G-40B96SPQX2');</script></body></html>

‎docs/api/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="preload" as="image" href="/favicon.svg"><script async="" src="https://www.googletagmanager.com/gtag/js?id=G-40B96SPQX2"></script><link rel="dns-prefetch" href="https://www.googletagmanager.com/"><link href="https://www.googletagmanager.com/gtag/js?id=G-40B96SPQX2" 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"><title>API | TinyJoin</title><meta name="description" content="A tiny, worker-first relational database for browser apps."><meta property="og:type" content="website"><meta property="og:title" content="API | TinyJoin"><meta property="og:description" content="A tiny, worker-first relational database for browser apps."><meta property="og:url" content="https://tinyjoin.org/api/"><link rel="canonical" href="https://tinyjoin.org/api/"><link rel="icon" type="image/svg+xml" href="/favicon.svg"><link rel="stylesheet" href="/css/index.css"><script src="/js/site.js"></script></head><body><a class="skip" href="#content">Skip to content</a><header><a class="wordmark" href="/"><img src="/favicon.svg" alt="TinyJoin logo"><span>Tiny<em>Join</em></span></a><nav aria-label="Primary"><ul><li><a href="/guides/">Guides</a></li><li><a href="/demos/">Demos</a></li><li><a href="/api/" aria-current="page">API</a></li><li><a href="https://github.com/tinyplex/tinyjoin">GitHub</a></li></ul></nav><button id="dark" class="auto" type="button" aria-label="Color theme: automatic; activate for dark"></button></header><main><nav aria-label="Documentation"><ul><li id="root" class="parent open"><span></span><a href="/" aria-current="true">TinyJoin</a><ul><li id="G" class="parent"><span></span><a href="/guides/">Guides</a></li><li id="D" class="parent"><span></span><a href="/demos/">Demos</a></li><li id="api" class="current parent open"><span></span><a href="/api/" aria-current="page">API</a><ul><li id="e" class="parent"><span></span><a href="/api/the-essentials/">The Essentials</a></li><li id="t" class="parent"><span></span><a href="/api/tinyjoin/"><code>tinyjoin</code></a></li><li id="w2" class="parent"><span></span><a href="/api/worker/"><code>worker</code></a></li><li id="v" class="parent"><span></span><a href="/api/vite/"><code>vite</code></a></li></ul></li></ul></li></ul></nav><article id="content" tabindex="-1"><nav class="breadcrumbs" aria-label="Breadcrumbs"><ul><li><a href="/" aria-current="true">TinyJoin</a></li><li><a href="/api/" aria-current="page">API</a></li></ul></nav><section class="s1" id="/api/" data-id="api"><h1>API</h1><section class="s2" id="/api/the-essentials/" data-id="e"><h2>The Essentials</h2><ul><li><a href="/api/the-essentials/using-a-database/create/"><code>create</code></a></li><li><a href="/api/the-essentials/using-a-database/exec/"><code>exec</code></a></li><li><a href="/api/the-essentials/using-a-database/query/"><code>query</code></a></li><li><a href="/api/the-essentials/using-a-database/sql/"><code>sql</code></a></li><li><a href="/api/the-essentials/using-a-database/transaction/"><code>transaction</code></a></li></ul></section><section class="s2" id="/api/tinyjoin/" data-id="t"><h2><code>tinyjoin</code></h2><p>The <code>tinyjoin</code> module provides a small PostgreSQL-shaped relational database that runs in a dedicated browser Worker and stores data in memory or OPFS. <a href="/api/tinyjoin/">Read more</a>.</p><ul><li><a href="/api/tinyjoin/classes/">Classes</a></li><li><a href="/api/tinyjoin/interfaces/">Interfaces</a></li><li><a href="/api/tinyjoin/functions/">Functions</a></li><li><a href="/api/tinyjoin/type-aliases/">Type Aliases</a></li></ul></section><section class="s2" id="/api/worker/" data-id="w2"><h2><code>worker</code></h2><p>The <code>worker</code> module lets advanced applications start TinyJoin inside a Worker that they construct and bundle themselves. <a href="/api/worker/">Read more</a>.</p><ul><li><a href="/api/worker/functions/">Functions</a></li></ul></section><section class="s2" id="/api/vite/" data-id="v"><h2><code>vite</code></h2><p>The <code>vite</code> module provides optional production offline caching for Vite applications, including TinyJoin&#x27;s lazily loaded Worker, OPFS, and WASM files. This Node-only build integration is separate from the browser runtime. <a href="/api/vite/">Read more</a>.</p><ul><li><a href="/api/vite/interfaces/">Interfaces</a></li><li><a href="/api/vite/functions/">Functions</a></li></ul></section></section></article><aside aria-hidden="true"></aside></main><footer><nav><a id="gh" href="https://github.com/tinyplex/tinyjoin" target="_blank" rel="noreferrer">GitHub</a></nav><nav><a href="/">TinyJoin</a> © 2026 James Pearce</nav></footer><script>window.dataLayer=window.dataLayer||[];function g(){dataLayer.push(arguments);}g('js',new Date());g('config','G-40B96SPQX2');</script></body></html>
1+
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="preload" as="image" href="/favicon.svg"><script async="" src="https://www.googletagmanager.com/gtag/js?id=G-40B96SPQX2"></script><link rel="dns-prefetch" href="https://www.googletagmanager.com/"><link href="https://www.googletagmanager.com/gtag/js?id=G-40B96SPQX2" 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"><title>API | TinyJoin</title><meta name="description" content="A tiny, worker-first relational database for browser apps."><meta property="og:type" content="website"><meta property="og:title" content="API | TinyJoin"><meta property="og:description" content="A tiny, worker-first relational database for browser apps."><meta property="og:url" content="https://tinyjoin.org/api/"><link rel="canonical" href="https://tinyjoin.org/api/"><link rel="icon" type="image/svg+xml" href="/favicon.svg"><link rel="stylesheet" href="/css/index.css"><script src="/js/site.js"></script></head><body><a class="skip" href="#content">Skip to content</a><header><a class="wordmark" href="/"><img src="/favicon.svg" alt="TinyJoin logo"><span>Tiny<em>Join</em></span></a><nav aria-label="Primary"><ul><li><a href="/guides/">Guides</a></li><li><a href="/demos/">Demos</a></li><li><a href="/api/" aria-current="page">API</a></li><li><a href="https://github.com/tinyplex/tinyjoin">GitHub</a></li></ul></nav><button id="dark" class="auto" type="button" aria-label="Color theme: automatic; activate for dark"></button></header><main><nav aria-label="Documentation"><ul><li id="root" class="parent open"><span></span><a href="/" aria-current="true">TinyJoin</a><ul><li id="G" class="parent"><span></span><a href="/guides/">Guides</a></li><li id="D" class="parent"><span></span><a href="/demos/">Demos</a></li><li id="api" class="current parent open"><span></span><a href="/api/" aria-current="page">API</a><ul><li id="e" class="parent"><span></span><a href="/api/the-essentials/">The Essentials</a></li><li id="t" class="parent"><span></span><a href="/api/tinyjoin/"><code>tinyjoin</code></a></li><li id="w2" class="parent"><span></span><a href="/api/worker/"><code>worker</code></a></li><li id="v" class="parent"><span></span><a href="/api/vite/"><code>vite</code></a></li></ul></li></ul></li></ul></nav><article id="content" tabindex="-1"><nav class="breadcrumbs" aria-label="Breadcrumbs"><ul><li><a href="/" aria-current="true">TinyJoin</a></li><li><a href="/api/" aria-current="page">API</a></li></ul></nav><section class="s1" id="/api/" data-id="api"><h1>API</h1><section class="s2" id="/api/the-essentials/" data-id="e"><h2>The Essentials</h2><ul><li><a href="/api/the-essentials/using-a-database/create/"><code>create</code></a></li><li><a href="/api/the-essentials/using-a-database/exec/"><code>exec</code></a></li><li><a href="/api/the-essentials/using-a-database/query/"><code>query</code></a></li><li><a href="/api/the-essentials/using-a-database/sql/"><code>sql</code></a></li><li><a href="/api/the-essentials/using-a-database/transaction/"><code>transaction</code></a></li></ul></section><section class="s2" id="/api/tinyjoin/" data-id="t"><h2><code>tinyjoin</code></h2><p>The <code>tinyjoin</code> module provides a small PostgreSQL-shaped relational database that runs in a dedicated browser Worker and stores data in memory or OPFS. <a href="/api/tinyjoin/">Read more</a>.</p><ul><li><a href="/api/tinyjoin/classes/">Classes</a></li><li><a href="/api/tinyjoin/interfaces/">Interfaces</a></li><li><a href="/api/tinyjoin/functions/">Functions</a></li><li><a href="/api/tinyjoin/type-aliases/">Type Aliases</a></li></ul></section><section class="s2" id="/api/worker/" data-id="w2"><h2><code>worker</code></h2><p>The <code>worker</code> module lets advanced applications start TinyJoin inside a Worker that they construct and bundle themselves. <a href="/api/worker/">Read more</a>.</p><ul><li><a href="/api/worker/functions/">Functions</a></li></ul></section><section class="s2" id="/api/vite/" data-id="v"><h2><code>vite</code></h2><p>The <code>vite</code> module provides optional production offline caching for Vite applications, including TinyJoin&#x27;s lazily loaded Worker, OPFS, and WASM files. This Node-only build integration is separate from the browser runtime. <a href="/api/vite/">Read more</a>.</p><ul><li><a href="/api/vite/interfaces/">Interfaces</a></li><li><a href="/api/vite/functions/">Functions</a></li></ul></section></section></article><aside aria-hidden="true"></aside></main><footer><nav><a id="gh" href="https://github.com/tinyplex/tinyjoin" target="_blank" rel="noreferrer">GitHub</a></nav><nav><a href="/">TinyJoin</a> © 2026 James Pearce. MIT License.</nav></footer><script>window.dataLayer=window.dataLayer||[];function g(){dataLayer.push(arguments);}g('js',new Date());g('config','G-40B96SPQX2');</script></body></html>

0 commit comments

Comments
 (0)