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

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

@@ -19,11 +19,12 @@ import type {
 import type {ElectricClient} from 'electric-sql/client/model';
 
 /**
- * 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.
@@ -70,9 +71,8 @@ export interface ElectricSqlPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * 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.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -86,6 +86,9 @@ export interface ElectricSqlPersister<Schemas extends OptionalSchemas>
  * ): ElectricSqlPersister;
  * ```
  *
+ * 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/with-schemas/index.d.ts

@@ -19,11 +19,12 @@ import type {
 import type {ElectricClient} from 'electric-sql/client/model';
 
 /**
- * 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.
@@ -70,9 +71,8 @@ export interface ElectricSqlPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * 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.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -86,6 +86,9 @@ export interface ElectricSqlPersister<Schemas extends OptionalSchemas>
  * ): ElectricSqlPersister;
  * ```
  *
+ * 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-expo-sqlite/index.d.cts

@@ -15,24 +15,26 @@
  * @since v4.5.0
  */
 
-import type {DatabasePersisterConfig, Persister} from '../index.d.cts';
+import type {DatabasePersisterConfig, Persister, Persists} from '../index.d.cts';
 import type {MergeableStore} from '../../mergeable-store/index.d.cts';
 import type {SQLiteDatabase} from 'expo-sqlite';
 import type {Store} from '../../store/index.d.cts';
 
 /**
- * The ExpoSqlitePersister interface is a minor extension to the Persister
- * interface.
+ * The ExpoSqlitePersister interface represents a Persister that lets you save
+ * and load Store data to and from a Expo-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 createExpoSqlitePersister function to create an
  * ExpoSqlitePersister object.
  * @category Persister
  * @since v4.5.0
  */
-export interface ExpoSqlitePersister extends Persister<3> {
+export interface ExpoSqlitePersister
+  extends Persister<Persists.StoreOrMergeableStore> {
   /**
    * The getDb method returns a reference to the database instance the Store is
    * being persisted to.
@@ -62,9 +64,12 @@ export interface ExpoSqlitePersister extends Persister<3> {
 }
 
 /**
- * The createExpoSqlitePersister function creates a Persister object that can
- * persist the Store to a local Expo-SQLite database (in an appropriate React
- * Native environment).
+ * The createExpoSqlitePersister function creates an ExpoSqlitePersister object
+ * that can persist the Store to a local Expo-SQLite database.
+ *
+ * An ExpoSqlitePersister supports regular Store objects, and can also be used
+ * to persist the metadata of a MergeableStore when using the JSON serialization
+ * mode, as described below.
  *
  * Note that this Persister is currently experimental as Expo themselves iterate
  * on the underlying database library API.
@@ -83,7 +88,7 @@ export interface ExpoSqlitePersister extends Persister<3> {
  *
  * See the documentation for the DpcJson and DpcTabular types for more
  * information on how both of those modes can be configured.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param db The database instance that was returned from
  * `SQLite.openDatabase(...)`.
  * @param configOrStoreTableName A DatabasePersisterConfig to configure the

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

@@ -15,24 +15,26 @@
  * @since v4.5.0
  */
 
-import type {DatabasePersisterConfig, Persister} from '../index.d.ts';
+import type {DatabasePersisterConfig, Persister, Persists} from '../index.d.ts';
 import type {MergeableStore} from '../../mergeable-store/index.d.ts';
 import type {SQLiteDatabase} from 'expo-sqlite';
 import type {Store} from '../../store/index.d.ts';
 
 /**
- * The ExpoSqlitePersister interface is a minor extension to the Persister
- * interface.
+ * The ExpoSqlitePersister interface represents a Persister that lets you save
+ * and load Store data to and from a Expo-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 createExpoSqlitePersister function to create an
  * ExpoSqlitePersister object.
  * @category Persister
  * @since v4.5.0
  */
-export interface ExpoSqlitePersister extends Persister<3> {
+export interface ExpoSqlitePersister
+  extends Persister<Persists.StoreOrMergeableStore> {
   /**
    * The getDb method returns a reference to the database instance the Store is
    * being persisted to.
@@ -62,9 +64,12 @@ export interface ExpoSqlitePersister extends Persister<3> {
 }
 
 /**
- * The createExpoSqlitePersister function creates a Persister object that can
- * persist the Store to a local Expo-SQLite database (in an appropriate React
- * Native environment).
+ * The createExpoSqlitePersister function creates an ExpoSqlitePersister object
+ * that can persist the Store to a local Expo-SQLite database.
+ *
+ * An ExpoSqlitePersister supports regular Store objects, and can also be used
+ * to persist the metadata of a MergeableStore when using the JSON serialization
+ * mode, as described below.
  *
  * Note that this Persister is currently experimental as Expo themselves iterate
  * on the underlying database library API.
@@ -83,7 +88,7 @@ export interface ExpoSqlitePersister extends Persister<3> {
  *
  * See the documentation for the DpcJson and DpcTabular types for more
  * information on how both of those modes can be configured.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param db The database instance that was returned from
  * `SQLite.openDatabase(...)`.
  * @param configOrStoreTableName A DatabasePersisterConfig to configure the

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

@@ -18,6 +18,7 @@
 import type {
   DatabasePersisterConfig,
   Persister,
+  Persists,
 } from '../../with-schemas/index.d.cts';
 import type {
   OptionalSchemas,
@@ -27,11 +28,12 @@ import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d
 import type {SQLiteDatabase} from 'expo-sqlite';
 
 /**
- * The ExpoSqlitePersister interface is a minor extension to the Persister
- * interface.
+ * The ExpoSqlitePersister interface represents a Persister that lets you save
+ * and load Store data to and from a Expo-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 createExpoSqlitePersister function to create an
  * ExpoSqlitePersister object.
@@ -39,7 +41,7 @@ import type {SQLiteDatabase} from 'expo-sqlite';
  * @since v4.5.0
  */
 export interface ExpoSqlitePersister<Schemas extends OptionalSchemas>
-  extends Persister<Schemas, 3> {
+  extends Persister<Schemas, Persists.StoreOrMergeableStore> {
   /**
    * The getDb method returns a reference to the database instance the Store is
    * being persisted to.
@@ -69,9 +71,8 @@ export interface ExpoSqlitePersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createExpoSqlitePersister function creates a Persister object that can
- * persist the Store to a local Expo-SQLite database (in an appropriate React
- * Native environment).
+ * The createExpoSqlitePersister function creates an ExpoSqlitePersister object
+ * that can persist the Store to a local Expo-SQLite database.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -85,6 +86,10 @@ export interface ExpoSqlitePersister<Schemas extends OptionalSchemas>
  * ): ExpoSqlitePersister;
  * ```
  *
+ * An ExpoSqlitePersister supports regular Store objects, and can also be used
+ * to persist the metadata of a MergeableStore when using the JSON serialization
+ * mode, as described below.
+ *
  * Note that this Persister is currently experimental as Expo themselves iterate
  * on the underlying database library API.
  *
@@ -102,7 +107,7 @@ export interface ExpoSqlitePersister<Schemas extends OptionalSchemas>
  *
  * See the documentation for the DpcJson and DpcTabular types for more
  * information on how both of those modes can be configured.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param db The database instance that was returned from
  * `SQLite.openDatabase(...)`.
  * @param configOrStoreTableName A DatabasePersisterConfig to configure the

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

@@ -18,6 +18,7 @@
 import type {
   DatabasePersisterConfig,
   Persister,
+  Persists,
 } from '../../with-schemas/index.d.ts';
 import type {
   OptionalSchemas,
@@ -27,11 +28,12 @@ import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d
 import type {SQLiteDatabase} from 'expo-sqlite';
 
 /**
- * The ExpoSqlitePersister interface is a minor extension to the Persister
- * interface.
+ * The ExpoSqlitePersister interface represents a Persister that lets you save
+ * and load Store data to and from a Expo-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 createExpoSqlitePersister function to create an
  * ExpoSqlitePersister object.
@@ -39,7 +41,7 @@ import type {SQLiteDatabase} from 'expo-sqlite';
  * @since v4.5.0
  */
 export interface ExpoSqlitePersister<Schemas extends OptionalSchemas>
-  extends Persister<Schemas, 3> {
+  extends Persister<Schemas, Persists.StoreOrMergeableStore> {
   /**
    * The getDb method returns a reference to the database instance the Store is
    * being persisted to.
@@ -69,9 +71,8 @@ export interface ExpoSqlitePersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createExpoSqlitePersister function creates a Persister object that can
- * persist the Store to a local Expo-SQLite database (in an appropriate React
- * Native environment).
+ * The createExpoSqlitePersister function creates an ExpoSqlitePersister object
+ * that can persist the Store to a local Expo-SQLite database.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -85,6 +86,10 @@ export interface ExpoSqlitePersister<Schemas extends OptionalSchemas>
  * ): ExpoSqlitePersister;
  * ```
  *
+ * An ExpoSqlitePersister supports regular Store objects, and can also be used
+ * to persist the metadata of a MergeableStore when using the JSON serialization
+ * mode, as described below.
+ *
  * Note that this Persister is currently experimental as Expo themselves iterate
  * on the underlying database library API.
  *
@@ -102,7 +107,7 @@ export interface ExpoSqlitePersister<Schemas extends OptionalSchemas>
  *
  * See the documentation for the DpcJson and DpcTabular types for more
  * information on how both of those modes can be configured.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param db The database instance that was returned from
  * `SQLite.openDatabase(...)`.
  * @param configOrStoreTableName A DatabasePersisterConfig to configure the

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

@@ -6,22 +6,25 @@
  * @module persister-file
  */
 
+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 FilePersister interface is a minor extension to the Persister interface.
+ * The FilePersister interface represents a Persister that lets you save and
+ * load Store data to and from a local file system.
  *
- * It simply provides an extra getFilePath method for accessing the location of
- * the local file the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getFilePath method for accessing the location of the local file the
+ * Store is being persisted to.
  *
  * You should use the createFilePersister function to create a FilePersister
  * object.
  * @category Persister
  * @since v4.3.14
  */
-export interface FilePersister extends Persister<3> {
+export interface FilePersister
+  extends Persister<Persists.StoreOrMergeableStore> {
   /**
    * The getFilePath method returns the location of the local file the Store is
    * being persisted to.
@@ -49,12 +52,14 @@ export interface FilePersister extends Persister<3> {
 }
 
 /**
- * The createFilePersister function creates a Persister object that can persist
- * the Store to a local file (in an appropriate environment).
+ * The createFilePersister function creates a FilePersister object that can
+ * persist the Store to a local file.
+ *
+ * A FilePersister supports both regular Store and MergeableStore objects.
  *
  * As well as providing a reference to the Store to persist, you must provide a
  * `filePath` parameter which identifies the file to persist it to.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param filePath The location of the local file to persist the Store to.
  * @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-file/index.d.ts

@@ -6,22 +6,25 @@
  * @module persister-file
  */
 
+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 FilePersister interface is a minor extension to the Persister interface.
+ * The FilePersister interface represents a Persister that lets you save and
+ * load Store data to and from a local file system.
  *
- * It simply provides an extra getFilePath method for accessing the location of
- * the local file the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getFilePath method for accessing the location of the local file the
+ * Store is being persisted to.
  *
  * You should use the createFilePersister function to create a FilePersister
  * object.
  * @category Persister
  * @since v4.3.14
  */
-export interface FilePersister extends Persister<3> {
+export interface FilePersister
+  extends Persister<Persists.StoreOrMergeableStore> {
   /**
    * The getFilePath method returns the location of the local file the Store is
    * being persisted to.
@@ -49,12 +52,14 @@ export interface FilePersister extends Persister<3> {
 }
 
 /**
- * The createFilePersister function creates a Persister object that can persist
- * the Store to a local file (in an appropriate environment).
+ * The createFilePersister function creates a FilePersister object that can
+ * persist the Store to a local file.
+ *
+ * A FilePersister supports both regular Store and MergeableStore objects.
  *
  * As well as providing a reference to the Store to persist, you must provide a
  * `filePath` parameter which identifies the file to persist it to.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param filePath The location of the local file to persist the Store to.
  * @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-file/with-schemas/index.d.cts

@@ -10,14 +10,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 FilePersister interface is a minor extension to the Persister interface.
+ * The FilePersister interface represents a Persister that lets you save and
+ * load Store data to and from a local file system.
  *
- * It simply provides an extra getFilePath method for accessing the location of
- * the local file the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getFilePath method for accessing the location of the local file the
+ * Store is being persisted to.
  *
  * You should use the createFilePersister function to create a FilePersister
  * object.
@@ -25,7 +27,7 @@ import type {Persister} from '../../with-schemas/index.d.cts';
  * @since v4.3.14
  */
 export interface FilePersister<Schemas extends OptionalSchemas>
-  extends Persister<Schemas, 3> {
+  extends Persister<Schemas, Persists.StoreOrMergeableStore> {
   /**
    * The getFilePath method returns the location of the local file the Store is
    * being persisted to.
@@ -53,8 +55,8 @@ export interface FilePersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createFilePersister function creates a Persister object that can persist
- * the Store to a local file (in an appropriate environment).
+ * The createFilePersister function creates a FilePersister object that can
+ * persist the Store to a local file.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -66,9 +68,11 @@ export interface FilePersister<Schemas extends OptionalSchemas>
  * ): FilePersister;
  * ```
  *
+ * A FilePersister supports both regular Store and MergeableStore objects.
+ *
  * As well as providing a reference to the Store to persist, you must provide a
  * `filePath` parameter which identifies the file to persist it to.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param filePath The location of the local file to persist the Store to.
  * @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-file/with-schemas/index.d.ts

@@ -10,14 +10,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 FilePersister interface is a minor extension to the Persister interface.
+ * The FilePersister interface represents a Persister that lets you save and
+ * load Store data to and from a local file system.
  *
- * It simply provides an extra getFilePath method for accessing the location of
- * the local file the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getFilePath method for accessing the location of the local file the
+ * Store is being persisted to.
  *
  * You should use the createFilePersister function to create a FilePersister
  * object.
@@ -25,7 +27,7 @@ import type {Persister} from '../../with-schemas/index.d.ts';
  * @since v4.3.14
  */
 export interface FilePersister<Schemas extends OptionalSchemas>
-  extends Persister<Schemas, 3> {
+  extends Persister<Schemas, Persists.StoreOrMergeableStore> {
   /**
    * The getFilePath method returns the location of the local file the Store is
    * being persisted to.
@@ -53,8 +55,8 @@ export interface FilePersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createFilePersister function creates a Persister object that can persist
- * the Store to a local file (in an appropriate environment).
+ * The createFilePersister function creates a FilePersister object that can
+ * persist the Store to a local file.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -66,9 +68,11 @@ export interface FilePersister<Schemas extends OptionalSchemas>
  * ): FilePersister;
  * ```
  *
+ * A FilePersister supports both regular Store and MergeableStore objects.
+ *
  * As well as providing a reference to the Store to persist, you must provide a
  * `filePath` parameter which identifies the file to persist it to.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param filePath The location of the local file to persist the Store to.
  * @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-indexed-db/index.d.cts

@@ -10,11 +10,12 @@ import type {Persister} from '../index.d.cts';
 import type {Store} from '../../store/index.d.cts';
 
 /**
- * The IndexedDbPersister interface is a minor extension to the Persister
- * interface.
+ * The IndexedDbPersister interface represents a Persister that lets you save
+ * and load Store data to and from browser IndexedDB storage.
  *
- * It simply provides an extra getDbName method for accessing the unique key of
- * the IndexedDB the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getDbName method for accessing the unique key of the IndexedDB the
+ * Store is being persisted to.
  *
  * You should use the createIndexedDbPersister function to create an
  * IndexedDbPersister object.
@@ -49,8 +50,11 @@ export interface IndexedDbPersister extends Persister {
 }
 
 /**
- * The createIndexedDbPersister function creates a Persister object that can
- * persist the Store to the browser's IndexedDB storage.
+ * The createIndexedDbPersister function creates an IndexedDbPersister object
+ * that can persist a Store to the browser's IndexedDB storage.
+ *
+ * An IndexedDbPersister 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
  * `dbName` parameter which is unique to your application. This is the key used

package/@types/persisters/persister-indexed-db/index.d.ts

@@ -10,11 +10,12 @@ import type {Persister} from '../index.d.ts';
 import type {Store} from '../../store/index.d.ts';
 
 /**
- * The IndexedDbPersister interface is a minor extension to the Persister
- * interface.
+ * The IndexedDbPersister interface represents a Persister that lets you save
+ * and load Store data to and from browser IndexedDB storage.
  *
- * It simply provides an extra getDbName method for accessing the unique key of
- * the IndexedDB the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getDbName method for accessing the unique key of the IndexedDB the
+ * Store is being persisted to.
  *
  * You should use the createIndexedDbPersister function to create an
  * IndexedDbPersister object.
@@ -49,8 +50,11 @@ export interface IndexedDbPersister extends Persister {
 }
 
 /**
- * The createIndexedDbPersister function creates a Persister object that can
- * persist the Store to the browser's IndexedDB storage.
+ * The createIndexedDbPersister function creates an IndexedDbPersister object
+ * that can persist a Store to the browser's IndexedDB storage.
+ *
+ * An IndexedDbPersister 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
  * `dbName` parameter which is unique to your application. This is the key used

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

@@ -13,11 +13,12 @@ import type {
 import type {Persister} from '../../with-schemas/index.d.cts';
 
 /**
- * The IndexedDbPersister interface is a minor extension to the Persister
- * interface.
+ * The IndexedDbPersister interface represents a Persister that lets you save
+ * and load Store data to and from browser IndexedDB storage.
  *
- * It simply provides an extra getDbName method for accessing the unique key of
- * the IndexedDB the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getDbName method for accessing the unique key of the IndexedDB the
+ * Store is being persisted to.
  *
  * You should use the createIndexedDbPersister function to create an
  * IndexedDbPersister object.
@@ -53,8 +54,8 @@ export interface IndexedDbPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createIndexedDbPersister function creates a Persister object that can
- * persist the Store to the browser's IndexedDB storage.
+ * The createIndexedDbPersister function creates an IndexedDbPersister object
+ * that can persist a Store to the browser's IndexedDB storage.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -67,6 +68,9 @@ export interface IndexedDbPersister<Schemas extends OptionalSchemas>
  * ): IndexedDbPersister;
  * ```
  *
+ * An IndexedDbPersister 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
  * `dbName` parameter which is unique to your application. This is the key used
  * to identify which IndexedDB to use.