tinybase 5.0.0-beta.26 → 5.0.0-beta.27

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

@@ -3,8 +3,8 @@
  * client portion of the PartyKit integration.
  *
  * It contains a Persister which, when run in a PartyKit client environment,
- * lets you save and load Store data from the client to durable PartyKit cloud
- * storage of a server (that is using the complementary
+ * lets you save and load Store data from the client to the durable PartyKit
+ * cloud storage of a server (that is using the complementary
  * persister-partykit-server module).
  *
  * This enables synchronization of the same Store across multiple clients in a
@@ -26,11 +26,13 @@ import type {PartySocket} from 'partysocket';
 import type {Persister} from '../../with-schemas/index.d.cts';
 
 /**
- * The PartyKitPersister interface is a minor extension to the Persister
- * interface.
+ * The PartyKitPersister interface represents a Persister that lets you save and
+ * load Store data from the client to the durable PartyKit cloud storage of a
+ * server.
  *
- * It simply provides an extra getConnection method for accessing the
- * PartySocket the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getConnection method for accessing the PartySocket the Store is being
+ * persisted to.
  *
  * You should use the createPartyKitPersister function to create a
  * PartyKitPersister object.
@@ -119,9 +121,9 @@ export type PartyKitPersisterConfig = {
 };
 
 /**
- * The createPartyKitPersister function creates a Persister object that can
- * persist the Store to durable PartyKit storage, enabling synchronization of
- * the same Store across multiple clients.
+ * The createPartyKitPersister function creates a PartyKitPersister object that
+ * can persist the Store to durable PartyKit storage, enabling synchronization
+ * of the same Store across multiple clients.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -134,6 +136,9 @@ export type PartyKitPersisterConfig = {
  * ): PartyKitPersister;
  * ```
  *
+ * A PartyKitPersister 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
  * `connection` parameter which is a PartyKit PartySocket that you have already
  * instantiated with details of the host and room.

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

@@ -3,8 +3,8 @@
  * client portion of the PartyKit integration.
  *
  * It contains a Persister which, when run in a PartyKit client environment,
- * lets you save and load Store data from the client to durable PartyKit cloud
- * storage of a server (that is using the complementary
+ * lets you save and load Store data from the client to the durable PartyKit
+ * cloud storage of a server (that is using the complementary
  * persister-partykit-server module).
  *
  * This enables synchronization of the same Store across multiple clients in a
@@ -26,11 +26,13 @@ import type {PartySocket} from 'partysocket';
 import type {Persister} from '../../with-schemas/index.d.ts';
 
 /**
- * The PartyKitPersister interface is a minor extension to the Persister
- * interface.
+ * The PartyKitPersister interface represents a Persister that lets you save and
+ * load Store data from the client to the durable PartyKit cloud storage of a
+ * server.
  *
- * It simply provides an extra getConnection method for accessing the
- * PartySocket the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getConnection method for accessing the PartySocket the Store is being
+ * persisted to.
  *
  * You should use the createPartyKitPersister function to create a
  * PartyKitPersister object.
@@ -119,9 +121,9 @@ export type PartyKitPersisterConfig = {
 };
 
 /**
- * The createPartyKitPersister function creates a Persister object that can
- * persist the Store to durable PartyKit storage, enabling synchronization of
- * the same Store across multiple clients.
+ * The createPartyKitPersister function creates a PartyKitPersister object that
+ * can persist the Store to durable PartyKit storage, enabling synchronization
+ * of the same Store across multiple clients.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -134,6 +136,9 @@ export type PartyKitPersisterConfig = {
  * ): PartyKitPersister;
  * ```
  *
+ * A PartyKitPersister 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
  * `connection` parameter which is a PartyKit PartySocket that you have already
  * instantiated with details of the host and room.

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

@@ -13,11 +13,13 @@ import type {AbstractPowerSyncDatabase} from '@journeyapps/powersync-sdk-common'
 import type {Store} from '../../store/index.d.cts';
 
 /**
- * The PowerSyncPersister interface is a minor extension to the Persister
- * interface.
+ * The PowerSyncPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local SQLite database that is automatically
+ * synced using the PowerSync service.
  *
- * It simply provides an extra getPowerSync method for accessing a reference to
- * the PowerSync instance the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getPowerSync method for accessing a reference to the PowerSync instance
+ * the Store is being persisted to.
  *
  * You should use the createPowerSyncPersister function to create a
  * PowerSyncPersister object.
@@ -53,9 +55,12 @@ export interface PowerSyncPersister extends Persister {
 }
 
 /**
- * The createPowerSyncPersister function creates a Persister object that can
- * persist the Store to a local SQLite database that is automatically synced
- * using the PowerSync service.
+ * The createPowerSyncPersister function creates a PowerSyncPersister object
+ * that can persist the Store to a local SQLite database that is automatically
+ * synced using the PowerSync service.
+ *
+ * A PowerSyncPersister 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
  * `powerSync` parameter which identifies the PowerSync instance.

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

@@ -13,11 +13,13 @@ import type {AbstractPowerSyncDatabase} from '@journeyapps/powersync-sdk-common'
 import type {Store} from '../../store/index.d.ts';
 
 /**
- * The PowerSyncPersister interface is a minor extension to the Persister
- * interface.
+ * The PowerSyncPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local SQLite database that is automatically
+ * synced using the PowerSync service.
  *
- * It simply provides an extra getPowerSync method for accessing a reference to
- * the PowerSync instance the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getPowerSync method for accessing a reference to the PowerSync instance
+ * the Store is being persisted to.
  *
  * You should use the createPowerSyncPersister function to create a
  * PowerSyncPersister object.
@@ -53,9 +55,12 @@ export interface PowerSyncPersister extends Persister {
 }
 
 /**
- * The createPowerSyncPersister function creates a Persister object that can
- * persist the Store to a local SQLite database that is automatically synced
- * using the PowerSync service.
+ * The createPowerSyncPersister function creates a PowerSyncPersister object
+ * that can persist the Store to a local SQLite database that is automatically
+ * synced using the PowerSync service.
+ *
+ * A PowerSyncPersister 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
  * `powerSync` parameter which identifies the PowerSync instance.

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

@@ -19,11 +19,13 @@ import type {
 import type {AbstractPowerSyncDatabase} from '@journeyapps/powersync-sdk-common';
 
 /**
- * The PowerSyncPersister interface is a minor extension to the Persister
- * interface.
+ * The PowerSyncPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local SQLite database that is automatically
+ * synced using the PowerSync service.
  *
- * It simply provides an extra getPowerSync method for accessing a reference to
- * the PowerSync instance the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getPowerSync method for accessing a reference to the PowerSync instance
+ * the Store is being persisted to.
  *
  * You should use the createPowerSyncPersister function to create a
  * PowerSyncPersister object.
@@ -60,9 +62,9 @@ export interface PowerSyncPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createPowerSyncPersister function creates a Persister object that can
- * persist the Store to a local SQLite database that is automatically synced
- * using the PowerSync service.
+ * The createPowerSyncPersister function creates a PowerSyncPersister object
+ * that can persist the Store to a local SQLite database that is automatically
+ * synced using the PowerSync service.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -76,6 +78,9 @@ export interface PowerSyncPersister<Schemas extends OptionalSchemas>
  * ): PowerSyncPersister;
  * ```
  *
+ * A PowerSyncPersister 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
  * `powerSync` parameter which identifies the PowerSync instance.
  *

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

@@ -19,11 +19,13 @@ import type {
 import type {AbstractPowerSyncDatabase} from '@journeyapps/powersync-sdk-common';
 
 /**
- * The PowerSyncPersister interface is a minor extension to the Persister
- * interface.
+ * The PowerSyncPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local SQLite database that is automatically
+ * synced using the PowerSync service.
  *
- * It simply provides an extra getPowerSync method for accessing a reference to
- * the PowerSync instance the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getPowerSync method for accessing a reference to the PowerSync instance
+ * the Store is being persisted to.
  *
  * You should use the createPowerSyncPersister function to create a
  * PowerSyncPersister object.
@@ -60,9 +62,9 @@ export interface PowerSyncPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createPowerSyncPersister function creates a Persister object that can
- * persist the Store to a local SQLite database that is automatically synced
- * using the PowerSync service.
+ * The createPowerSyncPersister function creates a PowerSyncPersister object
+ * that can persist the Store to a local SQLite database that is automatically
+ * synced using the PowerSync service.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -76,6 +78,9 @@ export interface PowerSyncPersister<Schemas extends OptionalSchemas>
  * ): PowerSyncPersister;
  * ```
  *
+ * A PowerSyncPersister 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
  * `powerSync` parameter which identifies the PowerSync instance.
  *

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

@@ -10,11 +10,11 @@ import type {Persister} from '../index.d.cts';
 import type {Store} from '../../store/index.d.cts';
 
 /**
- * The RemotePersister interface is a minor extension to the Persister
- * interface.
+ * The RemotePersister interface represents a Persister that lets you save and
+ * load Store data to and from a remote server.
  *
- * It simply provides an extra getUrls method for accessing the URLs the Store
- * is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getUrls method for accessing the URLs the Store is being persisted to.
  *
  * You should use the createRemotePersister function to create a RemotePersister
  * object.
@@ -53,18 +53,21 @@ export interface RemotePersister extends Persister {
 }
 
 /**
- * The createRemotePersister function creates a Persister object that can
+ * The createRemotePersister function creates a RemotePersister object that can
  * persist the Store to a remote server.
  *
+ * A RemotePersister 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
  * `loadUrl` and `saveUrl` parameters. These identify the endpoints of the
  * server that support the `GET` method (to fetch the Store JSON to load) and
  * the `POST` method (to send the Store JSON to save) respectively.
  *
  * For when you choose to enable automatic loading for the Persister (with the
- * startAutoLoad method), it will poll the loadUrl for changes, using the
- * `ETag` HTTP header to identify if things have changed. The
- * `autoLoadIntervalSeconds` method is used to indicate how often to do this.
+ * startAutoLoad method), it will poll the loadUrl for changes, using the `ETag`
+ * HTTP header to identify if things have changed. The `autoLoadIntervalSeconds`
+ * method is used to indicate how often to do this.
  *
  * If you are implementing the server portion of this functionality yourself,
  * remember to ensure that the `ETag` header changes every time the server's

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

@@ -10,11 +10,11 @@ import type {Persister} from '../index.d.ts';
 import type {Store} from '../../store/index.d.ts';
 
 /**
- * The RemotePersister interface is a minor extension to the Persister
- * interface.
+ * The RemotePersister interface represents a Persister that lets you save and
+ * load Store data to and from a remote server.
  *
- * It simply provides an extra getUrls method for accessing the URLs the Store
- * is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getUrls method for accessing the URLs the Store is being persisted to.
  *
  * You should use the createRemotePersister function to create a RemotePersister
  * object.
@@ -53,18 +53,21 @@ export interface RemotePersister extends Persister {
 }
 
 /**
- * The createRemotePersister function creates a Persister object that can
+ * The createRemotePersister function creates a RemotePersister object that can
  * persist the Store to a remote server.
  *
+ * A RemotePersister 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
  * `loadUrl` and `saveUrl` parameters. These identify the endpoints of the
  * server that support the `GET` method (to fetch the Store JSON to load) and
  * the `POST` method (to send the Store JSON to save) respectively.
  *
  * For when you choose to enable automatic loading for the Persister (with the
- * startAutoLoad method), it will poll the loadUrl for changes, using the
- * `ETag` HTTP header to identify if things have changed. The
- * `autoLoadIntervalSeconds` method is used to indicate how often to do this.
+ * startAutoLoad method), it will poll the loadUrl for changes, using the `ETag`
+ * HTTP header to identify if things have changed. The `autoLoadIntervalSeconds`
+ * method is used to indicate how often to do this.
  *
  * If you are implementing the server portion of this functionality yourself,
  * remember to ensure that the `ETag` header changes every time the server's

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

@@ -13,11 +13,11 @@ import type {
 import type {Persister} from '../../with-schemas/index.d.cts';
 
 /**
- * The RemotePersister interface is a minor extension to the Persister
- * interface.
+ * The RemotePersister interface represents a Persister that lets you save and
+ * load Store data to and from a remote server.
  *
- * It simply provides an extra getUrls method for accessing the URLs the Store
- * is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getUrls method for accessing the URLs the Store is being persisted to.
  *
  * You should use the createRemotePersister function to create a RemotePersister
  * object.
@@ -57,7 +57,7 @@ export interface RemotePersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createRemotePersister function creates a Persister object that can
+ * The createRemotePersister function creates a RemotePersister object that can
  * persist the Store to a remote server.
  *
  * This has schema-based typing. The following is a simplified representation:
@@ -72,15 +72,18 @@ export interface RemotePersister<Schemas extends OptionalSchemas>
  * ): RemotePersister;
  * ```
  *
+ * A RemotePersister 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
  * `loadUrl` and `saveUrl` parameters. These identify the endpoints of the
  * server that support the `GET` method (to fetch the Store JSON to load) and
  * the `POST` method (to send the Store JSON to save) respectively.
  *
  * For when you choose to enable automatic loading for the Persister (with the
- * startAutoLoad method), it will poll the loadUrl for changes, using the
- * `ETag` HTTP header to identify if things have changed. The
- * `autoLoadIntervalSeconds` method is used to indicate how often to do this.
+ * startAutoLoad method), it will poll the loadUrl for changes, using the `ETag`
+ * HTTP header to identify if things have changed. The `autoLoadIntervalSeconds`
+ * method is used to indicate how often to do this.
  *
  * If you are implementing the server portion of this functionality yourself,
  * remember to ensure that the `ETag` header changes every time the server's

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

@@ -13,11 +13,11 @@ import type {
 import type {Persister} from '../../with-schemas/index.d.ts';
 
 /**
- * The RemotePersister interface is a minor extension to the Persister
- * interface.
+ * The RemotePersister interface represents a Persister that lets you save and
+ * load Store data to and from a remote server.
  *
- * It simply provides an extra getUrls method for accessing the URLs the Store
- * is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getUrls method for accessing the URLs the Store is being persisted to.
  *
  * You should use the createRemotePersister function to create a RemotePersister
  * object.
@@ -57,7 +57,7 @@ export interface RemotePersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createRemotePersister function creates a Persister object that can
+ * The createRemotePersister function creates a RemotePersister object that can
  * persist the Store to a remote server.
  *
  * This has schema-based typing. The following is a simplified representation:
@@ -72,15 +72,18 @@ export interface RemotePersister<Schemas extends OptionalSchemas>
  * ): RemotePersister;
  * ```
  *
+ * A RemotePersister 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
  * `loadUrl` and `saveUrl` parameters. These identify the endpoints of the
  * server that support the `GET` method (to fetch the Store JSON to load) and
  * the `POST` method (to send the Store JSON to save) respectively.
  *
  * For when you choose to enable automatic loading for the Persister (with the
- * startAutoLoad method), it will poll the loadUrl for changes, using the
- * `ETag` HTTP header to identify if things have changed. The
- * `autoLoadIntervalSeconds` method is used to indicate how often to do this.
+ * startAutoLoad method), it will poll the loadUrl for changes, using the `ETag`
+ * HTTP header to identify if things have changed. The `autoLoadIntervalSeconds`
+ * method is used to indicate how often to do this.
  *
  * If you are implementing the server portion of this functionality yourself,
  * remember to ensure that the `ETag` header changes every time the server's

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

@@ -13,11 +13,12 @@ import type {MergeableStore} from '../../mergeable-store/index.d.cts';
 import type {Store} from '../../store/index.d.cts';
 
 /**
- * The SqliteWasmPersister interface is a minor extension to the Persister
- * interface.
+ * The SqliteWasmPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local 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 createSqliteWasmPersister function to create a
  * SqliteWasmPersister object.
@@ -61,8 +62,12 @@ export interface SqliteWasmPersister
 }
 
 /**
- * The createSqliteWasmPersister function creates a Persister object that can
- * persist the Store to a local SQLite database (in an appropriate environment).
+ * The createSqliteWasmPersister function creates a SqliteWasmPersister object
+ * that can persist the Store to a local SQLite database.
+ *
+ * A SqliteWasmPersister 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.
  *
  * As well as providing a reference to the Store to persist, you must provide
  * `sqlite3` and `db` parameters which identify the WASM module and database
@@ -79,7 +84,7 @@ export interface SqliteWasmPersister
  *
  * 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 sqlite3 The WASM module that was returned from `sqlite3InitModule`.
  * @param db The database instance that was returned from `new
  * sqlite3.oo1.DB(...)`.

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

@@ -13,11 +13,12 @@ import type {MergeableStore} from '../../mergeable-store/index.d.ts';
 import type {Store} from '../../store/index.d.ts';
 
 /**
- * The SqliteWasmPersister interface is a minor extension to the Persister
- * interface.
+ * The SqliteWasmPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local 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 createSqliteWasmPersister function to create a
  * SqliteWasmPersister object.
@@ -61,8 +62,12 @@ export interface SqliteWasmPersister
 }
 
 /**
- * The createSqliteWasmPersister function creates a Persister object that can
- * persist the Store to a local SQLite database (in an appropriate environment).
+ * The createSqliteWasmPersister function creates a SqliteWasmPersister object
+ * that can persist the Store to a local SQLite database.
+ *
+ * A SqliteWasmPersister 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.
  *
  * As well as providing a reference to the Store to persist, you must provide
  * `sqlite3` and `db` parameters which identify the WASM module and database
@@ -79,7 +84,7 @@ export interface SqliteWasmPersister
  *
  * 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 sqlite3 The WASM module that was returned from `sqlite3InitModule`.
  * @param db The database instance that was returned from `new
  * sqlite3.oo1.DB(...)`.

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

@@ -20,11 +20,12 @@ import type {
 import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.cts';
 
 /**
- * The SqliteWasmPersister interface is a minor extension to the Persister
- * interface.
+ * The SqliteWasmPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local 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 createSqliteWasmPersister function to create a
  * SqliteWasmPersister object.
@@ -68,8 +69,8 @@ export interface SqliteWasmPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createSqliteWasmPersister function creates a Persister object that can
- * persist the Store to a local SQLite database (in an appropriate environment).
+ * The createSqliteWasmPersister function creates a SqliteWasmPersister object
+ * that can persist the Store to a local SQLite database.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -84,6 +85,10 @@ export interface SqliteWasmPersister<Schemas extends OptionalSchemas>
  * ): SqliteWasmPersister;
  * ```
  *
+ * A SqliteWasmPersister 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.
+ *
  * As well as providing a reference to the Store to persist, you must provide
  * `sqlite3` and `db` parameters which identify the WASM module and database
  * instance respectively.
@@ -99,7 +104,7 @@ export interface SqliteWasmPersister<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 sqlite3 The WASM module that was returned from `sqlite3InitModule`.
  * @param db The database instance that was returned from `new
  * sqlite3.oo1.DB(...)`.

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

@@ -20,11 +20,12 @@ import type {
 import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.ts';
 
 /**
- * The SqliteWasmPersister interface is a minor extension to the Persister
- * interface.
+ * The SqliteWasmPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local 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 createSqliteWasmPersister function to create a
  * SqliteWasmPersister object.
@@ -68,8 +69,8 @@ export interface SqliteWasmPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createSqliteWasmPersister function creates a Persister object that can
- * persist the Store to a local SQLite database (in an appropriate environment).
+ * The createSqliteWasmPersister function creates a SqliteWasmPersister object
+ * that can persist the Store to a local SQLite database.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -84,6 +85,10 @@ export interface SqliteWasmPersister<Schemas extends OptionalSchemas>
  * ): SqliteWasmPersister;
  * ```
  *
+ * A SqliteWasmPersister 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.
+ *
  * As well as providing a reference to the Store to persist, you must provide
  * `sqlite3` and `db` parameters which identify the WASM module and database
  * instance respectively.
@@ -99,7 +104,7 @@ export interface SqliteWasmPersister<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 sqlite3 The WASM module that was returned from `sqlite3InitModule`.
  * @param db The database instance that was returned from `new
  * sqlite3.oo1.DB(...)`.