API

The Essentials

• Creating stores
• Getting data
• Setting data
• Listening for changes
• Persisting stores
• Synchronizing stores
• Using React
• Inspector function

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.

• Store interface
• createStore function
• Type Aliases

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.

• MergeableStore interface
• createMergeableStore function
• Type Aliases

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.

• Metrics interface
• createMetrics function
• Type Aliases

indexes

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

• Indexes interface
• createIndexes function
• Type Aliases

relationships

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

• Relationships interface
• createRelationships function
• Type Aliases

queries

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

• Queries interface
• createQueries function
• Type Aliases

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.

• Checkpoints interface
• createCheckpoints function
• Type Aliases

common

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

• Functions
• Type Aliases

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 interface
• Enumerations
• Functions
• Type Aliases

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, including the origin private file system (OPFS). Read more.

• Interfaces
• Functions

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-sql-storage

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

• DurableObjectSqlStoragePersister interface
• createDurableObjectSqlStoragePersister function
• Type Aliases

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.

• PartyKitPersister interface
• createPartyKitPersister function
• PartyKitPersisterConfig type alias

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-react-native-mmkv

The persister-react-native-mmkv module of the TinyBase project lets you save and load Store data to and from a MMKV storage using the react-native-mmkv module (in an appropriate React Native environment). Read more.

• ReactNativeMmkvPersister interface
• createReactNativeMmkvPersister function

persister-react-native-sqlite

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

• ReactNativeSqlitePersister interface
• createReactNativeSqlitePersister 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-bun

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

• SqliteBunPersister interface
• createSqliteBunPersister 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 interface
• Message enumeration
• createCustomSynchronizer function
• Type Aliases

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.

• WsSynchronizer interface
• createWsSynchronizer function
• WebSocketTypes type alias

synchronizer-ws-server

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

• WsServer interface
• createWsServer function
• Type Aliases

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

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.

• Functions
• Type Aliases

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.

• Functions
• Type Aliases

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

ui-svelte

The ui-svelte module of the TinyBase project provides reactive functions, listener functions, and components to make it easy to create reactive Svelte 5 apps with Store objects. Read more.

• Functions
• Type Aliases

ui-svelte-dom

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

• Functions
• Type Aliases

ui-svelte-inspector

The ui-svelte-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

middleware

The middleware module of the TinyBase project provides the ability to intercept and validate incoming writes to Store objects. Read more.

• Middleware interface
• createMiddleware function
• Type Aliases

schematizer-arktype

The schematizer-arktype module provides conversion utilities for ArkType schemas. Read more.

• ArkTypeSchematizer interface
• createArkTypeSchematizer function

schematizer-effect

The schematizer-effect module provides conversion utilities for Effect Schema schemas. Read more.

• EffectSchematizer interface
• createEffectSchematizer function

schematizer-typebox

The schematizer-typebox module provides conversion utilities for TypeBox schemas. Read more.

• TypeBoxSchematizer interface
• createTypeBoxSchematizer function

schematizer-valibot

The schematizer-valibot module provides conversion utilities for Valibot schemas. Read more.

• ValibotSchematizer interface
• createValibotSchematizer function

schematizer-yup

The schematizer-yup module provides conversion utilities for Yup schemas. Read more.

• YupSchematizer interface
• createYupSchematizer function

schematizer-zod

The schematizer-zod module provides conversion utilities for Zod schemas. Read more.

• ZodSchematizer interface
• createZodSchematizer function

schematizers

The schematizers module provides utilities for converting schemas from popular validation libraries into TinyBase's schema format. Read more.

• Schematizer interface
• createCustomSchematizer function