+<nav><ul><li><a href="/">TinyBase</a></li><li><a href="/api/">API</a></li><li><a href="/api/persisters/"><code>persisters</code></a></li></ul></nav><section class="s1" id="/api/persisters/" data-id="p"><h1><code>persisters</code></h1><p>The <code>persisters</code> module of the <a href="/">TinyBase</a> project provides a simple framework for saving and loading <a href="/api/store/interfaces/store/store/"><code>Store</code></a> data, to and from different destinations, or underlying storage types.</p><p>Several entry points are provided (in separately installed modules), each of which returns a new <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a> object that can load and save a <a href="/api/store/interfaces/store/store/"><code>Store</code></a>. Between them, these allow you to store your <a href="/">TinyBase</a> data locally, remotely, to SQLite databases, and across synchronization boundaries with CRDT frameworks.</p><div class="table"><table><thead><tr><th>Module</th><th>Function</th><th>Storage</th></tr></thead><tbody><tr><td><a href="/api/persister-browser/"><code>persister-browser</code></a></td><td><a href="/api/persister-browser/functions/creation/createsessionpersister/"><code>createSessionPersister</code></a></td><td>Browser session storage</td></tr><tr><td><a href="/api/persister-browser/"><code>persister-browser</code></a></td><td><a href="/api/persister-browser/functions/creation/createlocalpersister/"><code>createLocalPersister</code></a></td><td>Browser local storage</td></tr><tr><td><a href="/api/persister-remote/"><code>persister-remote</code></a></td><td><a href="/api/persister-remote/functions/creation/createremotepersister/"><code>createRemotePersister</code></a></td><td>Remote server</td></tr><tr><td><a href="/api/persister-file/"><code>persister-file</code></a></td><td><a href="/api/persister-file/functions/creation/createfilepersister/"><code>createFilePersister</code></a></td><td>Local file (where possible)</td></tr><tr><td><a href="/api/persister-sqlite3/"><code>persister-sqlite3</code></a></td><td><a href="/api/persister-sqlite3/functions/creation/createsqlite3persister/"><code>createSqlite3Persister</code></a></td><td>SQLite in Node, via <a href="https://github.com/TryGhost/node-sqlite3">sqlite3</a></td></tr><tr><td><a href="/api/persister-sqlite-wasm/"><code>persister-sqlite-wasm</code></a></td><td><a href="/api/persister-sqlite-wasm/functions/creation/createsqlitewasmpersister/"><code>createSqliteWasmPersister</code></a></td><td>SQLite in a browser, via <a href="https://github.com/tomayac/sqlite-wasm">sqlite-wasm</a></td></tr><tr><td><a href="/api/persister-cr-sqlite-wasm/"><code>persister-cr-sqlite-wasm</code></a></td><td><a href="/api/persister-cr-sqlite-wasm/functions/creation/createcrsqlitewasmpersister/"><code>createCrSqliteWasmPersister</code></a></td><td>SQLite CRDTs, via <a href="https://github.com/vlcn-io/cr-sqlite">cr-sqlite-wasm</a></td></tr><tr><td><a href="/api/persister-expo-sqlite/"><code>persister-expo-sqlite</code></a></td><td><a href="/api/persister-expo-sqlite/functions/creation/createexposqlitepersister/"><code>createExpoSqlitePersister</code></a></td><td>SQLite in React Native, via <a href="https://github.com/expo/expo/tree/main/packages/expo-sqlite">expo-sqlite</a></td></tr><tr><td><a href="/api/persister-yjs/"><code>persister-yjs</code></a></td><td><a href="/api/persister-yjs/functions/creation/createyjspersister/"><code>createYjsPersister</code></a></td><td>Yjs CRDTs, via <a href="https://github.com/yjs/yjs">yjs</a></td></tr><tr><td><a href="/api/persister-automerge/"><code>persister-automerge</code></a></td><td><a href="/api/persister-sqlite-wasm/functions/creation/createsqlitewasmpersister/"><code>createSqliteWasmPersister</code></a></td><td>Automerge CRDTs, via <a href="https://github.com/automerge/automerge-repo">automerge-repo</a></td></tr></tbody></table></div><p>Since persistence requirements can be different for every app, the <a href="/api/persisters/functions/creation/createcustompersister/"><code>createCustomPersister</code></a> function in this module can also be used to easily create a fully customized way to save and load <a href="/api/store/interfaces/store/store/"><code>Store</code></a> data.</p><section class="s2"><h2>See also</h2><p><a href="/guides/schemas-and-persistence/persisting-data/">Persisting Data</a> guide</p><p><a href="/guides/schemas-and-persistence/database-persistence/">Database Persistence</a> guide</p><p><a href="/guides/schemas-and-persistence/synchronizing-data/">Synchronizing Data</a> guide</p><p><a href="/demos/countries/">Countries</a> demo</p><p><a href="/demos/todo-app/">Todo App</a> demos</p><p><a href="/demos/drawing/">Drawing</a> demo</p></section><section class="s2" id="/api/persisters/interfaces/" data-id="p/I20"><h2><a href="/api/persisters/interfaces/">Interfaces</a></h2><p>There is one interface, <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a>, within the <a href="/api/persisters/"><code>persisters</code></a> module.</p><ul><li><a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a></li></ul></section><section class="s2" id="/api/persisters/functions/" data-id="p/F8"><h2><a href="/api/persisters/functions/">Functions</a></h2><p>There is one function, <a href="/api/persisters/functions/creation/createcustompersister/"><code>createCustomPersister</code></a>, within the <a href="/api/persisters/"><code>persisters</code></a> module.</p><ul><li><a href="/api/persisters/functions/creation/createcustompersister/"><code>createCustomPersister</code></a></li></ul></section><section class="s2" id="/api/persisters/type-aliases/" data-id="p/TA14"><h2><a href="/api/persisters/type-aliases/">Type Aliases</a></h2><p>These are the type aliases within the <a href="/api/persisters/"><code>persisters</code></a> module.</p><ul><li><a href="/api/persisters/type-aliases/configuration/">Configuration type aliases</a></li><li><a href="/api/persisters/type-aliases/creation/">Creation type aliases</a></li><li><a href="/api/persisters/type-aliases/development/">Development type aliases</a></li></ul></section></section>
0 commit comments