tinybase 5.0.0-beta.27 → 5.0.0-beta.28

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

@@ -11,10 +11,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-server
- * @since 4.3.0
+ * @since v4.3.0
  */
 
 import type {
@@ -67,6 +67,8 @@ export type TinyBasePartyKitServerConfig = {
    * The path used to set and get the whole Store over HTTP(S) on the server.
    * This must match the storePath property of the PartyKitPersisterConfig used
    * on the client. Both default to '/store'.
+   * @category Configuration
+   * @since v4.3.0
    */
   storePath?: string;
   /**
@@ -75,12 +77,16 @@ export type TinyBasePartyKitServerConfig = {
    * not collide with any other message syntax that your room is using. This
    * must match the messagePrefix property of the PartyKitPersisterConfig object
    * used on the client. Both default to an empty string.
+   * @category Configuration
+   * @since v4.3.0
    */
   messagePrefix?: string;
   /**
    * The prefix used before all the keys in the server's durable storage. Use
    * this in case you are worried about the Store data colliding with other data
    * stored in the room. Defaults to an empty string.
+   * @category Configuration
+   * @since v4.3.0
    */
   storagePrefix?: string;
   /**
@@ -96,6 +102,8 @@ export type TinyBasePartyKitServerConfig = {
    * If you set this field, it will override the default completely. So, for
    * example, if you add another header but still want the CORS defaults, you
    * will need to explicitly set the Access-Control-Allow headers above again.
+   * @category Configuration
+   * @since v4.3.0
    */
   responseHeaders?: HeadersInit;
 };
@@ -146,7 +154,7 @@ export type TinyBasePartyKitServerConfig = {
  * See the [PartyKit server API
  * documentation](https://docs.partykit.io/reference/partyserver-api/) for
  * more details.
- * @category Creation
+ * @category Server
  * @since v4.3.0
  */
 export class TinyBasePartyKitServer implements Server {

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

@@ -11,10 +11,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-server
- * @since 4.3.0
+ * @since v4.3.0
  */
 
 import type {
@@ -67,6 +67,8 @@ export type TinyBasePartyKitServerConfig = {
    * The path used to set and get the whole Store over HTTP(S) on the server.
    * This must match the storePath property of the PartyKitPersisterConfig used
    * on the client. Both default to '/store'.
+   * @category Configuration
+   * @since v4.3.0
    */
   storePath?: string;
   /**
@@ -75,12 +77,16 @@ export type TinyBasePartyKitServerConfig = {
    * not collide with any other message syntax that your room is using. This
    * must match the messagePrefix property of the PartyKitPersisterConfig object
    * used on the client. Both default to an empty string.
+   * @category Configuration
+   * @since v4.3.0
    */
   messagePrefix?: string;
   /**
    * The prefix used before all the keys in the server's durable storage. Use
    * this in case you are worried about the Store data colliding with other data
    * stored in the room. Defaults to an empty string.
+   * @category Configuration
+   * @since v4.3.0
    */
   storagePrefix?: string;
   /**
@@ -96,6 +102,8 @@ export type TinyBasePartyKitServerConfig = {
    * If you set this field, it will override the default completely. So, for
    * example, if you add another header but still want the CORS defaults, you
    * will need to explicitly set the Access-Control-Allow headers above again.
+   * @category Configuration
+   * @since v4.3.0
    */
   responseHeaders?: HeadersInit;
 };
@@ -146,7 +154,7 @@ export type TinyBasePartyKitServerConfig = {
  * See the [PartyKit server API
  * documentation](https://docs.partykit.io/reference/partyserver-api/) for
  * more details.
- * @category Creation
+ * @category Server
  * @since v4.3.0
  */
 export class TinyBasePartyKitServer implements Server {

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

@@ -2,7 +2,7 @@
  * The persister-powersync module of the TinyBase project lets you save and load
  * Store data to and from a local SQLite database that is automatically synced
  * using the PowerSync service.
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-powersync
  * @since v4.8.0
@@ -17,12 +17,13 @@ import type {Store} from '../../store/index.d.cts';
  * and load Store data to and from a local SQLite database that is automatically
  * synced using the PowerSync service.
  *
+ * You should use the createPowerSyncPersister function to create a
+ * PowerSyncPersister object.
+ *
  * 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.
+ * @category Persister
  * @since v4.8.0
  */
 export interface PowerSyncPersister extends Persister {

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

@@ -2,7 +2,7 @@
  * The persister-powersync module of the TinyBase project lets you save and load
  * Store data to and from a local SQLite database that is automatically synced
  * using the PowerSync service.
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-powersync
  * @since v4.8.0
@@ -17,12 +17,13 @@ import type {Store} from '../../store/index.d.ts';
  * and load Store data to and from a local SQLite database that is automatically
  * synced using the PowerSync service.
  *
+ * You should use the createPowerSyncPersister function to create a
+ * PowerSyncPersister object.
+ *
  * 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.
+ * @category Persister
  * @since v4.8.0
  */
 export interface PowerSyncPersister extends Persister {

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

@@ -2,7 +2,7 @@
  * The persister-powersync module of the TinyBase project lets you save and load
  * Store data to and from a local SQLite database that is automatically synced
  * using the PowerSync service.
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-powersync
  * @since v4.8.0
@@ -23,12 +23,13 @@ import type {AbstractPowerSyncDatabase} from '@journeyapps/powersync-sdk-common'
  * and load Store data to and from a local SQLite database that is automatically
  * synced using the PowerSync service.
  *
+ * You should use the createPowerSyncPersister function to create a
+ * PowerSyncPersister object.
+ *
  * 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.
+ * @category Persister
  * @since v4.8.0
  */
 export interface PowerSyncPersister<Schemas extends OptionalSchemas>

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

@@ -2,7 +2,7 @@
  * The persister-powersync module of the TinyBase project lets you save and load
  * Store data to and from a local SQLite database that is automatically synced
  * using the PowerSync service.
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-powersync
  * @since v4.8.0
@@ -23,12 +23,13 @@ import type {AbstractPowerSyncDatabase} from '@journeyapps/powersync-sdk-common'
  * and load Store data to and from a local SQLite database that is automatically
  * synced using the PowerSync service.
  *
+ * You should use the createPowerSyncPersister function to create a
+ * PowerSyncPersister object.
+ *
  * 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.
+ * @category Persister
  * @since v4.8.0
  */
 export interface PowerSyncPersister<Schemas extends OptionalSchemas>

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

@@ -1,9 +1,10 @@
 /**
  * The persister-remote module of the TinyBase project lets you save and load
  * Store data to and from a remote server.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-remote
+ * @since v1.0.0
  */
 
 import type {Persister} from '../index.d.cts';
@@ -13,11 +14,11 @@ import type {Store} from '../../store/index.d.cts';
  * The RemotePersister interface represents a Persister that lets you save and
  * load Store data to and from a remote server.
  *
- * 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.
+ *
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -106,6 +107,7 @@ export interface RemotePersister extends Persister {
  * persister.destroy();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createRemotePersister(
   store: Store,

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

@@ -1,9 +1,10 @@
 /**
  * The persister-remote module of the TinyBase project lets you save and load
  * Store data to and from a remote server.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-remote
+ * @since v1.0.0
  */
 
 import type {Persister} from '../index.d.ts';
@@ -13,11 +14,11 @@ import type {Store} from '../../store/index.d.ts';
  * The RemotePersister interface represents a Persister that lets you save and
  * load Store data to and from a remote server.
  *
- * 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.
+ *
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -106,6 +107,7 @@ export interface RemotePersister extends Persister {
  * persister.destroy();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createRemotePersister(
   store: Store,

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

@@ -1,9 +1,10 @@
 /**
  * The persister-remote module of the TinyBase project lets you save and load
  * Store data to and from a remote server.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-remote
+ * @since v1.0.0
  */
 
 import type {
@@ -16,11 +17,11 @@ import type {Persister} from '../../with-schemas/index.d.cts';
  * The RemotePersister interface represents a Persister that lets you save and
  * load Store data to and from a remote server.
  *
- * 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.
+ *
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -122,6 +123,7 @@ export interface RemotePersister<Schemas extends OptionalSchemas>
  * persister.destroy();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createRemotePersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,

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

@@ -1,9 +1,10 @@
 /**
  * The persister-remote module of the TinyBase project lets you save and load
  * Store data to and from a remote server.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-remote
+ * @since v1.0.0
  */
 
 import type {
@@ -16,11 +17,11 @@ import type {Persister} from '../../with-schemas/index.d.ts';
  * The RemotePersister interface represents a Persister that lets you save and
  * load Store data to and from a remote server.
  *
- * 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.
+ *
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -122,6 +123,7 @@ export interface RemotePersister<Schemas extends OptionalSchemas>
  * persister.destroy();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createRemotePersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,

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

@@ -2,7 +2,7 @@
  * The persister-sqlite-wasm module of the TinyBase project lets you save and
  * load Store data to and from a local SQLite database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-sqlite-wasm
  * @since v4.0.0
@@ -16,12 +16,12 @@ import type {Store} from '../../store/index.d.cts';
  * The SqliteWasmPersister interface represents a Persister that lets you save
  * and load Store data to and from a local SQLite database.
  *
+ * You should use the createSqliteWasmPersister function to create a
+ * SqliteWasmPersister 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.
- *
- * You should use the createSqliteWasmPersister function to create a
- * SqliteWasmPersister object.
  * @category Persister
  * @since v4.3.14
  */

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

@@ -2,7 +2,7 @@
  * The persister-sqlite-wasm module of the TinyBase project lets you save and
  * load Store data to and from a local SQLite database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-sqlite-wasm
  * @since v4.0.0
@@ -16,12 +16,12 @@ import type {Store} from '../../store/index.d.ts';
  * The SqliteWasmPersister interface represents a Persister that lets you save
  * and load Store data to and from a local SQLite database.
  *
+ * You should use the createSqliteWasmPersister function to create a
+ * SqliteWasmPersister 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.
- *
- * You should use the createSqliteWasmPersister function to create a
- * SqliteWasmPersister object.
  * @category Persister
  * @since v4.3.14
  */

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

@@ -2,7 +2,7 @@
  * The persister-sqlite-wasm module of the TinyBase project lets you save and
  * load Store data to and from a local SQLite database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-sqlite-wasm
  * @since v4.0.0
@@ -23,12 +23,12 @@ import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d
  * The SqliteWasmPersister interface represents a Persister that lets you save
  * and load Store data to and from a local SQLite database.
  *
+ * You should use the createSqliteWasmPersister function to create a
+ * SqliteWasmPersister 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.
- *
- * You should use the createSqliteWasmPersister function to create a
- * SqliteWasmPersister object.
  * @category Persister
  * @since v4.3.14
  */

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

@@ -2,7 +2,7 @@
  * The persister-sqlite-wasm module of the TinyBase project lets you save and
  * load Store data to and from a local SQLite database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-sqlite-wasm
  * @since v4.0.0
@@ -23,12 +23,12 @@ import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d
  * The SqliteWasmPersister interface represents a Persister that lets you save
  * and load Store data to and from a local SQLite database.
  *
+ * You should use the createSqliteWasmPersister function to create a
+ * SqliteWasmPersister 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.
- *
- * You should use the createSqliteWasmPersister function to create a
- * SqliteWasmPersister object.
  * @category Persister
  * @since v4.3.14
  */

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

@@ -2,7 +2,7 @@
  * The persister-sqlite3 module of the TinyBase project lets you save and load
  * Store data to and from a local SQLite database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-sqlite3
  * @since v4.0.0
@@ -17,12 +17,12 @@ import type {Store} from '../../store/index.d.cts';
  * The Sqlite3Persister interface represents a Persister that lets you save and
  * load Store data to and from a local SQLite database.
  *
+ * You should use the createSqlite3Persister function to create a
+ * Sqlite3Persister 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.
- *
- * You should use the createSqlite3Persister function to create a
- * Sqlite3Persister object.
  * @category Persister
  * @since v4.3.14
  */

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

@@ -2,7 +2,7 @@
  * The persister-sqlite3 module of the TinyBase project lets you save and load
  * Store data to and from a local SQLite database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-sqlite3
  * @since v4.0.0
@@ -17,12 +17,12 @@ import type {Store} from '../../store/index.d.ts';
  * The Sqlite3Persister interface represents a Persister that lets you save and
  * load Store data to and from a local SQLite database.
  *
+ * You should use the createSqlite3Persister function to create a
+ * Sqlite3Persister 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.
- *
- * You should use the createSqlite3Persister function to create a
- * Sqlite3Persister object.
  * @category Persister
  * @since v4.3.14
  */

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

@@ -2,7 +2,7 @@
  * The persister-sqlite3 module of the TinyBase project lets you save and load
  * Store data to and from a local SQLite database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-sqlite3
  * @since v4.0.0
@@ -24,12 +24,12 @@ import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d
  * The Sqlite3Persister interface represents a Persister that lets you save and
  * load Store data to and from a local SQLite database.
  *
+ * You should use the createSqlite3Persister function to create a
+ * Sqlite3Persister 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.
- *
- * You should use the createSqlite3Persister function to create a
- * Sqlite3Persister object.
  * @category Persister
  * @since v4.3.14
  */

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

@@ -2,7 +2,7 @@
  * The persister-sqlite3 module of the TinyBase project lets you save and load
  * Store data to and from a local SQLite database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-sqlite3
  * @since v4.0.0
@@ -24,12 +24,12 @@ import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d
  * The Sqlite3Persister interface represents a Persister that lets you save and
  * load Store data to and from a local SQLite database.
  *
+ * You should use the createSqlite3Persister function to create a
+ * Sqlite3Persister 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.
- *
- * You should use the createSqlite3Persister function to create a
- * Sqlite3Persister object.
  * @category Persister
  * @since v4.3.14
  */

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

@@ -5,7 +5,7 @@
  * A single entry point, the createYjsPersister function, is provided, which
  * returns a new Persister object that can bind a Store to a provided Yjs
  * document.
- * @see Synchronizing Data guide
+ * @see Third-Party CRDT Persistence guide
  * @packageDocumentation
  * @module persister-yjs
  * @since v4.0.0
@@ -19,12 +19,12 @@ import type {Doc as YDoc} from 'yjs';
  * The YjsPersister interface represents a Persister that lets you save and load
  * Store data to and from a Yjs document.
  *
+ * You should use the createYjsPersister function to create a YjsPersister
+ * object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getYDoc method for accessing the Yjs document the Store is being
  * persisted to.
- *
- * You should use the createYjsPersister function to create a YjsPersister
- * object.
  * @category Persister
  * @since v4.3.14
  */

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

@@ -5,7 +5,7 @@
  * A single entry point, the createYjsPersister function, is provided, which
  * returns a new Persister object that can bind a Store to a provided Yjs
  * document.
- * @see Synchronizing Data guide
+ * @see Third-Party CRDT Persistence guide
  * @packageDocumentation
  * @module persister-yjs
  * @since v4.0.0
@@ -19,12 +19,12 @@ import type {Doc as YDoc} from 'yjs';
  * The YjsPersister interface represents a Persister that lets you save and load
  * Store data to and from a Yjs document.
  *
+ * You should use the createYjsPersister function to create a YjsPersister
+ * object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getYDoc method for accessing the Yjs document the Store is being
  * persisted to.
- *
- * You should use the createYjsPersister function to create a YjsPersister
- * object.
  * @category Persister
  * @since v4.3.14
  */

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

@@ -5,7 +5,7 @@
  * A single entry point, the createYjsPersister function, is provided, which
  * returns a new Persister object that can bind a Store to a provided Yjs
  * document.
- * @see Synchronizing Data guide
+ * @see Third-Party CRDT Persistence guide
  * @packageDocumentation
  * @module persister-yjs
  * @since v4.0.0
@@ -22,12 +22,12 @@ import type {Doc as YDoc} from 'yjs';
  * The YjsPersister interface represents a Persister that lets you save and load
  * Store data to and from a Yjs document.
  *
+ * You should use the createYjsPersister function to create a YjsPersister
+ * object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getYDoc method for accessing the Yjs document the Store is being
  * persisted to.
- *
- * You should use the createYjsPersister function to create a YjsPersister
- * object.
  * @category Persister
  * @since v4.3.14
  */

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

@@ -5,7 +5,7 @@
  * A single entry point, the createYjsPersister function, is provided, which
  * returns a new Persister object that can bind a Store to a provided Yjs
  * document.
- * @see Synchronizing Data guide
+ * @see Third-Party CRDT Persistence guide
  * @packageDocumentation
  * @module persister-yjs
  * @since v4.0.0
@@ -22,12 +22,12 @@ import type {Doc as YDoc} from 'yjs';
  * The YjsPersister interface represents a Persister that lets you save and load
  * Store data to and from a Yjs document.
  *
+ * You should use the createYjsPersister function to create a YjsPersister
+ * object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getYDoc method for accessing the Yjs document the Store is being
  * persisted to.
- *
- * You should use the createYjsPersister function to create a YjsPersister
- * object.
  * @category Persister
  * @since v4.3.14
  */