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

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

@@ -50,7 +50,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_',
@@ -115,9 +117,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
@@ -171,7 +174,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);
@@ -195,7 +200,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
@@ -242,7 +249,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';
    *   }
@@ -278,7 +287,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';
    *   }
@@ -316,7 +327,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';
    *   }
@@ -354,7 +367,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';
    *   }
@@ -407,7 +422,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'
@@ -450,7 +467,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';
    *   }
@@ -508,9 +527,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';
    *   }
    * }
    * ```
@@ -546,7 +567,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/with-schemas/persisters/persister-powersync.d.ts

@@ -34,7 +34,11 @@ export interface PowerSyncPersister<Schemas extends OptionalSchemas>
    * 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');
    *
@@ -99,6 +103,10 @@ export interface PowerSyncPersister<Schemas extends OptionalSchemas>
  * 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');
@@ -131,6 +139,10 @@ export interface PowerSyncPersister<Schemas extends OptionalSchemas>
  * 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/with-schemas/persisters/persister-remote.d.ts

@@ -31,6 +31,9 @@ export interface RemotePersister<Schemas extends OptionalSchemas>
    * 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,
@@ -93,6 +96,9 @@ export interface RemotePersister<Schemas extends OptionalSchemas>
  * 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/with-schemas/persisters/persister-sqlite-wasm.d.ts

@@ -10,6 +10,7 @@
 
 import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
 import {OptionalSchemas, Store} from '../store.d.ts';
+import {MergeableStore} from '../mergeable-store.d.ts';
 
 /**
  * The SqliteWasmPersister interface is a minor extension to the Persister
@@ -34,6 +35,10 @@ export interface SqliteWasmPersister<Schemas extends OptionalSchemas>
    * 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'}}});
@@ -63,7 +68,7 @@ export interface SqliteWasmPersister<Schemas extends OptionalSchemas>
  *
  * ```ts override
  * createSqliteWasmPersister(
- *   store: Store,
+ *   store: Store | MergeableStore,
  *   sqlite3: any,
  *   db: any,
  *   configOrStoreTableName?: DatabasePersisterConfig | string,
@@ -108,6 +113,10 @@ export interface SqliteWasmPersister<Schemas extends OptionalSchemas>
  * 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'}}});
@@ -139,6 +148,10 @@ export interface SqliteWasmPersister<Schemas extends OptionalSchemas>
  * 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'}}});
@@ -162,7 +175,7 @@ export interface SqliteWasmPersister<Schemas extends OptionalSchemas>
  * @since v4.0.0
  */
 export function createSqliteWasmPersister<Schemas extends OptionalSchemas>(
-  store: Store<Schemas>,
+  store: Store<Schemas> | MergeableStore<Schemas>,
   sqlite3: any,
   db: any,
   configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,

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

@@ -11,6 +11,7 @@
 import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
 import {OptionalSchemas, Store} from '../store.d.ts';
 import {Database} from 'sqlite3';
+import {MergeableStore} from '../mergeable-store.d.ts';
 
 /**
  * The Sqlite3Persister interface is a minor extension to the Persister
@@ -35,7 +36,11 @@ export interface Sqlite3Persister<Schemas extends OptionalSchemas>
    * 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');
    *
@@ -58,7 +63,7 @@ export interface Sqlite3Persister<Schemas extends OptionalSchemas>
  *
  * ```ts override
  * createSqlite3Persister(
- *   store: Store,
+ *   store: Store | MergeableStore,
  *   db: Database,
  *   configOrStoreTableName?: DatabasePersisterConfig | string,
  *   onSqlCommand?: (sql: string, args?: any[]) => void,
@@ -100,7 +105,11 @@ export interface Sqlite3Persister<Schemas extends OptionalSchemas>
  * 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');
  *
@@ -132,7 +141,11 @@ export interface Sqlite3Persister<Schemas extends OptionalSchemas>
  * 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',
@@ -163,7 +176,7 @@ export interface Sqlite3Persister<Schemas extends OptionalSchemas>
  * @since v4.0.0
  */
 export function createSqlite3Persister<Schemas extends OptionalSchemas>(
-  store: Store<Schemas>,
+  store: Store<Schemas> | MergeableStore<Schemas>,
   db: Database,
   configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
   onSqlCommand?: (sql: string, args?: any[]) => void,

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

@@ -37,7 +37,11 @@ export interface YjsPersister<Schemas extends OptionalSchemas>
    * 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);
    *
@@ -82,7 +86,11 @@ export interface YjsPersister<Schemas extends OptionalSchemas>
  * 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);
  *
@@ -105,14 +113,18 @@ export interface YjsPersister<Schemas extends OptionalSchemas>
  * 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/with-schemas/persisters.d.ts

@@ -190,7 +190,9 @@ export type PersisterStats = {
  * settings.
  *
  * ```js
- * const databasePersisterConfig: DatabasePersisterConfig = {
+ * import {DatabasePersisterConfig} from 'tinybase';
+ *
+ * export const databasePersisterConfig: DatabasePersisterConfig = {
  *   mode: 'json',
  *   storeTableName: 'my_tinybase',
  *   autoLoadIntervalSeconds: 2,
@@ -202,7 +204,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'},
@@ -247,7 +251,9 @@ export type DatabasePersisterConfig<Schemas extends OptionalSchemas> =
  * 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',
  * };
@@ -305,7 +311,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'},
@@ -326,7 +334,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'},
@@ -400,7 +410,9 @@ export type DpcTabular<Schema extends OptionalTablesSchema> = {
  * 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: {
@@ -503,7 +515,9 @@ export type DpcTabularLoad<Schema extends OptionalTablesSchema> = {
  * empty.
  *
  * ```js
- * const databasePersisterConfig: DatabasePersisterConfig = {
+ * import {DatabasePersisterConfig} from 'tinybase';
+ *
+ * export const databasePersisterConfig: DatabasePersisterConfig = {
  *   mode: 'tabular',
  *   tables: {
  *     save: {
@@ -598,7 +612,9 @@ export type DpcTabularSave<Schema extends OptionalTablesSchema> = {
  * table called 'my_tinybase_values'.
  *
  * ```js
- * const databasePersisterConfig: DatabasePersisterConfig = {
+ * import {DatabasePersisterConfig} from 'tinybase';
+ *
+ * export const databasePersisterConfig: DatabasePersisterConfig = {
  *   mode: 'tabular',
  *   values: {
  *     load: true,
@@ -683,6 +699,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');
  *
@@ -704,6 +723,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');
  *
@@ -761,6 +783,9 @@ export interface Persister<
    * previously populated.
    *
    * ```js
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
+   * import {createStore} from 'tinybase';
+   *
    * sessionStorage.setItem('pets', '[{"pets":{"fido":{"species":"dog"}}},{}]');
    *
    * const store = createStore();
@@ -779,6 +804,9 @@ export interface Persister<
    * 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');
    *
@@ -834,6 +862,9 @@ export interface Persister<
    * 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');
    *
@@ -869,6 +900,9 @@ export interface Persister<
    * 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();
@@ -909,6 +943,9 @@ export interface Persister<
    * 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());
@@ -941,6 +978,9 @@ export interface Persister<
    * 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');
    *
@@ -974,6 +1014,9 @@ export interface Persister<
    * 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');
    *
@@ -1006,6 +1049,9 @@ export interface Persister<
    * 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();
@@ -1038,6 +1084,9 @@ export interface Persister<
    * 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());
@@ -1076,6 +1125,13 @@ export interface Persister<
    * 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,
@@ -1114,6 +1170,9 @@ export interface Persister<
    * ```
    *
    * ```js
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
+   * import {createStore} from 'tinybase';
+   *
    * const persister = createSessionPersister(createStore(), 'pets');
    * await persister.startAutoSave();
    *
@@ -1142,6 +1201,9 @@ export interface Persister<
    * 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();
@@ -1179,6 +1241,9 @@ export interface Persister<
    * 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');
    *
@@ -1275,6 +1340,8 @@ export interface Persister<
  * for changes every second.
  *
  * ```js
+ * import {createCustomPersister, createStore} from 'tinybase';
+ *
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * let storeJson;
  *