tinybase 5.0.0-beta.26 → 5.0.0-beta.28

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

@@ -2,7 +2,7 @@
  * The persister-cr-sqlite-wasm module of the TinyBase project lets you save and
  * load Store data to and from a local CR-SQLite database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-cr-sqlite-wasm
  * @since v4.0.0
@@ -13,14 +13,15 @@ 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.
- *
- * It simply provides an extra getDb method for accessing a reference to the
- * database instance the Store is being persisted to.
+ * The CrSqliteWasmPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local CR-SQLite database.
  *
  * You should use the createCrSqliteWasmPersister function to create a
  * CrSqliteWasmPersister object.
+ *
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -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

@@ -2,7 +2,7 @@
  * The persister-cr-sqlite-wasm module of the TinyBase project lets you save and
  * load Store data to and from a local CR-SQLite database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-cr-sqlite-wasm
  * @since v4.0.0
@@ -19,14 +19,15 @@ import type {
 import type {DB} from '@vlcn.io/crsqlite-wasm';
 
 /**
- * The CrSqliteWasmPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getDb method for accessing a reference to the
- * database instance the Store is being persisted to.
+ * The CrSqliteWasmPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local CR-SQLite database.
  *
  * You should use the createCrSqliteWasmPersister function to create a
  * CrSqliteWasmPersister object.
+ *
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -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

@@ -2,7 +2,7 @@
  * The persister-cr-sqlite-wasm module of the TinyBase project lets you save and
  * load Store data to and from a local CR-SQLite database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-cr-sqlite-wasm
  * @since v4.0.0
@@ -19,14 +19,15 @@ import type {
 import type {DB} from '@vlcn.io/crsqlite-wasm';
 
 /**
- * The CrSqliteWasmPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getDb method for accessing a reference to the
- * database instance the Store is being persisted to.
+ * The CrSqliteWasmPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local CR-SQLite database.
  *
  * You should use the createCrSqliteWasmPersister function to create a
  * CrSqliteWasmPersister object.
+ *
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -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

@@ -2,7 +2,7 @@
  * The persister-electric-sql module of the TinyBase project lets you save and
  * load Store data to and from a local ElectricSQL database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-electric-sql
  * @since v4.6.0
@@ -13,14 +13,15 @@ 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.
- *
- * It simply provides an extra getElectricClient method for accessing a
- * reference to the Electric client the Store is being persisted to.
+ * The ElectricSqlPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local ElectricSQL database.
  *
  * You should use the createElectricSqlPersister function to create an
  * ElectricSqlPersister object.
+ *
+ * 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.
  * @category Persister
  * @since v4.6.0
  */
@@ -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

@@ -2,7 +2,7 @@
  * The persister-electric-sql module of the TinyBase project lets you save and
  * load Store data to and from a local ElectricSQL database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-electric-sql
  * @since v4.6.0
@@ -13,14 +13,15 @@ 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.
- *
- * It simply provides an extra getElectricClient method for accessing a
- * reference to the Electric client the Store is being persisted to.
+ * The ElectricSqlPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local ElectricSQL database.
  *
  * You should use the createElectricSqlPersister function to create an
  * ElectricSqlPersister object.
+ *
+ * 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.
  * @category Persister
  * @since v4.6.0
  */
@@ -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/with-schemas/index.d.cts

@@ -2,7 +2,7 @@
  * The persister-electric-sql module of the TinyBase project lets you save and
  * load Store data to and from a local ElectricSQL database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-electric-sql
  * @since v4.6.0
@@ -19,14 +19,15 @@ import type {
 import type {ElectricClient} from 'electric-sql/client/model';
 
 /**
- * The ElectricSqlPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getElectricClient method for accessing a
- * reference to the Electric client the Store is being persisted to.
+ * The ElectricSqlPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local ElectricSQL database.
  *
  * You should use the createElectricSqlPersister function to create an
  * ElectricSqlPersister object.
+ *
+ * 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.
  * @category Persister
  * @since v4.6.0
  */
@@ -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

@@ -2,7 +2,7 @@
  * The persister-electric-sql module of the TinyBase project lets you save and
  * load Store data to and from a local ElectricSQL database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-electric-sql
  * @since v4.6.0
@@ -19,14 +19,15 @@ import type {
 import type {ElectricClient} from 'electric-sql/client/model';
 
 /**
- * The ElectricSqlPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getElectricClient method for accessing a
- * reference to the Electric client the Store is being persisted to.
+ * The ElectricSqlPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local ElectricSQL database.
  *
  * You should use the createElectricSqlPersister function to create an
  * ElectricSqlPersister object.
+ *
+ * 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.
  * @category Persister
  * @since v4.6.0
  */
@@ -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

@@ -9,7 +9,7 @@
  *
  * Note that TinyBase support for the legacy version of Expo-SQLite is no longer
  * available.
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-expo-sqlite
  * @since v4.5.0
@@ -21,14 +21,15 @@ 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.
- *
- * It simply provides an extra getDb method for accessing a reference to the
- * database instance the Store is being persisted to.
+ * The ExpoSqlitePersister interface represents a Persister that lets you save
+ * and load Store data to and from a Expo-SQLite database.
  *
  * You should use the createExpoSqlitePersister function to create an
  * ExpoSqlitePersister object.
+ *
+ * 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.
  * @category Persister
  * @since v4.5.0
  */
@@ -63,9 +64,12 @@ export interface ExpoSqlitePersister
 }
 
 /**
- * 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.
@@ -84,7 +88,7 @@ export interface ExpoSqlitePersister
  *
  * 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

@@ -9,7 +9,7 @@
  *
  * Note that TinyBase support for the legacy version of Expo-SQLite is no longer
  * available.
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-expo-sqlite
  * @since v4.5.0
@@ -21,14 +21,15 @@ 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.
- *
- * It simply provides an extra getDb method for accessing a reference to the
- * database instance the Store is being persisted to.
+ * The ExpoSqlitePersister interface represents a Persister that lets you save
+ * and load Store data to and from a Expo-SQLite database.
  *
  * You should use the createExpoSqlitePersister function to create an
  * ExpoSqlitePersister object.
+ *
+ * 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.
  * @category Persister
  * @since v4.5.0
  */
@@ -63,9 +64,12 @@ export interface ExpoSqlitePersister
 }
 
 /**
- * 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.
@@ -84,7 +88,7 @@ export interface ExpoSqlitePersister
  *
  * 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

@@ -9,7 +9,7 @@
  *
  * Note that TinyBase support for the legacy version of Expo-SQLite is no longer
  * available.
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-expo-sqlite
  * @since v4.5.0
@@ -28,14 +28,15 @@ 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.
- *
- * It simply provides an extra getDb method for accessing a reference to the
- * database instance the Store is being persisted to.
+ * The ExpoSqlitePersister interface represents a Persister that lets you save
+ * and load Store data to and from a Expo-SQLite database.
  *
  * You should use the createExpoSqlitePersister function to create an
  * ExpoSqlitePersister object.
+ *
+ * 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.
  * @category Persister
  * @since v4.5.0
  */
@@ -70,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:
  *
@@ -86,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.
  *
@@ -103,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

@@ -9,7 +9,7 @@
  *
  * Note that TinyBase support for the legacy version of Expo-SQLite is no longer
  * available.
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-expo-sqlite
  * @since v4.5.0
@@ -28,14 +28,15 @@ 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.
- *
- * It simply provides an extra getDb method for accessing a reference to the
- * database instance the Store is being persisted to.
+ * The ExpoSqlitePersister interface represents a Persister that lets you save
+ * and load Store data to and from a Expo-SQLite database.
  *
  * You should use the createExpoSqlitePersister function to create an
  * ExpoSqlitePersister object.
+ *
+ * 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.
  * @category Persister
  * @since v4.5.0
  */
@@ -70,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:
  *
@@ -86,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.
  *
@@ -103,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

@@ -1,9 +1,10 @@
 /**
  * The persister-file module of the TinyBase project lets you save and load
  * Store data to and from a local file system (in an appropriate environment).
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-file
+ * @since v1.0.0
  */
 
 import type {Persister, Persists} from '../index.d.cts';
@@ -11,13 +12,15 @@ import type {MergeableStore} from '../../mergeable-store/index.d.cts';
 import type {Store} from '../../store/index.d.cts';
 
 /**
- * The FilePersister interface is a minor extension to the Persister interface.
- *
- * It simply provides an extra getFilePath method for accessing the location of
- * the local file the Store is being persisted to.
+ * The FilePersister interface represents a Persister that lets you save and
+ * load Store data to and from a local file system.
  *
  * You should use the createFilePersister function to create a FilePersister
  * object.
+ *
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -50,12 +53,14 @@ export interface FilePersister
 }
 
 /**
- * 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
@@ -81,6 +86,7 @@ export interface FilePersister
  * persister.destroy();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createFilePersister(
   store: Store | MergeableStore,