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

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

@@ -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.ts';
@@ -11,13 +12,15 @@ import type {MergeableStore} from '../../mergeable-store/index.d.ts';
 import type {Store} from '../../store/index.d.ts';
 
 /**
- * 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,

package/@types/persisters/persister-file/with-schemas/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 {
@@ -14,13 +15,15 @@ import type {Persister, Persists} from '../../with-schemas/index.d.cts';
 import type {MergeableStore} from '../../../mergeable-store/with-schemas/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
  */
@@ -53,8 +56,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 +69,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
@@ -94,6 +99,7 @@ export interface FilePersister<Schemas extends OptionalSchemas>
  * persister.destroy();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createFilePersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas> | MergeableStore<Schemas>,

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

@@ -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 {
@@ -14,13 +15,15 @@ import type {Persister, Persists} from '../../with-schemas/index.d.ts';
 import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.ts';
 
 /**
- * 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
  */
@@ -53,8 +56,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 +69,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
@@ -94,6 +99,7 @@ export interface FilePersister<Schemas extends OptionalSchemas>
  * persister.destroy();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createFilePersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas> | MergeableStore<Schemas>,

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

@@ -1,23 +1,25 @@
 /**
  * The persister-indexed-db module of the TinyBase project lets you save and
  * load Store data to and from browser IndexedDB storage.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-indexed-db
+ * @since v4.2.0
  */
 
 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.
- *
- * It simply provides an extra getDbName method for accessing the unique key of
- * the IndexedDB the Store is being persisted to.
+ * The IndexedDbPersister interface represents a Persister that lets you save
+ * and load Store data to and from browser IndexedDB storage.
  *
  * You should use the createIndexedDbPersister function to create an
  * IndexedDbPersister object.
+ *
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -49,8 +51,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

@@ -1,23 +1,25 @@
 /**
  * The persister-indexed-db module of the TinyBase project lets you save and
  * load Store data to and from browser IndexedDB storage.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-indexed-db
+ * @since v4.2.0
  */
 
 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.
- *
- * It simply provides an extra getDbName method for accessing the unique key of
- * the IndexedDB the Store is being persisted to.
+ * The IndexedDbPersister interface represents a Persister that lets you save
+ * and load Store data to and from browser IndexedDB storage.
  *
  * You should use the createIndexedDbPersister function to create an
  * IndexedDbPersister object.
+ *
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -49,8 +51,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

@@ -1,9 +1,10 @@
 /**
  * The persister-indexed-db module of the TinyBase project lets you save and
  * load Store data to and from browser IndexedDB storage.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-indexed-db
+ * @since v4.2.0
  */
 
 import type {
@@ -13,14 +14,15 @@ import type {
 import type {Persister} from '../../with-schemas/index.d.cts';
 
 /**
- * The IndexedDbPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getDbName method for accessing the unique key of
- * the IndexedDB the Store is being persisted to.
+ * The IndexedDbPersister interface represents a Persister that lets you save
+ * and load Store data to and from browser IndexedDB storage.
  *
  * You should use the createIndexedDbPersister function to create an
  * IndexedDbPersister object.
+ *
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -53,8 +55,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 +69,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-indexed-db/with-schemas/index.d.ts

@@ -1,9 +1,10 @@
 /**
  * The persister-indexed-db module of the TinyBase project lets you save and
  * load Store data to and from browser IndexedDB storage.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-indexed-db
+ * @since v4.2.0
  */
 
 import type {
@@ -13,14 +14,15 @@ import type {
 import type {Persister} from '../../with-schemas/index.d.ts';
 
 /**
- * The IndexedDbPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getDbName method for accessing the unique key of
- * the IndexedDB the Store is being persisted to.
+ * The IndexedDbPersister interface represents a Persister that lets you save
+ * and load Store data to and from browser IndexedDB storage.
  *
  * You should use the createIndexedDbPersister function to create an
  * IndexedDbPersister object.
+ *
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -53,8 +55,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 +69,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

@@ -2,7 +2,7 @@
  * The persister-libsql module of the TinyBase project lets you save and load
  * Store data to and from a local LibSQL database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-libsql
  * @since v4.7.0
@@ -13,14 +13,16 @@ 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.
- *
- * It simply provides an extra getClient method for accessing a reference to the
- * database client the Store is being persisted to.
+ * The LibSqlPersister interface represents a Persister that lets you save and
+ * load Store data to and from a local LibSQL database.
  *
  * You should use the createLibSqlPersister function to create a LibSqlPersister
  * object.
+ *
+ * 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.
+ * @category Persister
  * @since v4.7.0
  */
 export interface LibSqlPersister extends Persister {
@@ -53,8 +55,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

@@ -2,7 +2,7 @@
  * The persister-libsql module of the TinyBase project lets you save and load
  * Store data to and from a local LibSQL database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-libsql
  * @since v4.7.0
@@ -13,14 +13,16 @@ 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.
- *
- * It simply provides an extra getClient method for accessing a reference to the
- * database client the Store is being persisted to.
+ * The LibSqlPersister interface represents a Persister that lets you save and
+ * load Store data to and from a local LibSQL database.
  *
  * You should use the createLibSqlPersister function to create a LibSqlPersister
  * object.
+ *
+ * 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.
+ * @category Persister
  * @since v4.7.0
  */
 export interface LibSqlPersister extends Persister {
@@ -53,8 +55,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

@@ -2,7 +2,7 @@
  * The persister-libsql module of the TinyBase project lets you save and load
  * Store data to and from a local LibSQL database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-libsql
  * @since v4.7.0
@@ -19,14 +19,16 @@ import type {
 import type {Client} from '@libsql/client';
 
 /**
- * The LibSqlPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getClient method for accessing a reference to the
- * database client the Store is being persisted to.
+ * The LibSqlPersister interface represents a Persister that lets you save and
+ * load Store data to and from a local LibSQL database.
  *
  * You should use the createLibSqlPersister function to create a LibSqlPersister
  * object.
+ *
+ * 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.
+ * @category Persister
  * @since v4.7.0
  */
 export interface LibSqlPersister<Schemas extends OptionalSchemas>
@@ -60,8 +62,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 +77,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

@@ -2,7 +2,7 @@
  * The persister-libsql module of the TinyBase project lets you save and load
  * Store data to and from a local LibSQL database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-libsql
  * @since v4.7.0
@@ -19,14 +19,16 @@ import type {
 import type {Client} from '@libsql/client';
 
 /**
- * The LibSqlPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getClient method for accessing a reference to the
- * database client the Store is being persisted to.
+ * The LibSqlPersister interface represents a Persister that lets you save and
+ * load Store data to and from a local LibSQL database.
  *
  * You should use the createLibSqlPersister function to create a LibSqlPersister
  * object.
+ *
+ * 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.
+ * @category Persister
  * @since v4.7.0
  */
 export interface LibSqlPersister<Schemas extends OptionalSchemas>
@@ -60,8 +62,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 +77,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
@@ -12,10 +12,10 @@
  *
  * Note that both the client and server parts of this Persister are currently
  * experimental as PartyKit is new and still maturing.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-partykit-client
- * @since 4.3.0
+ * @since v4.3.0
  */
 
 import type {PartySocket} from 'partysocket';
@@ -23,14 +23,16 @@ 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.
- *
- * It simply provides an extra getConnection method for accessing the
- * PartySocket the Store is being persisted to.
+ * 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.
  *
  * You should use the createPartyKitPersister function to create a
  * PartyKitPersister object.
+ *
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -95,12 +97,16 @@ export type PartyKitPersisterConfig = {
    * The HTTP protocol to use (in addition to the websocket channel). This
    * defaults to 'https' but you may wish to use 'http' for local PartyKit
    * development.
+   * @category Configuration
+   * @since v4.3.0
    */
   storeProtocol?: 'http' | 'https';
   /**
    * The path used to set and get the whole Store over HTTP(S) on the server.
    * This must match the storePath property of the TinyBasePartyKitServerConfig
    * object used on the server. Both default to '/store'.
+   * @category Configuration
+   * @since v4.3.0
    */
   storePath?: string;
   /**
@@ -110,14 +116,19 @@ export type PartyKitPersisterConfig = {
    * This must match the messagePrefix property of the
    * TinyBasePartyKitServerConfig object used on the server. Both default to an
    * empty string.
+   * @category Configuration
+   * @since v4.3.0
    */
   messagePrefix?: string;
 };
 
 /**
- * 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
@@ -175,7 +186,7 @@ export type PartyKitPersisterConfig = {
  * persister.destroy();
  * ```
  * @category Creation
- * @since 4.3.0
+ * @since v4.3.0
  */
 export function createPartyKitPersister(
   store: Store,