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

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

@@ -5,7 +5,7 @@
  * A single entry point, the createAutomergePersister function, is provided,
  * which returns a new Persister object that can bind a Store to a provided
  * Automerge document handle (and in turn, its document).
- * @see Synchronizing Data guide
+ * @see Third-Party CRDT Persistence guide
  * @packageDocumentation
  * @module persister-automerge
  * @since v4.0.0
@@ -19,12 +19,12 @@ import type {Store} from '../../store/index.d.cts';
  * The AutomergePersister interface represents a Persister that lets you save
  * and load Store data to and from an Automerge document.
  *
+ * You should use the createAutomergePersister function to create an
+ * AutomergePersister object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getDocHandle method for accessing the Automerge document handler the
  * Store is being persisted to.
- *
- * You should use the createAutomergePersister function to create an
- * AutomergePersister object.
  * @category Persister
  * @since v4.3.14
  */

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

@@ -5,7 +5,7 @@
  * A single entry point, the createAutomergePersister function, is provided,
  * which returns a new Persister object that can bind a Store to a provided
  * Automerge document handle (and in turn, its document).
- * @see Synchronizing Data guide
+ * @see Third-Party CRDT Persistence guide
  * @packageDocumentation
  * @module persister-automerge
  * @since v4.0.0
@@ -19,12 +19,12 @@ import type {Store} from '../../store/index.d.ts';
  * The AutomergePersister interface represents a Persister that lets you save
  * and load Store data to and from an Automerge document.
  *
+ * You should use the createAutomergePersister function to create an
+ * AutomergePersister object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getDocHandle method for accessing the Automerge document handler the
  * Store is being persisted to.
- *
- * You should use the createAutomergePersister function to create an
- * AutomergePersister object.
  * @category Persister
  * @since v4.3.14
  */

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

@@ -5,7 +5,7 @@
  * A single entry point, the createAutomergePersister function, is provided,
  * which returns a new Persister object that can bind a Store to a provided
  * Automerge document handle (and in turn, its document).
- * @see Synchronizing Data guide
+ * @see Third-Party CRDT Persistence guide
  * @packageDocumentation
  * @module persister-automerge
  * @since v4.0.0
@@ -22,12 +22,12 @@ import type {Persister} from '../../with-schemas/index.d.cts';
  * The AutomergePersister interface represents a Persister that lets you save
  * and load Store data to and from an Automerge document.
  *
+ * You should use the createAutomergePersister function to create an
+ * AutomergePersister object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getDocHandle method for accessing the Automerge document handler the
  * Store is being persisted to.
- *
- * You should use the createAutomergePersister function to create an
- * AutomergePersister object.
  * @category Persister
  * @since v4.3.14
  */

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

@@ -5,7 +5,7 @@
  * A single entry point, the createAutomergePersister function, is provided,
  * which returns a new Persister object that can bind a Store to a provided
  * Automerge document handle (and in turn, its document).
- * @see Synchronizing Data guide
+ * @see Third-Party CRDT Persistence guide
  * @packageDocumentation
  * @module persister-automerge
  * @since v4.0.0
@@ -22,12 +22,12 @@ import type {Persister} from '../../with-schemas/index.d.ts';
  * The AutomergePersister interface represents a Persister that lets you save
  * and load Store data to and from an Automerge document.
  *
+ * You should use the createAutomergePersister function to create an
+ * AutomergePersister object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getDocHandle method for accessing the Automerge document handler the
  * Store is being persisted to.
- *
- * You should use the createAutomergePersister function to create an
- * AutomergePersister object.
  * @category Persister
  * @since v4.3.14
  */

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

@@ -9,9 +9,10 @@
  *   browser's session storage.
  * - The createLocalPersister function returns a Persister that uses the
  *   browser's local storage.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-browser
+ * @since v1.0.0
  */
 
 import type {Persister, Persists} from '../index.d.cts';
@@ -22,12 +23,12 @@ import type {Store} from '../../store/index.d.cts';
  * The SessionPersister interface represents a Persister that lets you save and
  * load Store data to and from the browser's session storage.
  *
+ * You should use the createSessionPersister function to create a
+ * SessionPersister object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getStorageName method for accessing the unique key of the storage
  * location the Store is being persisted to.
- *
- * You should use the createSessionPersister function to create a
- * SessionPersister object.
  * @category Persister
  * @since v4.3.14
  */
@@ -134,6 +135,7 @@ export interface LocalPersister
  * sessionStorage.clear();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createSessionPersister(
   store: Store | MergeableStore,
@@ -175,6 +177,7 @@ export function createSessionPersister(
  * localStorage.clear();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createLocalPersister(
   store: Store | MergeableStore,

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

@@ -9,9 +9,10 @@
  *   browser's session storage.
  * - The createLocalPersister function returns a Persister that uses the
  *   browser's local storage.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-browser
+ * @since v1.0.0
  */
 
 import type {Persister, Persists} from '../index.d.ts';
@@ -22,12 +23,12 @@ import type {Store} from '../../store/index.d.ts';
  * The SessionPersister interface represents a Persister that lets you save and
  * load Store data to and from the browser's session storage.
  *
+ * You should use the createSessionPersister function to create a
+ * SessionPersister object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getStorageName method for accessing the unique key of the storage
  * location the Store is being persisted to.
- *
- * You should use the createSessionPersister function to create a
- * SessionPersister object.
  * @category Persister
  * @since v4.3.14
  */
@@ -134,6 +135,7 @@ export interface LocalPersister
  * sessionStorage.clear();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createSessionPersister(
   store: Store | MergeableStore,
@@ -175,6 +177,7 @@ export function createSessionPersister(
  * localStorage.clear();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createLocalPersister(
   store: Store | MergeableStore,

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

@@ -9,9 +9,10 @@
  *   browser's session storage.
  * - The createLocalPersister function returns a Persister that uses the
  *   browser's local storage.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-browser
+ * @since v1.0.0
  */
 
 import type {
@@ -25,12 +26,12 @@ import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d
  * The SessionPersister interface represents a Persister that lets you save and
  * load Store data to and from the browser's session storage.
  *
+ * You should use the createSessionPersister function to create a
+ * SessionPersister object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getStorageName method for accessing the unique key of the storage
  * location the Store is being persisted to.
- *
- * You should use the createSessionPersister function to create a
- * SessionPersister object.
  * @category Persister
  * @since v4.3.14
  */
@@ -147,6 +148,7 @@ export interface LocalPersister<Schemas extends OptionalSchemas>
  * sessionStorage.clear();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createSessionPersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas> | MergeableStore<Schemas>,
@@ -198,6 +200,7 @@ export function createSessionPersister<Schemas extends OptionalSchemas>(
  * localStorage.clear();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createLocalPersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas> | MergeableStore<Schemas>,

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

@@ -9,9 +9,10 @@
  *   browser's session storage.
  * - The createLocalPersister function returns a Persister that uses the
  *   browser's local storage.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-browser
+ * @since v1.0.0
  */
 
 import type {
@@ -25,12 +26,12 @@ import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d
  * The SessionPersister interface represents a Persister that lets you save and
  * load Store data to and from the browser's session storage.
  *
+ * You should use the createSessionPersister function to create a
+ * SessionPersister object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getStorageName method for accessing the unique key of the storage
  * location the Store is being persisted to.
- *
- * You should use the createSessionPersister function to create a
- * SessionPersister object.
  * @category Persister
  * @since v4.3.14
  */
@@ -147,6 +148,7 @@ export interface LocalPersister<Schemas extends OptionalSchemas>
  * sessionStorage.clear();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createSessionPersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas> | MergeableStore<Schemas>,
@@ -198,6 +200,7 @@ export function createSessionPersister<Schemas extends OptionalSchemas>(
  * localStorage.clear();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createLocalPersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas> | MergeableStore<Schemas>,

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

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

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

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

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

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

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

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

package/@types/persisters/persister-electric-sql/index.d.cts

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

package/@types/persisters/persister-electric-sql/index.d.ts

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

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

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

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

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

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

@@ -9,7 +9,7 @@
  *
  * Note that TinyBase support for the legacy version of Expo-SQLite is no longer
  * available.
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-expo-sqlite
  * @since v4.5.0
@@ -24,12 +24,12 @@ import type {Store} from '../../store/index.d.cts';
  * The ExpoSqlitePersister interface represents a Persister that lets you save
  * and load Store data to and from a Expo-SQLite database.
  *
+ * You should use the createExpoSqlitePersister function to create an
+ * ExpoSqlitePersister object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getDb method for accessing a reference to the database instance the
  * Store is being persisted to.
- *
- * You should use the createExpoSqlitePersister function to create an
- * ExpoSqlitePersister object.
  * @category Persister
  * @since v4.5.0
  */

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

@@ -9,7 +9,7 @@
  *
  * Note that TinyBase support for the legacy version of Expo-SQLite is no longer
  * available.
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-expo-sqlite
  * @since v4.5.0
@@ -24,12 +24,12 @@ import type {Store} from '../../store/index.d.ts';
  * The ExpoSqlitePersister interface represents a Persister that lets you save
  * and load Store data to and from a Expo-SQLite database.
  *
+ * You should use the createExpoSqlitePersister function to create an
+ * ExpoSqlitePersister object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getDb method for accessing a reference to the database instance the
  * Store is being persisted to.
- *
- * You should use the createExpoSqlitePersister function to create an
- * ExpoSqlitePersister object.
  * @category Persister
  * @since v4.5.0
  */

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

@@ -9,7 +9,7 @@
  *
  * Note that TinyBase support for the legacy version of Expo-SQLite is no longer
  * available.
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-expo-sqlite
  * @since v4.5.0
@@ -31,12 +31,12 @@ import type {SQLiteDatabase} from 'expo-sqlite';
  * The ExpoSqlitePersister interface represents a Persister that lets you save
  * and load Store data to and from a Expo-SQLite database.
  *
+ * You should use the createExpoSqlitePersister function to create an
+ * ExpoSqlitePersister object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getDb method for accessing a reference to the database instance the
  * Store is being persisted to.
- *
- * You should use the createExpoSqlitePersister function to create an
- * ExpoSqlitePersister object.
  * @category Persister
  * @since v4.5.0
  */

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

@@ -9,7 +9,7 @@
  *
  * Note that TinyBase support for the legacy version of Expo-SQLite is no longer
  * available.
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-expo-sqlite
  * @since v4.5.0
@@ -31,12 +31,12 @@ import type {SQLiteDatabase} from 'expo-sqlite';
  * The ExpoSqlitePersister interface represents a Persister that lets you save
  * and load Store data to and from a Expo-SQLite database.
  *
+ * You should use the createExpoSqlitePersister function to create an
+ * ExpoSqlitePersister object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getDb method for accessing a reference to the database instance the
  * Store is being persisted to.
- *
- * You should use the createExpoSqlitePersister function to create an
- * ExpoSqlitePersister object.
  * @category Persister
  * @since v4.5.0
  */

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

@@ -1,9 +1,10 @@
 /**
  * The persister-file module of the TinyBase project lets you save and load
  * Store data to and from a local file system (in an appropriate environment).
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-file
+ * @since v1.0.0
  */
 
 import type {Persister, Persists} from '../index.d.cts';
@@ -14,12 +15,12 @@ import type {Store} from '../../store/index.d.cts';
  * 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.
- *
- * You should use the createFilePersister function to create a FilePersister
- * object.
  * @category Persister
  * @since v4.3.14
  */
@@ -85,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/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';
@@ -14,12 +15,12 @@ import type {Store} from '../../store/index.d.ts';
  * 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.
- *
- * You should use the createFilePersister function to create a FilePersister
- * object.
  * @category Persister
  * @since v4.3.14
  */
@@ -85,6 +86,7 @@ export interface FilePersister
  * persister.destroy();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createFilePersister(
   store: Store | MergeableStore,