TinyBase logoTinyBase

API

store

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

metrics

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

indexes

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

relationships

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

queries

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

checkpoints

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

common

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

persisters

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

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.

persister-browser

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

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).

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).

persister-expo-sqlite

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

persister-expo-sqlite-next

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

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).

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.

persister-partykit-client

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

persister-partykit-server

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

persister-remote

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

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).

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).

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.

tools

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

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.

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.