tinybase 5.0.0-beta.25 → 5.0.0-beta.27

package/@types/persisters/persister-browser/index.d.cts

@@ -14,23 +14,25 @@
  * @module persister-browser
  */
 
+import type {Persister, Persists} from '../index.d.cts';
 import type {MergeableStore} from '../../mergeable-store/index.d.cts';
-import type {Persister} from '../index.d.cts';
 import type {Store} from '../../store/index.d.cts';
 
 /**
- * The SessionPersister interface is a minor extension to the Persister
- * interface.
+ * The SessionPersister interface represents a Persister that lets you save and
+ * load Store data to and from the browser's session storage.
  *
- * It simply provides an extra getStorageName method for accessing the unique
- * key of the storage location the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getStorageName method for accessing the unique key of the storage
+ * location the Store is being persisted to.
  *
  * You should use the createSessionPersister function to create a
  * SessionPersister object.
  * @category Persister
  * @since v4.3.14
  */
-export interface SessionPersister extends Persister<3> {
+export interface SessionPersister
+  extends Persister<Persists.StoreOrMergeableStore> {
   /**
    * The getStorageName method returns the unique key of the storage location
    * the Store is being persisted to.
@@ -58,17 +60,20 @@ export interface SessionPersister extends Persister<3> {
 }
 
 /**
- * The LocalPersister interface is a minor extension to the Persister interface.
+ * The LocalPersister interface represents a Persister that lets you save and
+ * load Store data to and from the browser's local storage.
  *
- * It simply provides an extra getStorageName method for accessing the unique
- * key of the storage location the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getStorageName method for accessing the unique key of the storage
+ * location the Store is being persisted to.
  *
  * You should use the createLocalPersister function to create a LocalPersister
  * object.
  * @category Persister
  * @since v4.3.14
  */
-export interface LocalPersister extends Persister<3> {
+export interface LocalPersister
+  extends Persister<Persists.StoreOrMergeableStore> {
   /**
    * The getStorageName method returns the unique key of the storage location
    * the Store is being persisted to.
@@ -96,13 +101,15 @@ export interface LocalPersister extends Persister<3> {
 }
 
 /**
- * The createSessionPersister function creates a Persister object that can
- * persist the Store to the browser's session storage.
+ * The createSessionPersister function creates a SessionPersister object that
+ * can persist the Store to the browser's session storage.
+ *
+ * A SessionPersister supports both regular Store and MergeableStore objects.
  *
  * As well as providing a reference to the Store to persist, you must provide a
  * `storageName` parameter which is unique to your application. This is the key
  * that the browser uses to identify the storage location.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param storageName The unique key to identify the storage location.
  * @param onIgnoredError An optional handler for the errors that the Persister
  * would otherwise ignore when trying to save or load data. This is suitable for
@@ -135,13 +142,15 @@ export function createSessionPersister(
 ): SessionPersister;
 
 /**
- * The createLocalPersister function creates a Persister object that can persist
- * the Store to the browser's local storage.
+ * The createLocalPersister function creates a LocalPersister object that can
+ * persist the Store to the browser's local storage.
+ *
+ * A LocalPersister supports both regular Store and MergeableStore objects.
  *
  * As well as providing a reference to the Store to persist, you must provide a
  * `storageName` parameter which is unique to your application. This is the key
  * that the browser uses to identify the storage location.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param storageName The unique key to identify the storage location.
  * @param onIgnoredError An optional handler for the errors that the Persister
  * would otherwise ignore when trying to save or load data. This is suitable for

package/@types/persisters/persister-browser/index.d.ts

@@ -14,23 +14,25 @@
  * @module persister-browser
  */
 
+import type {Persister, Persists} from '../index.d.ts';
 import type {MergeableStore} from '../../mergeable-store/index.d.ts';
-import type {Persister} from '../index.d.ts';
 import type {Store} from '../../store/index.d.ts';
 
 /**
- * The SessionPersister interface is a minor extension to the Persister
- * interface.
+ * The SessionPersister interface represents a Persister that lets you save and
+ * load Store data to and from the browser's session storage.
  *
- * It simply provides an extra getStorageName method for accessing the unique
- * key of the storage location the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getStorageName method for accessing the unique key of the storage
+ * location the Store is being persisted to.
  *
  * You should use the createSessionPersister function to create a
  * SessionPersister object.
  * @category Persister
  * @since v4.3.14
  */
-export interface SessionPersister extends Persister<3> {
+export interface SessionPersister
+  extends Persister<Persists.StoreOrMergeableStore> {
   /**
    * The getStorageName method returns the unique key of the storage location
    * the Store is being persisted to.
@@ -58,17 +60,20 @@ export interface SessionPersister extends Persister<3> {
 }
 
 /**
- * The LocalPersister interface is a minor extension to the Persister interface.
+ * The LocalPersister interface represents a Persister that lets you save and
+ * load Store data to and from the browser's local storage.
  *
- * It simply provides an extra getStorageName method for accessing the unique
- * key of the storage location the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getStorageName method for accessing the unique key of the storage
+ * location the Store is being persisted to.
  *
  * You should use the createLocalPersister function to create a LocalPersister
  * object.
  * @category Persister
  * @since v4.3.14
  */
-export interface LocalPersister extends Persister<3> {
+export interface LocalPersister
+  extends Persister<Persists.StoreOrMergeableStore> {
   /**
    * The getStorageName method returns the unique key of the storage location
    * the Store is being persisted to.
@@ -96,13 +101,15 @@ export interface LocalPersister extends Persister<3> {
 }
 
 /**
- * The createSessionPersister function creates a Persister object that can
- * persist the Store to the browser's session storage.
+ * The createSessionPersister function creates a SessionPersister object that
+ * can persist the Store to the browser's session storage.
+ *
+ * A SessionPersister supports both regular Store and MergeableStore objects.
  *
  * As well as providing a reference to the Store to persist, you must provide a
  * `storageName` parameter which is unique to your application. This is the key
  * that the browser uses to identify the storage location.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param storageName The unique key to identify the storage location.
  * @param onIgnoredError An optional handler for the errors that the Persister
  * would otherwise ignore when trying to save or load data. This is suitable for
@@ -135,13 +142,15 @@ export function createSessionPersister(
 ): SessionPersister;
 
 /**
- * The createLocalPersister function creates a Persister object that can persist
- * the Store to the browser's local storage.
+ * The createLocalPersister function creates a LocalPersister object that can
+ * persist the Store to the browser's local storage.
+ *
+ * A LocalPersister supports both regular Store and MergeableStore objects.
  *
  * As well as providing a reference to the Store to persist, you must provide a
  * `storageName` parameter which is unique to your application. This is the key
  * that the browser uses to identify the storage location.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param storageName The unique key to identify the storage location.
  * @param onIgnoredError An optional handler for the errors that the Persister
  * would otherwise ignore when trying to save or load data. This is suitable for

package/@types/persisters/persister-browser/with-schemas/index.d.cts

@@ -18,15 +18,16 @@ import type {
   OptionalSchemas,
   Store,
 } from '../../../store/with-schemas/index.d.cts';
+import type {Persister, Persists} from '../../with-schemas/index.d.cts';
 import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.cts';
-import type {Persister} from '../../with-schemas/index.d.cts';
 
 /**
- * The SessionPersister interface is a minor extension to the Persister
- * interface.
+ * The SessionPersister interface represents a Persister that lets you save and
+ * load Store data to and from the browser's session storage.
  *
- * It simply provides an extra getStorageName method for accessing the unique
- * key of the storage location the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getStorageName method for accessing the unique key of the storage
+ * location the Store is being persisted to.
  *
  * You should use the createSessionPersister function to create a
  * SessionPersister object.
@@ -34,7 +35,7 @@ import type {Persister} from '../../with-schemas/index.d.cts';
  * @since v4.3.14
  */
 export interface SessionPersister<Schemas extends OptionalSchemas>
-  extends Persister<Schemas, 3> {
+  extends Persister<Schemas, Persists.StoreOrMergeableStore> {
   /**
    * The getStorageName method returns the unique key of the storage location
    * the Store is being persisted to.
@@ -62,10 +63,12 @@ export interface SessionPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The LocalPersister interface is a minor extension to the Persister interface.
+ * The LocalPersister interface represents a Persister that lets you save and
+ * load Store data to and from the browser's local storage.
  *
- * It simply provides an extra getStorageName method for accessing the unique
- * key of the storage location the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getStorageName method for accessing the unique key of the storage
+ * location the Store is being persisted to.
  *
  * You should use the createLocalPersister function to create a LocalPersister
  * object.
@@ -73,7 +76,7 @@ export interface SessionPersister<Schemas extends OptionalSchemas>
  * @since v4.3.14
  */
 export interface LocalPersister<Schemas extends OptionalSchemas>
-  extends Persister<Schemas, 3> {
+  extends Persister<Schemas, Persists.StoreOrMergeableStore> {
   /**
    * The getStorageName method returns the unique key of the storage location
    * the Store is being persisted to.
@@ -101,8 +104,8 @@ export interface LocalPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createSessionPersister function creates a Persister object that can
- * persist the Store to the browser's session storage.
+ * The createSessionPersister function creates a SessionPersister object that
+ * can persist the Store to the browser's session storage.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -114,10 +117,12 @@ export interface LocalPersister<Schemas extends OptionalSchemas>
  * ): SessionPersister;
  * ```
  *
+ * A SessionPersister supports both regular Store and MergeableStore objects.
+ *
  * As well as providing a reference to the Store to persist, you must provide a
  * `storageName` parameter which is unique to your application. This is the key
  * that the browser uses to identify the storage location.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param storageName The unique key to identify the storage location.
  * @param onIgnoredError An optional handler for the errors that the Persister
  * would otherwise ignore when trying to save or load data. This is suitable for
@@ -150,8 +155,8 @@ export function createSessionPersister<Schemas extends OptionalSchemas>(
 ): SessionPersister<Schemas>;
 
 /**
- * The createLocalPersister function creates a Persister object that can persist
- * the Store to the browser's local storage.
+ * The createLocalPersister function creates a LocalPersister object that can
+ * persist the Store to the browser's local storage.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -163,10 +168,12 @@ export function createSessionPersister<Schemas extends OptionalSchemas>(
  * ): LocalPersister;
  * ```
  *
+ * A LocalPersister supports both regular Store and MergeableStore objects.
+ *
  * As well as providing a reference to the Store to persist, you must provide a
  * `storageName` parameter which is unique to your application. This is the key
  * that the browser uses to identify the storage location.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param storageName The unique key to identify the storage location.
  * @param onIgnoredError An optional handler for the errors that the Persister
  * would otherwise ignore when trying to save or load data. This is suitable for

package/@types/persisters/persister-browser/with-schemas/index.d.ts

@@ -18,15 +18,16 @@ import type {
   OptionalSchemas,
   Store,
 } from '../../../store/with-schemas/index.d.ts';
+import type {Persister, Persists} from '../../with-schemas/index.d.ts';
 import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.ts';
-import type {Persister} from '../../with-schemas/index.d.ts';
 
 /**
- * The SessionPersister interface is a minor extension to the Persister
- * interface.
+ * The SessionPersister interface represents a Persister that lets you save and
+ * load Store data to and from the browser's session storage.
  *
- * It simply provides an extra getStorageName method for accessing the unique
- * key of the storage location the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getStorageName method for accessing the unique key of the storage
+ * location the Store is being persisted to.
  *
  * You should use the createSessionPersister function to create a
  * SessionPersister object.
@@ -34,7 +35,7 @@ import type {Persister} from '../../with-schemas/index.d.ts';
  * @since v4.3.14
  */
 export interface SessionPersister<Schemas extends OptionalSchemas>
-  extends Persister<Schemas, 3> {
+  extends Persister<Schemas, Persists.StoreOrMergeableStore> {
   /**
    * The getStorageName method returns the unique key of the storage location
    * the Store is being persisted to.
@@ -62,10 +63,12 @@ export interface SessionPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The LocalPersister interface is a minor extension to the Persister interface.
+ * The LocalPersister interface represents a Persister that lets you save and
+ * load Store data to and from the browser's local storage.
  *
- * It simply provides an extra getStorageName method for accessing the unique
- * key of the storage location the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getStorageName method for accessing the unique key of the storage
+ * location the Store is being persisted to.
  *
  * You should use the createLocalPersister function to create a LocalPersister
  * object.
@@ -73,7 +76,7 @@ export interface SessionPersister<Schemas extends OptionalSchemas>
  * @since v4.3.14
  */
 export interface LocalPersister<Schemas extends OptionalSchemas>
-  extends Persister<Schemas, 3> {
+  extends Persister<Schemas, Persists.StoreOrMergeableStore> {
   /**
    * The getStorageName method returns the unique key of the storage location
    * the Store is being persisted to.
@@ -101,8 +104,8 @@ export interface LocalPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createSessionPersister function creates a Persister object that can
- * persist the Store to the browser's session storage.
+ * The createSessionPersister function creates a SessionPersister object that
+ * can persist the Store to the browser's session storage.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -114,10 +117,12 @@ export interface LocalPersister<Schemas extends OptionalSchemas>
  * ): SessionPersister;
  * ```
  *
+ * A SessionPersister supports both regular Store and MergeableStore objects.
+ *
  * As well as providing a reference to the Store to persist, you must provide a
  * `storageName` parameter which is unique to your application. This is the key
  * that the browser uses to identify the storage location.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param storageName The unique key to identify the storage location.
  * @param onIgnoredError An optional handler for the errors that the Persister
  * would otherwise ignore when trying to save or load data. This is suitable for
@@ -150,8 +155,8 @@ export function createSessionPersister<Schemas extends OptionalSchemas>(
 ): SessionPersister<Schemas>;
 
 /**
- * The createLocalPersister function creates a Persister object that can persist
- * the Store to the browser's local storage.
+ * The createLocalPersister function creates a LocalPersister object that can
+ * persist the Store to the browser's local storage.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -163,10 +168,12 @@ export function createSessionPersister<Schemas extends OptionalSchemas>(
  * ): LocalPersister;
  * ```
  *
+ * A LocalPersister supports both regular Store and MergeableStore objects.
+ *
  * As well as providing a reference to the Store to persist, you must provide a
  * `storageName` parameter which is unique to your application. This is the key
  * that the browser uses to identify the storage location.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param storageName The unique key to identify the storage location.
  * @param onIgnoredError An optional handler for the errors that the Persister
  * would otherwise ignore when trying to save or load data. This is suitable for

package/@types/persisters/persister-cr-sqlite-wasm/index.d.cts

@@ -13,11 +13,12 @@ import type {DB} from '@vlcn.io/crsqlite-wasm';
 import type {Store} from '../../store/index.d.cts';
 
 /**
- * The CrSqliteWasmPersister interface is a minor extension to the Persister
- * interface.
+ * The CrSqliteWasmPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local CR-SQLite database.
  *
- * It simply provides an extra getDb method for accessing a reference to the
- * database instance the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getDb method for accessing a reference to the database instance the
+ * Store is being persisted to.
  *
  * You should use the createCrSqliteWasmPersister function to create a
  * CrSqliteWasmPersister object.
@@ -55,9 +56,11 @@ export interface CrSqliteWasmPersister extends Persister {
 }
 
 /**
- * The createCrSqliteWasmPersister function creates a Persister object that can
- * persist the Store to a local CR-SQLite database (in an appropriate
- * environment).
+ * The createCrSqliteWasmPersister function creates a CrSqliteWasmPersister
+ * object that can persist the Store to a local CR-SQLite database.
+ *
+ * A CrSqliteWasmPersister only supports regular Store objects, and cannot be
+ * used to persist the metadata of a MergeableStore.
  *
  * As well as providing a reference to the Store to persist, you must provide a
  * `db` parameter which identifies the database instance.

package/@types/persisters/persister-cr-sqlite-wasm/index.d.ts

@@ -13,11 +13,12 @@ import type {DB} from '@vlcn.io/crsqlite-wasm';
 import type {Store} from '../../store/index.d.ts';
 
 /**
- * The CrSqliteWasmPersister interface is a minor extension to the Persister
- * interface.
+ * The CrSqliteWasmPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local CR-SQLite database.
  *
- * It simply provides an extra getDb method for accessing a reference to the
- * database instance the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getDb method for accessing a reference to the database instance the
+ * Store is being persisted to.
  *
  * You should use the createCrSqliteWasmPersister function to create a
  * CrSqliteWasmPersister object.
@@ -55,9 +56,11 @@ export interface CrSqliteWasmPersister extends Persister {
 }
 
 /**
- * The createCrSqliteWasmPersister function creates a Persister object that can
- * persist the Store to a local CR-SQLite database (in an appropriate
- * environment).
+ * The createCrSqliteWasmPersister function creates a CrSqliteWasmPersister
+ * object that can persist the Store to a local CR-SQLite database.
+ *
+ * A CrSqliteWasmPersister only supports regular Store objects, and cannot be
+ * used to persist the metadata of a MergeableStore.
  *
  * As well as providing a reference to the Store to persist, you must provide a
  * `db` parameter which identifies the database instance.

package/@types/persisters/persister-cr-sqlite-wasm/with-schemas/index.d.cts

@@ -19,11 +19,12 @@ import type {
 import type {DB} from '@vlcn.io/crsqlite-wasm';
 
 /**
- * The CrSqliteWasmPersister interface is a minor extension to the Persister
- * interface.
+ * The CrSqliteWasmPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local CR-SQLite database.
  *
- * It simply provides an extra getDb method for accessing a reference to the
- * database instance the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getDb method for accessing a reference to the database instance the
+ * Store is being persisted to.
  *
  * You should use the createCrSqliteWasmPersister function to create a
  * CrSqliteWasmPersister object.
@@ -62,9 +63,8 @@ export interface CrSqliteWasmPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createCrSqliteWasmPersister function creates a Persister object that can
- * persist the Store to a local CR-SQLite database (in an appropriate
- * environment).
+ * The createCrSqliteWasmPersister function creates a CrSqliteWasmPersister
+ * object that can persist the Store to a local CR-SQLite database.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -78,6 +78,9 @@ export interface CrSqliteWasmPersister<Schemas extends OptionalSchemas>
  * ): CrSqliteWasmPersister;
  * ```
  *
+ * A CrSqliteWasmPersister only supports regular Store objects, and cannot be
+ * used to persist the metadata of a MergeableStore.
+ *
  * As well as providing a reference to the Store to persist, you must provide a
  * `db` parameter which identifies the database instance.
  *

package/@types/persisters/persister-cr-sqlite-wasm/with-schemas/index.d.ts

@@ -19,11 +19,12 @@ import type {
 import type {DB} from '@vlcn.io/crsqlite-wasm';
 
 /**
- * The CrSqliteWasmPersister interface is a minor extension to the Persister
- * interface.
+ * The CrSqliteWasmPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local CR-SQLite database.
  *
- * It simply provides an extra getDb method for accessing a reference to the
- * database instance the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getDb method for accessing a reference to the database instance the
+ * Store is being persisted to.
  *
  * You should use the createCrSqliteWasmPersister function to create a
  * CrSqliteWasmPersister object.
@@ -62,9 +63,8 @@ export interface CrSqliteWasmPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createCrSqliteWasmPersister function creates a Persister object that can
- * persist the Store to a local CR-SQLite database (in an appropriate
- * environment).
+ * The createCrSqliteWasmPersister function creates a CrSqliteWasmPersister
+ * object that can persist the Store to a local CR-SQLite database.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -78,6 +78,9 @@ export interface CrSqliteWasmPersister<Schemas extends OptionalSchemas>
  * ): CrSqliteWasmPersister;
  * ```
  *
+ * A CrSqliteWasmPersister only supports regular Store objects, and cannot be
+ * used to persist the metadata of a MergeableStore.
+ *
  * As well as providing a reference to the Store to persist, you must provide a
  * `db` parameter which identifies the database instance.
  *

package/@types/persisters/persister-electric-sql/index.d.cts

@@ -13,11 +13,12 @@ import type {ElectricClient} from 'electric-sql/client/model';
 import type {Store} from '../../store/index.d.cts';
 
 /**
- * The ElectricSqlPersister interface is a minor extension to the Persister
- * interface.
+ * The ElectricSqlPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local ElectricSQL database.
  *
- * It simply provides an extra getElectricClient method for accessing a
- * reference to the Electric client the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getElectricClient method for accessing a reference to the Electric
+ * client the Store is being persisted to.
  *
  * You should use the createElectricSqlPersister function to create an
  * ElectricSqlPersister object.
@@ -63,9 +64,11 @@ export interface ElectricSqlPersister extends Persister {
 }
 
 /**
- * The createElectricSqlPersister function creates a Persister object that can
- * persist the Store to a local ElectricSQL database (in an appropriate
- * environment).
+ * The createElectricSqlPersister function creates an ElectricSqlPersister
+ * object that can persist a Store to a local ElectricSQL database.
+ *
+ * An ElectricSqlPersister only supports regular Store objects, and cannot be
+ * used to persist the metadata of a MergeableStore.
  *
  * As well as providing a reference to the Store to persist, you must provide a
  * `electricClient` parameter which identifies the Electric client.

package/@types/persisters/persister-electric-sql/index.d.ts

@@ -13,11 +13,12 @@ import type {ElectricClient} from 'electric-sql/client/model';
 import type {Store} from '../../store/index.d.ts';
 
 /**
- * The ElectricSqlPersister interface is a minor extension to the Persister
- * interface.
+ * The ElectricSqlPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local ElectricSQL database.
  *
- * It simply provides an extra getElectricClient method for accessing a
- * reference to the Electric client the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getElectricClient method for accessing a reference to the Electric
+ * client the Store is being persisted to.
  *
  * You should use the createElectricSqlPersister function to create an
  * ElectricSqlPersister object.
@@ -63,9 +64,11 @@ export interface ElectricSqlPersister extends Persister {
 }
 
 /**
- * The createElectricSqlPersister function creates a Persister object that can
- * persist the Store to a local ElectricSQL database (in an appropriate
- * environment).
+ * The createElectricSqlPersister function creates an ElectricSqlPersister
+ * object that can persist a Store to a local ElectricSQL database.
+ *
+ * An ElectricSqlPersister only supports regular Store objects, and cannot be
+ * used to persist the metadata of a MergeableStore.
  *
  * As well as providing a reference to the Store to persist, you must provide a
  * `electricClient` parameter which identifies the Electric client.