tinybase 5.0.0-beta.17 → 5.0.0-beta.18

package/lib/types/persisters/persister-partykit-server.d.ts

@@ -47,7 +47,9 @@ import {Id} from '../common.d.ts';
  * in the room.
  *
  * ```js
- * class MyServer extends TinyBasePartyKitServer {
+ * import {TinyBasePartyKitServer} from 'tinybase/persisters/persister-partykit-server';
+ *
+ * export class MyServer extends TinyBasePartyKitServer {
  *   readonly config = {
  *     storePath: '/my_tinybase',
  *     storagePrefix: 'tinybase_',
@@ -112,9 +114,10 @@ export type TinyBasePartyKitServerConfig = {
  * the constructor if you choose to implement that.
  *
  * ```js
- * // This is your PartyKit server entry point.
+ * import {TinyBasePartyKitServer} from 'tinybase/persisters/persister-partykit-server';
  *
- * class MyServer extends TinyBasePartyKitServer {
+ * // This is your PartyKit server entry point.
+ * export class MyServer extends TinyBasePartyKitServer {
  *   constructor(party) {
  *     super(party);
  *     // custom constructor code
@@ -168,7 +171,9 @@ export class TinyBasePartyKitServer implements Server {
    * synchronization stays supported:
    *
    * ```js
-   * class MyServer extends TinyBasePartyKitServer {
+   * import {TinyBasePartyKitServer} from 'tinybase/persisters/persister-partykit-server';
+   *
+   * export class MyServer extends TinyBasePartyKitServer {
    *   async onRequest(request) {
    *     // custom onRequest code, else:
    *     return await super.onRequest(request);
@@ -192,7 +197,9 @@ export class TinyBasePartyKitServer implements Server {
    * synchronization stays supported:
    *
    * ```js
-   * class MyServer extends TinyBasePartyKitServer {
+   * import {TinyBasePartyKitServer} from 'tinybase/persisters/persister-partykit-server';
+   *
+   * export class MyServer extends TinyBasePartyKitServer {
    *   async onMessage(message, connection) {
    *     await super.onMessage(message, connection);
    *     // custom onMessage code
@@ -239,7 +246,9 @@ export class TinyBasePartyKitServer implements Server {
    * update any 'user' tabular data after the initial save:
    *
    * ```js
-   * class MyServer extends TinyBasePartyKitServer {
+   * import {TinyBasePartyKitServer} from 'tinybase/persisters/persister-partykit-server';
+   *
+   * export class MyServer extends TinyBasePartyKitServer {
    *   canSetTable(tableId, initialSave) {
    *     return initialSave || tableId != 'user';
    *   }
@@ -275,7 +284,9 @@ export class TinyBasePartyKitServer implements Server {
    * delete the 'user' Table:
    *
    * ```js
-   * class MyServer extends TinyBasePartyKitServer {
+   * import {TinyBasePartyKitServer} from 'tinybase/persisters/persister-partykit-server';
+   *
+   * export class MyServer extends TinyBasePartyKitServer {
    *   canDelTable(tableId) {
    *     return tableId != 'user';
    *   }
@@ -313,7 +324,9 @@ export class TinyBasePartyKitServer implements Server {
    * update the 'me' Row of the 'user' Table after the initial save:
    *
    * ```js
-   * class MyServer extends TinyBasePartyKitServer {
+   * import {TinyBasePartyKitServer} from 'tinybase/persisters/persister-partykit-server';
+   *
+   * export class MyServer extends TinyBasePartyKitServer {
    *   canSetRow(tableId, rowId, initialSave) {
    *     return initialSave || tableId != 'user' || rowId != 'me';
    *   }
@@ -351,7 +364,9 @@ export class TinyBasePartyKitServer implements Server {
    * delete the 'me' Row of the 'user' Table:
    *
    * ```js
-   * class MyServer extends TinyBasePartyKitServer {
+   * import {TinyBasePartyKitServer} from 'tinybase/persisters/persister-partykit-server';
+   *
+   * export class MyServer extends TinyBasePartyKitServer {
    *   canDelRow(tableId, rowId) {
    *     return tableId != 'user' || rowId != 'me';
    *   }
@@ -390,7 +405,9 @@ export class TinyBasePartyKitServer implements Server {
    * initial save:
    *
    * ```js
-   * class MyServer extends TinyBasePartyKitServer {
+   * import {TinyBasePartyKitServer} from 'tinybase/persisters/persister-partykit-server';
+   *
+   * export class MyServer extends TinyBasePartyKitServer {
    *   canSetCell(tableId, rowId, cellId, cell, initialSave) {
    *     return (
    *       initialSave || tableId != 'user' || rowId != 'me' || cellId != 'name'
@@ -433,7 +450,9 @@ export class TinyBasePartyKitServer implements Server {
    * delete the 'name' Cell of the 'me' Row of the 'user' Table:
    *
    * ```js
-   * class MyServer extends TinyBasePartyKitServer {
+   * import {TinyBasePartyKitServer} from 'tinybase/persisters/persister-partykit-server';
+   *
+   * export class MyServer extends TinyBasePartyKitServer {
    *   canDelCell(tableId, rowId, cellId) {
    *     return tableId != 'user' || rowId != 'me' || cellId != 'name';
    *   }
@@ -479,9 +498,11 @@ export class TinyBasePartyKitServer implements Server {
    * update the 'userId' Value after the initial save:
    *
    * ```js
-   * class MyServer extends TinyBasePartyKitServer {
+   * import {TinyBasePartyKitServer} from 'tinybase/persisters/persister-partykit-server';
+   *
+   * export class MyServer extends TinyBasePartyKitServer {
    *   canSetValue(valueId, value, initialSave) {
-   *     return initialSave || userId != 'userId';
+   *     return initialSave || valueId != 'userId';
    *   }
    * }
    * ```
@@ -517,7 +538,9 @@ export class TinyBasePartyKitServer implements Server {
    * delete the 'userId' Value:
    *
    * ```js
-   * class MyServer extends TinyBasePartyKitServer {
+   * import {TinyBasePartyKitServer} from 'tinybase/persisters/persister-partykit-server';
+   *
+   * export class MyServer extends TinyBasePartyKitServer {
    *   canDelValue(valueId) {
    *     return valueId != 'userId';
    *   }

package/lib/types/persisters/persister-powersync.d.ts

@@ -33,7 +33,11 @@ export interface PowerSyncPersister extends Persister {
    * then gets the PowerSync instance back out again.
    *
    * ```js yolo
-   * const ps = `usePowerSync`();
+   * import {createPowerSyncPersister} from 'tinybase/persisters/persister-powersync';
+   * import {createStore} from 'tinybase';
+   * import {usePowerSync} from '@journeyapps/powersync-react';
+   *
+   * const ps = usePowerSync();
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const persister = createPowerSyncPersister(store, ps, 'my_tinybase');
    *
@@ -86,6 +90,10 @@ export interface PowerSyncPersister extends Persister {
  * Store.
  *
  * ```js yolo
+ * import {createPowerSyncPersister} from 'tinybase/persisters/persister-powersync';
+ * import {createStore} from 'tinybase';
+ * import {usePowerSync} from '@journeyapps/powersync-react';
+ *
  * const ps = usePowerSync();
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = createPowerSyncPersister(store, ps, 'my_tinybase');
@@ -118,6 +126,10 @@ export interface PowerSyncPersister extends Persister {
  * local PowerSync instance with tabular mapping.
  *
  * ```js yolo
+ * import {createPowerSyncPersister} from 'tinybase/persisters/persister-powersync';
+ * import {createStore} from 'tinybase';
+ * import {usePowerSync} from '@journeyapps/powersync-react';
+ *
  * const ps = usePowerSync();
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = createPowerSyncPersister(store, ps, {

package/lib/types/persisters/persister-remote.d.ts

@@ -30,6 +30,9 @@ export interface RemotePersister extends Persister {
    * and then gets the URLs back out again.
    *
    * ```js
+   * import {createRemotePersister} from 'tinybase/persisters/persister-remote';
+   * import {createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const persister = createRemotePersister(
    *   store,
@@ -80,6 +83,9 @@ export interface RemotePersister extends Persister {
  * remote server.
  *
  * ```js yolo
+ * import {createRemotePersister} from 'tinybase/persisters/persister-remote';
+ * import {createStore} from 'tinybase';
+ *
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = createRemotePersister(
  *   store,

package/lib/types/persisters/persister-sqlite-wasm.d.ts

@@ -9,6 +9,7 @@
  */
 
 import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
+import {MergeableStore} from '../mergeable-store.d.ts';
 import {Store} from '../store.d.ts';
 
 /**
@@ -33,6 +34,10 @@ export interface SqliteWasmPersister extends Persister<3> {
    * then gets the database instance back out again.
    *
    * ```js
+   * import {createSqliteWasmPersister} from 'tinybase/persisters/persister-sqlite-wasm';
+   * import {createStore} from 'tinybase';
+   * import sqlite3InitModule from '@sqlite.org/sqlite-wasm';
+   *
    * const sqlite3 = await sqlite3InitModule();
    * const db = new sqlite3.oo1.DB(':memory:', 'c');
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
@@ -94,6 +99,10 @@ export interface SqliteWasmPersister extends Persister<3> {
  * Store.
  *
  * ```js
+ * import {createSqliteWasmPersister} from 'tinybase/persisters/persister-sqlite-wasm';
+ * import {createStore} from 'tinybase';
+ * import sqlite3InitModule from '@sqlite.org/sqlite-wasm';
+ *
  * const sqlite3 = await sqlite3InitModule();
  * const db = new sqlite3.oo1.DB(':memory:', 'c');
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
@@ -125,6 +134,10 @@ export interface SqliteWasmPersister extends Persister<3> {
  * local SQLite database with tabular mapping.
  *
  * ```js
+ * import {createSqliteWasmPersister} from 'tinybase/persisters/persister-sqlite-wasm';
+ * import {createStore} from 'tinybase';
+ * import sqlite3InitModule from '@sqlite.org/sqlite-wasm';
+ *
  * const sqlite3 = await sqlite3InitModule();
  * const db = new sqlite3.oo1.DB(':memory:', 'c');
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
@@ -148,7 +161,7 @@ export interface SqliteWasmPersister extends Persister<3> {
  * @since v4.0.0
  */
 export function createSqliteWasmPersister(
-  store: Store,
+  store: Store | MergeableStore,
   sqlite3: any,
   db: any,
   configOrStoreTableName?: DatabasePersisterConfig | string,

package/lib/types/persisters/persister-sqlite3.d.ts

@@ -10,6 +10,7 @@
 
 import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
 import {Database} from 'sqlite3';
+import {MergeableStore} from '../mergeable-store.d.ts';
 import {Store} from '../store.d.ts';
 
 /**
@@ -34,7 +35,11 @@ export interface Sqlite3Persister extends Persister<3> {
    * then gets the database instance back out again.
    *
    * ```js
-   * const db = new sqlite3.Database(':memory:');
+   * import {Database} from 'sqlite3';
+   * import {createSqlite3Persister} from 'tinybase/persisters/persister-sqlite3';
+   * import {createStore} from 'tinybase';
+   *
+   * const db = new Database(':memory:');
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const persister = createSqlite3Persister(store, db, 'my_tinybase');
    *
@@ -87,7 +92,11 @@ export interface Sqlite3Persister extends Persister<3> {
  * Store.
  *
  * ```js
- * const db = new sqlite3.Database(':memory:');
+ * import {Database} from 'sqlite3';
+ * import {createSqlite3Persister} from 'tinybase/persisters/persister-sqlite3';
+ * import {createStore} from 'tinybase';
+ *
+ * const db = new Database(':memory:');
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = createSqlite3Persister(store, db, 'my_tinybase');
  *
@@ -119,7 +128,11 @@ export interface Sqlite3Persister extends Persister<3> {
  * local SQLite database with tabular mapping.
  *
  * ```js
- * const db = new sqlite3.Database(':memory:');
+ * import {Database} from 'sqlite3';
+ * import {createSqlite3Persister} from 'tinybase/persisters/persister-sqlite3';
+ * import {createStore} from 'tinybase';
+ *
+ * const db = new Database(':memory:');
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = createSqlite3Persister(store, db, {
  *   mode: 'tabular',
@@ -150,7 +163,7 @@ export interface Sqlite3Persister extends Persister<3> {
  * @since v4.0.0
  */
 export function createSqlite3Persister(
-  store: Store,
+  store: Store | MergeableStore,
   db: Database,
   configOrStoreTableName?: DatabasePersisterConfig | string,
   onSqlCommand?: (sql: string, args?: any[]) => void,

package/lib/types/persisters/persister-yjs.d.ts

@@ -36,7 +36,11 @@ export interface YjsPersister extends Persister {
    * then gets the Yjs document back out again.
    *
    * ```js
-   * const doc = new Y.Doc();
+   * import {Doc} from 'yjs';
+   * import {createStore} from 'tinybase';
+   * import {createYjsPersister} from 'tinybase/persisters/persister-yjs';
+   *
+   * const doc = new Doc();
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const persister = createYjsPersister(store, doc);
    *
@@ -70,7 +74,11 @@ export interface YjsPersister extends Persister {
  * document.
  *
  * ```js
- * const doc = new Y.Doc();
+ * import {Doc} from 'yjs';
+ * import {createStore} from 'tinybase';
+ * import {createYjsPersister} from 'tinybase/persisters/persister-yjs';
+ *
+ * const doc = new Doc();
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = createYjsPersister(store, doc);
  *
@@ -93,14 +101,18 @@ export interface YjsPersister extends Persister {
  * function.
  *
  * ```js
- * const doc1 = new Y.Doc();
- * const doc2 = new Y.Doc();
+ * import {Doc, applyUpdate, encodeStateAsUpdate} from 'yjs';
+ * import {createStore} from 'tinybase';
+ * import {createYjsPersister} from 'tinybase/persisters/persister-yjs';
+ *
+ * const doc1 = new Doc();
+ * const doc2 = new Doc();
  *
  * // A function to manually synchronize documents with each other. Typically
  * // this would happen over the wire, via a Yjs connection provider.
  * const syncDocs = async () => {
- *   Y.applyUpdate(doc1, Y.encodeStateAsUpdate(doc2));
- *   Y.applyUpdate(doc2, Y.encodeStateAsUpdate(doc1));
+ *   applyUpdate(doc1, encodeStateAsUpdate(doc2));
+ *   applyUpdate(doc2, encodeStateAsUpdate(doc1));
  * };
  *
  * // Bind a persisted Store to each document.

package/lib/types/persisters.d.ts

@@ -160,7 +160,9 @@ export type PersisterStats = {
  * settings.
  *
  * ```js
- * const databasePersisterConfig: DatabasePersisterConfig = {
+ * import {DatabasePersisterConfig} from 'tinybase';
+ *
+ * export const databasePersisterConfig: DatabasePersisterConfig = {
  *   mode: 'json',
  *   storeTableName: 'my_tinybase',
  *   autoLoadIntervalSeconds: 2,
@@ -172,7 +174,9 @@ export type PersisterStats = {
  * mappings. See DpcTabular for more details on these settings.
  *
  * ```js
- * const databasePersisterConfig: DatabasePersisterConfig = {
+ * import {DatabasePersisterConfig} from 'tinybase';
+ *
+ * export const databasePersisterConfig: DatabasePersisterConfig = {
  *   mode: 'tabular',
  *   tables: {
  *     load: {petsInDb: 'pets', speciesInDb: 'species'},
@@ -215,7 +219,9 @@ export type DatabasePersisterConfig = DpcJson | DpcTabular;
  * and save a JSON serialization from and to a table called `tinybase_json`.
  *
  * ```js
- * const databasePersisterConfig: DatabasePersisterConfig = {
+ * import {DatabasePersisterConfig} from 'tinybase';
+ *
+ * export const databasePersisterConfig: DatabasePersisterConfig = {
  *   mode: 'json',
  *   storeTableName: 'tinybase_json',
  * };
@@ -273,7 +279,9 @@ export type DpcJson = {
  * For example:
  *
  * ```js
- * const databasePersisterConfig: DatabasePersisterConfig = {
+ * import {DatabasePersisterConfig} from 'tinybase';
+ *
+ * export const databasePersisterConfig: DatabasePersisterConfig = {
  *   mode: 'tabular',
  *   tables: {
  *     load: {petsInDb: 'pets', speciesInDb: 'species'},
@@ -294,7 +302,9 @@ export type DpcJson = {
  * mappings, and Values data from and to a table called `my_tinybase_values`.
  *
  * ```js
- * const databasePersisterConfig: DatabasePersisterConfig = {
+ * import {DatabasePersisterConfig} from 'tinybase';
+ *
+ * export const databasePersisterConfig: DatabasePersisterConfig = {
  *   mode: 'tabular',
  *   tables: {
  *     load: {petsInDb: 'pets', speciesInDb: 'species'},
@@ -368,7 +378,9 @@ export type DpcTabular = {
  * Id called 'id' and the other defaults it to '_id'.
  *
  * ```js
- * const databasePersisterConfig: DatabasePersisterConfig = {
+ * import {DatabasePersisterConfig} from 'tinybase';
+ *
+ * export const databasePersisterConfig: DatabasePersisterConfig = {
  *   mode: 'tabular',
  *   tables: {
  *     load: {
@@ -471,7 +483,9 @@ export type DpcTabularLoad = {
  * empty.
  *
  * ```js
- * const databasePersisterConfig: DatabasePersisterConfig = {
+ * import {DatabasePersisterConfig} from 'tinybase';
+ *
+ * export const databasePersisterConfig: DatabasePersisterConfig = {
  *   mode: 'tabular',
  *   tables: {
  *     save: {
@@ -566,7 +580,9 @@ export type DpcTabularSave = {
  * table called 'my_tinybase_values'.
  *
  * ```js
- * const databasePersisterConfig: DatabasePersisterConfig = {
+ * import {DatabasePersisterConfig} from 'tinybase';
+ *
+ * export const databasePersisterConfig: DatabasePersisterConfig = {
  *   mode: 'tabular',
  *   values: {
  *     load: true,
@@ -651,6 +667,9 @@ export type DpcTabularValues = {
  * finally destroys the Persister again.
  *
  * ```js
+ * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
+ * import {createStore} from 'tinybase';
+ *
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = createSessionPersister(store, 'pets');
  *
@@ -672,6 +691,9 @@ export type DpcTabularValues = {
  * persisted data (implicitly firing a StorageEvent), are reflected accordingly.
  *
  * ```js
+ * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
+ * import {createStore} from 'tinybase';
+ *
  * const store = createStore();
  * const persister = createSessionPersister(store, 'pets');
  *
@@ -721,6 +743,9 @@ export interface Persister<StoreType extends StoreTypes = 1> {
    * previously populated.
    *
    * ```js
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
+   * import {createStore} from 'tinybase';
+   *
    * sessionStorage.setItem('pets', '[{"pets":{"fido":{"species":"dog"}}},{}]');
    *
    * const store = createStore();
@@ -739,6 +764,9 @@ export interface Persister<StoreType extends StoreTypes = 1> {
    * previously been persisted and instead, that is loaded.
    *
    * ```js
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
+   * import {createStore} from 'tinybase';
+   *
    * const store = createStore();
    * const persister = createSessionPersister(store, 'pets');
    *
@@ -788,6 +816,9 @@ export interface Persister<StoreType extends StoreTypes = 1> {
    * from session storage changes made in another browser tab).
    *
    * ```js
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
+   * import {createStore} from 'tinybase';
+   *
    * const store = createStore();
    * const persister = createSessionPersister(store, 'pets');
    *
@@ -823,6 +854,9 @@ export interface Persister<StoreType extends StoreTypes = 1> {
    * stopped, subsequent changes are not reflected in the Store.
    *
    * ```js
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
+   * import {createStore} from 'tinybase';
+   *
    * const store = createStore();
    * const persister = createSessionPersister(store, 'pets');
    * await persister.startAutoLoad();
@@ -863,6 +897,9 @@ export interface Persister<StoreType extends StoreTypes = 1> {
    * This example creates a Persister and queries whether it is autoLoading.
    *
    * ```js
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
+   * import {createStore} from 'tinybase';
+   *
    * const persister = createSessionPersister(createStore(), 'pets');
    *
    * console.log(persister.isAutoLoading());
@@ -895,6 +932,9 @@ export interface Persister<StoreType extends StoreTypes = 1> {
    * session storage.
    *
    * ```js
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
+   * import {createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const persister = createSessionPersister(store, 'pets');
    *
@@ -928,6 +968,9 @@ export interface Persister<StoreType extends StoreTypes = 1> {
    * saved to the underlying storage.
    *
    * ```js
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
+   * import {createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const persister = createSessionPersister(store, 'pets');
    *
@@ -960,6 +1003,9 @@ export interface Persister<StoreType extends StoreTypes = 1> {
    * stopped, subsequent changes are not reflected.
    *
    * ```js
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
+   * import {createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const persister = createSessionPersister(store, 'pets');
    * await persister.startAutoSave();
@@ -992,6 +1038,9 @@ export interface Persister<StoreType extends StoreTypes = 1> {
    * This example creates a Persister and queries whether it is autoSaving.
    *
    * ```js
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
+   * import {createStore} from 'tinybase';
+   *
    * const persister = createSessionPersister(createStore(), 'pets');
    *
    * console.log(persister.isAutoSaving());
@@ -1030,6 +1079,13 @@ export interface Persister<StoreType extends StoreTypes = 1> {
    * hypothetical remote system.
    *
    * ```js yolo
+   * import {
+   *   checkRemoteSystemIsReady,
+   *   getDataFromRemoteSystem,
+   *   sendDataToRemoteSystem,
+   * } from 'custom-remote-handlers';
+   * import {createCustomPersister, createStore} from 'tinybase';
+   *
    * const store = createStore();
    * const persister = createCustomPersister(
    *   store,
@@ -1062,6 +1118,9 @@ export interface Persister<StoreType extends StoreTypes = 1> {
    * then gets its reference in order to update its data.
    *
    * ```js
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
+   * import {createStore} from 'tinybase';
+   *
    * const persister = createSessionPersister(createStore(), 'pets');
    * await persister.startAutoSave();
    *
@@ -1090,6 +1149,9 @@ export interface Persister<StoreType extends StoreTypes = 1> {
    * again, removing the listener.
    *
    * ```js
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
+   * import {createStore} from 'tinybase';
+   *
    * const store = createStore();
    * const persister = createSessionPersister(store, 'pets');
    * await persister.startAutoSave();
@@ -1127,6 +1189,9 @@ export interface Persister<StoreType extends StoreTypes = 1> {
    * invoked by changes to the Store and to the underlying storage.
    *
    * ```js
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
+   * import {createStore} from 'tinybase';
+   *
    * const store = createStore();
    * const persister = createSessionPersister(store, 'pets');
    *
@@ -1202,6 +1267,8 @@ export interface Persister<StoreType extends StoreTypes = 1> {
  * for changes every second.
  *
  * ```js
+ * import {createCustomPersister, createStore} from 'tinybase';
+ *
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * let storeJson;
  *