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

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

@@ -1,11 +1,11 @@
 /**
  * The persister-automerge module of the TinyBase project provides a way to save
- * and load Store data, to and from an Automerge document.
+ * and load Store data to and from an Automerge document.
  *
  * 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
@@ -16,14 +16,15 @@ import type {Persister} from '../index.d.ts';
 import type {Store} from '../../store/index.d.ts';
 
 /**
- * The AutomergePersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getDocHandle method for accessing the Automerge
- * document handler the Store is being persisted to.
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -57,8 +58,11 @@ export interface AutomergePersister extends Persister {
 }
 
 /**
- * The createAutomergePersister function creates a Persister object that can
- * persist the Store to an Automerge document.
+ * The createAutomergePersister function creates an AutomergePersister object
+ * that can persist the Store to an Automerge document.
+ *
+ * An AutomergePersister 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
  * the Automerge document handler to persist it with.

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

@@ -1,11 +1,11 @@
 /**
  * The persister-automerge module of the TinyBase project provides a way to save
- * and load Store data, to and from an Automerge document.
+ * and load Store data to and from an Automerge document.
  *
  * 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,14 +19,15 @@ import type {DocHandle} from '@automerge/automerge-repo';
 import type {Persister} from '../../with-schemas/index.d.cts';
 
 /**
- * The AutomergePersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getDocHandle method for accessing the Automerge
- * document handler the Store is being persisted to.
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -61,8 +62,8 @@ export interface AutomergePersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createAutomergePersister function creates a Persister object that can
- * persist the Store to an Automerge document.
+ * The createAutomergePersister function creates an AutomergePersister object
+ * that can persist the Store to an Automerge document.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -75,6 +76,9 @@ export interface AutomergePersister<Schemas extends OptionalSchemas>
  * ): AutomergePersister;
  * ```
  *
+ * An AutomergePersister 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
  * the Automerge document handler to persist it with.
  * @param store The Store to persist.

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

@@ -1,11 +1,11 @@
 /**
  * The persister-automerge module of the TinyBase project provides a way to save
- * and load Store data, to and from an Automerge document.
+ * and load Store data to and from an Automerge document.
  *
  * 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,14 +19,15 @@ import type {DocHandle} from '@automerge/automerge-repo';
 import type {Persister} from '../../with-schemas/index.d.ts';
 
 /**
- * The AutomergePersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getDocHandle method for accessing the Automerge
- * document handler the Store is being persisted to.
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -61,8 +62,8 @@ export interface AutomergePersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createAutomergePersister function creates a Persister object that can
- * persist the Store to an Automerge document.
+ * The createAutomergePersister function creates an AutomergePersister object
+ * that can persist the Store to an Automerge document.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -75,6 +76,9 @@ export interface AutomergePersister<Schemas extends OptionalSchemas>
  * ): AutomergePersister;
  * ```
  *
+ * An AutomergePersister 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
  * the Automerge document handler to persist it with.
  * @param store The Store to persist.

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';
@@ -19,14 +20,15 @@ import type {MergeableStore} from '../../mergeable-store/index.d.cts';
 import type {Store} from '../../store/index.d.cts';
 
 /**
- * The SessionPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getStorageName method for accessing the unique
- * key of the storage location the Store is being persisted to.
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -59,10 +61,12 @@ export interface SessionPersister
 }
 
 /**
- * The LocalPersister interface is a minor extension to the Persister interface.
+ * The LocalPersister interface represents a Persister that lets you save and
+ * load Store data to and from the browser's local storage.
  *
- * It simply provides an extra getStorageName method for accessing the unique
- * key of the storage location the Store is being persisted to.
+ * 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 createLocalPersister function to create a LocalPersister
  * object.
@@ -98,13 +102,15 @@ export interface LocalPersister
 }
 
 /**
- * The createSessionPersister function creates a Persister object that can
- * persist the Store to the browser's session storage.
+ * The createSessionPersister function creates a SessionPersister object that
+ * can persist the Store to the browser's session storage.
+ *
+ * A SessionPersister supports both regular Store and MergeableStore objects.
  *
  * As well as providing a reference to the Store to persist, you must provide a
  * `storageName` parameter which is unique to your application. This is the key
  * that the browser uses to identify the storage location.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param storageName The unique key to identify the storage location.
  * @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
@@ -129,6 +135,7 @@ export interface LocalPersister
  * sessionStorage.clear();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createSessionPersister(
   store: Store | MergeableStore,
@@ -137,13 +144,15 @@ export function createSessionPersister(
 ): SessionPersister;
 
 /**
- * The createLocalPersister function creates a Persister object that can persist
- * the Store to the browser's local storage.
+ * The createLocalPersister function creates a LocalPersister object that can
+ * persist the Store to the browser's local storage.
+ *
+ * A LocalPersister supports both regular Store and MergeableStore objects.
  *
  * As well as providing a reference to the Store to persist, you must provide a
  * `storageName` parameter which is unique to your application. This is the key
  * that the browser uses to identify the storage location.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param storageName The unique key to identify the storage location.
  * @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
@@ -168,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';
@@ -19,14 +20,15 @@ import type {MergeableStore} from '../../mergeable-store/index.d.ts';
 import type {Store} from '../../store/index.d.ts';
 
 /**
- * The SessionPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getStorageName method for accessing the unique
- * key of the storage location the Store is being persisted to.
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -59,10 +61,12 @@ export interface SessionPersister
 }
 
 /**
- * The LocalPersister interface is a minor extension to the Persister interface.
+ * The LocalPersister interface represents a Persister that lets you save and
+ * load Store data to and from the browser's local storage.
  *
- * It simply provides an extra getStorageName method for accessing the unique
- * key of the storage location the Store is being persisted to.
+ * 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 createLocalPersister function to create a LocalPersister
  * object.
@@ -98,13 +102,15 @@ export interface LocalPersister
 }
 
 /**
- * The createSessionPersister function creates a Persister object that can
- * persist the Store to the browser's session storage.
+ * The createSessionPersister function creates a SessionPersister object that
+ * can persist the Store to the browser's session storage.
+ *
+ * A SessionPersister supports both regular Store and MergeableStore objects.
  *
  * As well as providing a reference to the Store to persist, you must provide a
  * `storageName` parameter which is unique to your application. This is the key
  * that the browser uses to identify the storage location.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param storageName The unique key to identify the storage location.
  * @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
@@ -129,6 +135,7 @@ export interface LocalPersister
  * sessionStorage.clear();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createSessionPersister(
   store: Store | MergeableStore,
@@ -137,13 +144,15 @@ export function createSessionPersister(
 ): SessionPersister;
 
 /**
- * The createLocalPersister function creates a Persister object that can persist
- * the Store to the browser's local storage.
+ * The createLocalPersister function creates a LocalPersister object that can
+ * persist the Store to the browser's local storage.
+ *
+ * A LocalPersister supports both regular Store and MergeableStore objects.
  *
  * As well as providing a reference to the Store to persist, you must provide a
  * `storageName` parameter which is unique to your application. This is the key
  * that the browser uses to identify the storage location.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param storageName The unique key to identify the storage location.
  * @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
@@ -168,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 {
@@ -22,14 +23,15 @@ import type {Persister, Persists} from '../../with-schemas/index.d.cts';
 import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.cts';
 
 /**
- * The SessionPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getStorageName method for accessing the unique
- * key of the storage location the Store is being persisted to.
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -62,10 +64,12 @@ export interface SessionPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The LocalPersister interface is a minor extension to the Persister interface.
+ * The LocalPersister interface represents a Persister that lets you save and
+ * load Store data to and from the browser's local storage.
  *
- * It simply provides an extra getStorageName method for accessing the unique
- * key of the storage location the Store is being persisted to.
+ * 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 createLocalPersister function to create a LocalPersister
  * object.
@@ -101,8 +105,8 @@ export interface LocalPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createSessionPersister function creates a Persister object that can
- * persist the Store to the browser's session storage.
+ * The createSessionPersister function creates a SessionPersister object that
+ * can persist the Store to the browser's session storage.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -114,10 +118,12 @@ export interface LocalPersister<Schemas extends OptionalSchemas>
  * ): SessionPersister;
  * ```
  *
+ * A SessionPersister supports both regular Store and MergeableStore objects.
+ *
  * As well as providing a reference to the Store to persist, you must provide a
  * `storageName` parameter which is unique to your application. This is the key
  * that the browser uses to identify the storage location.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param storageName The unique key to identify the storage location.
  * @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
@@ -142,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>,
@@ -150,8 +157,8 @@ export function createSessionPersister<Schemas extends OptionalSchemas>(
 ): SessionPersister<Schemas>;
 
 /**
- * The createLocalPersister function creates a Persister object that can persist
- * the Store to the browser's local storage.
+ * The createLocalPersister function creates a LocalPersister object that can
+ * persist the Store to the browser's local storage.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -163,10 +170,12 @@ export function createSessionPersister<Schemas extends OptionalSchemas>(
  * ): LocalPersister;
  * ```
  *
+ * A LocalPersister supports both regular Store and MergeableStore objects.
+ *
  * As well as providing a reference to the Store to persist, you must provide a
  * `storageName` parameter which is unique to your application. This is the key
  * that the browser uses to identify the storage location.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param storageName The unique key to identify the storage location.
  * @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
@@ -191,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 {
@@ -22,14 +23,15 @@ import type {Persister, Persists} from '../../with-schemas/index.d.ts';
 import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.ts';
 
 /**
- * The SessionPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getStorageName method for accessing the unique
- * key of the storage location the Store is being persisted to.
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -62,10 +64,12 @@ export interface SessionPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The LocalPersister interface is a minor extension to the Persister interface.
+ * The LocalPersister interface represents a Persister that lets you save and
+ * load Store data to and from the browser's local storage.
  *
- * It simply provides an extra getStorageName method for accessing the unique
- * key of the storage location the Store is being persisted to.
+ * 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 createLocalPersister function to create a LocalPersister
  * object.
@@ -101,8 +105,8 @@ export interface LocalPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createSessionPersister function creates a Persister object that can
- * persist the Store to the browser's session storage.
+ * The createSessionPersister function creates a SessionPersister object that
+ * can persist the Store to the browser's session storage.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -114,10 +118,12 @@ export interface LocalPersister<Schemas extends OptionalSchemas>
  * ): SessionPersister;
  * ```
  *
+ * A SessionPersister supports both regular Store and MergeableStore objects.
+ *
  * As well as providing a reference to the Store to persist, you must provide a
  * `storageName` parameter which is unique to your application. This is the key
  * that the browser uses to identify the storage location.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param storageName The unique key to identify the storage location.
  * @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
@@ -142,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>,
@@ -150,8 +157,8 @@ export function createSessionPersister<Schemas extends OptionalSchemas>(
 ): SessionPersister<Schemas>;
 
 /**
- * The createLocalPersister function creates a Persister object that can persist
- * the Store to the browser's local storage.
+ * The createLocalPersister function creates a LocalPersister object that can
+ * persist the Store to the browser's local storage.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -163,10 +170,12 @@ export function createSessionPersister<Schemas extends OptionalSchemas>(
  * ): LocalPersister;
  * ```
  *
+ * A LocalPersister supports both regular Store and MergeableStore objects.
+ *
  * As well as providing a reference to the Store to persist, you must provide a
  * `storageName` parameter which is unique to your application. This is the key
  * that the browser uses to identify the storage location.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param storageName The unique key to identify the storage location.
  * @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
@@ -191,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
@@ -13,14 +13,15 @@ import type {DB} from '@vlcn.io/crsqlite-wasm';
 import type {Store} from '../../store/index.d.cts';
 
 /**
- * The CrSqliteWasmPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getDb method for accessing a reference to the
- * database instance the Store is being persisted to.
+ * 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.
  * @category Persister
  * @since v4.3.14
  */
@@ -55,9 +56,11 @@ export interface CrSqliteWasmPersister extends Persister {
 }
 
 /**
- * The createCrSqliteWasmPersister function creates a Persister object that can
- * persist the Store to a local CR-SQLite database (in an appropriate
- * environment).
+ * The createCrSqliteWasmPersister function creates a CrSqliteWasmPersister
+ * object that can persist the Store to a local CR-SQLite database.
+ *
+ * A CrSqliteWasmPersister 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
  * `db` parameter which identifies the database instance.