API

`store`

The store module is the core of the TinyBase project and contains the types, interfaces, and functions to work with Store objects. Read more.

`mergeable-store`

The mergeable-store module contains the types, interfaces, and functions to work with MergeableStore objects, which provide merge and synchronization functionality. Read more.

`metrics`

The metrics module of the TinyBase project provides the ability to create and track metrics and aggregates of the data in Store objects. Read more.

`indexes`

The indexes module of the TinyBase project provides the ability to create and track indexes of the data in Store objects. Read more.

`relationships`

The relationships module of the TinyBase project provides the ability to create and track relationships between the data in Store objects. Read more.

`queries`

The queries module of the TinyBase project provides the ability to create and track queries of the data in Store objects. Read more.

`checkpoints`

The checkpoints module of the TinyBase project provides the ability to create and track checkpoints made to the data in Store objects. Read more.

`common`

The common module of the TinyBase project provides a small collection of common types used across other modules. Read more.

`persisters`

The persisters module of the TinyBase project provides a simple framework for saving and loading Store and MergeableStore data, to and from different destinations, or underlying storage types. Read more.

`persister-automerge`

The persister-automerge module of the TinyBase project provides a way to save and load Store data to and from an Automerge document. Read more.

AutomergePersister interface
createAutomergePersister function

`persister-browser`

The persister-browser module of the TinyBase project lets you save and load Store data to and from browser storage. Read more.

`persister-cr-sqlite-wasm`

The persister-cr-sqlite-wasm module of the TinyBase project lets you save and load Store data to and from a local CR-SQLite database (in an appropriate environment). Read more.

CrSqliteWasmPersister interface
createCrSqliteWasmPersister function

`persister-durable-object-storage`

The persister-durable-object-storage module of the TinyBase project lets you save and load Store data to and from Cloudflare Durable Object storage (in an appropriate environment). Read more.

DurableObjectStoragePersister interface
createDurableObjectStoragePersister function

`persister-electric-sql`

The persister-electric-sql module of the TinyBase project lets you save and load Store data to and from a local ElectricSQL database (in an appropriate environment). Read more.

ElectricSqlPersister interface
createElectricSqlPersister function

`persister-expo-sqlite`

The persister-expo-sqlite module of the TinyBase project lets you save and load Store data to and from a Expo-SQLite database (in an appropriate React Native environment). Read more.

ExpoSqlitePersister interface
createExpoSqlitePersister function

`persister-file`

The persister-file module of the TinyBase project lets you save and load Store data to and from a local file system (in an appropriate environment). Read more.

FilePersister interface
createFilePersister function

`persister-indexed-db`

The persister-indexed-db module of the TinyBase project lets you save and load Store data to and from browser IndexedDB storage. Read more.

IndexedDbPersister interface
createIndexedDbPersister function

`persister-libsql`

The persister-libsql module of the TinyBase project lets you save and load Store data to and from a local LibSQL database (in an appropriate environment). Read more.

LibSqlPersister interface
createLibSqlPersister function

`persister-partykit-client`

The persister-partykit-client module of the TinyBase project contains the client portion of the PartyKit integration. Read more.

`persister-partykit-server`

The persister-partykit-server module of the TinyBase project contains the server portion of the PartyKit integration. Read more.

TinyBasePartyKitServer class
Functions
TinyBasePartyKitServerConfig type alias

`persister-pglite`

The persister-pglite module of the TinyBase project lets you save and load Store data to and from a PGlite database (in an appropriate environment). Read more.

PglitePersister interface
createPglitePersister function

`persister-postgres`

The persister-postgres module of the TinyBase project lets you save and load Store data to and from a PostgreSQL database (in an appropriate environment). Read more.

PostgresPersister interface
createPostgresPersister function

`persister-powersync`

The persister-powersync module of the TinyBase project lets you save and load Store data to and from a local SQLite database that is automatically synced using the PowerSync service. Read more.

PowerSyncPersister interface
createPowerSyncPersister function

`persister-remote`

The persister-remote module of the TinyBase project lets you save and load Store data to and from a remote server. Read more.

RemotePersister interface
createRemotePersister function

`persister-sqlite-wasm`

The persister-sqlite-wasm module of the TinyBase project lets you save and load Store data to and from a local SQLite database (in an appropriate environment). Read more.

SqliteWasmPersister interface
createSqliteWasmPersister function

`persister-sqlite3`

The persister-sqlite3 module of the TinyBase project lets you save and load Store data to and from a local SQLite database (in an appropriate environment). Read more.

Sqlite3Persister interface
createSqlite3Persister function

`persister-yjs`

The persister-yjs module of the TinyBase project provides a way to save and load Store data to and from a Yjs document. Read more.

YjsPersister interface
createYjsPersister function

`synchronizers`

The synchronizers module of the TinyBase project lets you synchronize MergeableStore data to and from other MergeableStore instances. Read more.

`synchronizer-broadcast-channel`

The synchronizer-broadcast-channel module of the TinyBase project lets you synchronize MergeableStore data to and from other MergeableStore instances via a browser's BroadcastChannel API. Read more.

BroadcastChannelSynchronizer interface
createBroadcastChannelSynchronizer function

`synchronizer-local`

The synchronizer-local module of the TinyBase project lets you synchronize MergeableStore data to and from other MergeableStore instances on the same local machine. Read more.

LocalSynchronizer interface
createLocalSynchronizer function

`synchronizer-ws-client`

The synchronizer-ws module of the TinyBase project lets you synchronize MergeableStore data to and from other MergeableStore instances via WebSockets facilitated by a server. Read more.

`synchronizer-ws-server`

The synchronizer-ws-server module of the TinyBase project lets you create a server that facilitates synchronization between clients. Read more.

`synchronizer-ws-server-durable-object`

The synchronizer-ws-server-durable-object module of the TinyBase project lets you create a server that facilitates synchronization between clients, running as a Cloudflare Durable Object. Read more.

WsServerDurableObject class
getWsServerDurableObjectFetch function

`synchronizer-ws-server-simple`

The synchronizer-ws-server-simple module of the TinyBase project lets you create a server that facilitates synchronization between clients, without the complications of listeners, persistence, or statistics. Read more.

WsServerSimple interface
createWsServerSimple function

`tools`

The tools module of the TinyBase project provides utilities for working with TinyBase during development. Read more.

`ui-react`

The ui-react module of the TinyBase project provides both hooks and components to make it easy to create reactive apps with Store objects. Read more.

`ui-react-dom`

The ui-react-dom module of the TinyBase project provides components to make it easy to create web-based reactive apps with Store objects. Read more.

`ui-react-inspector`

The ui-react-inspector module of the TinyBase project provides a component to help debug the state of your TinyBase stores and other objects. Read more.

Inspector function
InspectorProps type alias