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

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

@@ -13,11 +13,12 @@ import type {
 import type {Persister} from '../../with-schemas/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.
@@ -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.

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

@@ -13,11 +13,12 @@ import type {Client} from '@libsql/client';
 import type {Store} from '../../store/index.d.cts';
 
 /**
- * The LibSqlPersister interface is a minor extension to the Persister
- * interface.
+ * The LibSqlPersister interface represents a Persister that lets you save and
+ * load Store data to and from a local LibSQL database.
  *
- * It simply provides an extra getClient method for accessing a reference to the
- * database client the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getClient method for accessing a reference to the database client the
+ * Store is being persisted to.
  *
  * You should use the createLibSqlPersister function to create a LibSqlPersister
  * object.
@@ -53,8 +54,11 @@ export interface LibSqlPersister extends Persister {
 }
 
 /**
- * The createLibSqlPersister function creates a Persister object that can
- * persist the Store to a local LibSQL database (in an appropriate environment).
+ * The createLibSqlPersister function creates a LibSqlPersister object that can
+ * persist a Store to a local LibSQL database.
+ *
+ * A LibSqlPersister 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
  * `client` parameter which identifies the database client.

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

@@ -13,11 +13,12 @@ import type {Client} from '@libsql/client';
 import type {Store} from '../../store/index.d.ts';
 
 /**
- * The LibSqlPersister interface is a minor extension to the Persister
- * interface.
+ * The LibSqlPersister interface represents a Persister that lets you save and
+ * load Store data to and from a local LibSQL database.
  *
- * It simply provides an extra getClient method for accessing a reference to the
- * database client the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getClient method for accessing a reference to the database client the
+ * Store is being persisted to.
  *
  * You should use the createLibSqlPersister function to create a LibSqlPersister
  * object.
@@ -53,8 +54,11 @@ export interface LibSqlPersister extends Persister {
 }
 
 /**
- * The createLibSqlPersister function creates a Persister object that can
- * persist the Store to a local LibSQL database (in an appropriate environment).
+ * The createLibSqlPersister function creates a LibSqlPersister object that can
+ * persist a Store to a local LibSQL database.
+ *
+ * A LibSqlPersister 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
  * `client` parameter which identifies the database client.

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

@@ -19,11 +19,12 @@ import type {
 import type {Client} from '@libsql/client';
 
 /**
- * The LibSqlPersister interface is a minor extension to the Persister
- * interface.
+ * The LibSqlPersister interface represents a Persister that lets you save and
+ * load Store data to and from a local LibSQL database.
  *
- * It simply provides an extra getClient method for accessing a reference to the
- * database client the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getClient method for accessing a reference to the database client the
+ * Store is being persisted to.
  *
  * You should use the createLibSqlPersister function to create a LibSqlPersister
  * object.
@@ -60,8 +61,8 @@ export interface LibSqlPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createLibSqlPersister function creates a Persister object that can
- * persist the Store to a local LibSQL database (in an appropriate environment).
+ * The createLibSqlPersister function creates a LibSqlPersister object that can
+ * persist a Store to a local LibSQL database.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -75,6 +76,9 @@ export interface LibSqlPersister<Schemas extends OptionalSchemas>
  * ): LibSqlPersister;
  * ```
  *
+ * A LibSqlPersister 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
  * `client` parameter which identifies the database client.
  *

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

@@ -19,11 +19,12 @@ import type {
 import type {Client} from '@libsql/client';
 
 /**
- * The LibSqlPersister interface is a minor extension to the Persister
- * interface.
+ * The LibSqlPersister interface represents a Persister that lets you save and
+ * load Store data to and from a local LibSQL database.
  *
- * It simply provides an extra getClient method for accessing a reference to the
- * database client the Store is being persisted to.
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getClient method for accessing a reference to the database client the
+ * Store is being persisted to.
  *
  * You should use the createLibSqlPersister function to create a LibSqlPersister
  * object.
@@ -60,8 +61,8 @@ export interface LibSqlPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createLibSqlPersister function creates a Persister object that can
- * persist the Store to a local LibSQL database (in an appropriate environment).
+ * The createLibSqlPersister function creates a LibSqlPersister object that can
+ * persist a Store to a local LibSQL database.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -75,6 +76,9 @@ export interface LibSqlPersister<Schemas extends OptionalSchemas>
  * ): LibSqlPersister;
  * ```
  *
+ * A LibSqlPersister 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
  * `client` parameter which identifies the database client.
  *

package/@types/persisters/persister-partykit-client/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
@@ -23,11 +23,13 @@ import type {Persister} from '../index.d.cts';
 import type {Store} from '../../store/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.
@@ -115,9 +117,12 @@ 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.
+ *
+ * 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

package/@types/persisters/persister-partykit-client/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
@@ -23,11 +23,13 @@ import type {Persister} from '../index.d.ts';
 import type {Store} from '../../store/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.
@@ -115,9 +117,12 @@ 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.
+ *
+ * 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

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-partykit-server/index.d.cts

@@ -88,7 +88,7 @@ export type TinyBasePartyKitServerConfig = {
   storagePrefix?: string;
   /**
    * An object containing the extra HTTP(S) headers returned to the client from
-   * this server. This defaults to the following three headers to allow CORS:
+   * this server. This defaults to the following three headers to allow CORS.
    *
    * ```
    * Access-Control-Allow-Origin: *
@@ -174,7 +174,7 @@ export class TinyBasePartyKitServer implements Server {
    *
    * If you choose to implement additional functionality in this method, you
    * must remember to call the super implementation to ensure the TinyBase
-   * synchronization stays supported:
+   * synchronization stays supported.
    *
    * ```js
    * import {TinyBasePartyKitServer} from 'tinybase/persisters/persister-partykit-server';
@@ -200,7 +200,7 @@ export class TinyBasePartyKitServer implements Server {
    *
    * If you choose to implement additional functionality in this method, you
    * must remember to call the super implementation to ensure the TinyBase
-   * synchronization stays supported:
+   * synchronization stays supported.
    *
    * ```js
    * import {TinyBasePartyKitServer} from 'tinybase/persisters/persister-partykit-server';

package/@types/persisters/persister-partykit-server/index.d.ts

@@ -88,7 +88,7 @@ export type TinyBasePartyKitServerConfig = {
   storagePrefix?: string;
   /**
    * An object containing the extra HTTP(S) headers returned to the client from
-   * this server. This defaults to the following three headers to allow CORS:
+   * this server. This defaults to the following three headers to allow CORS.
    *
    * ```
    * Access-Control-Allow-Origin: *
@@ -174,7 +174,7 @@ export class TinyBasePartyKitServer implements Server {
    *
    * If you choose to implement additional functionality in this method, you
    * must remember to call the super implementation to ensure the TinyBase
-   * synchronization stays supported:
+   * synchronization stays supported.
    *
    * ```js
    * import {TinyBasePartyKitServer} from 'tinybase/persisters/persister-partykit-server';
@@ -200,7 +200,7 @@ export class TinyBasePartyKitServer implements Server {
    *
    * If you choose to implement additional functionality in this method, you
    * must remember to call the super implementation to ensure the TinyBase
-   * synchronization stays supported:
+   * synchronization stays supported.
    *
    * ```js
    * import {TinyBasePartyKitServer} from 'tinybase/persisters/persister-partykit-server';

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

@@ -85,7 +85,7 @@ export type TinyBasePartyKitServerConfig = {
   storagePrefix?: string;
   /**
    * An object containing the extra HTTP(S) headers returned to the client from
-   * this server. This defaults to the following three headers to allow CORS:
+   * this server. This defaults to the following three headers to allow CORS.
    *
    * ```
    * Access-Control-Allow-Origin: *
@@ -171,7 +171,7 @@ export class TinyBasePartyKitServer implements Server {
    *
    * If you choose to implement additional functionality in this method, you
    * must remember to call the super implementation to ensure the TinyBase
-   * synchronization stays supported:
+   * synchronization stays supported.
    *
    * ```js
    * import {TinyBasePartyKitServer} from 'tinybase/persisters/persister-partykit-server';
@@ -197,7 +197,7 @@ export class TinyBasePartyKitServer implements Server {
    *
    * If you choose to implement additional functionality in this method, you
    * must remember to call the super implementation to ensure the TinyBase
-   * synchronization stays supported:
+   * synchronization stays supported.
    *
    * ```js
    * import {TinyBasePartyKitServer} from 'tinybase/persisters/persister-partykit-server';

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

@@ -85,7 +85,7 @@ export type TinyBasePartyKitServerConfig = {
   storagePrefix?: string;
   /**
    * An object containing the extra HTTP(S) headers returned to the client from
-   * this server. This defaults to the following three headers to allow CORS:
+   * this server. This defaults to the following three headers to allow CORS.
    *
    * ```
    * Access-Control-Allow-Origin: *
@@ -171,7 +171,7 @@ export class TinyBasePartyKitServer implements Server {
    *
    * If you choose to implement additional functionality in this method, you
    * must remember to call the super implementation to ensure the TinyBase
-   * synchronization stays supported:
+   * synchronization stays supported.
    *
    * ```js
    * import {TinyBasePartyKitServer} from 'tinybase/persisters/persister-partykit-server';
@@ -197,7 +197,7 @@ export class TinyBasePartyKitServer implements Server {
    *
    * If you choose to implement additional functionality in this method, you
    * must remember to call the super implementation to ensure the TinyBase
-   * synchronization stays supported:
+   * synchronization stays supported.
    *
    * ```js
    * import {TinyBasePartyKitServer} from 'tinybase/persisters/persister-partykit-server';

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.
  *