tinybase 8.1.0-beta.2 → 8.1.0-beta.3

package/@types/ui-svelte/index.d.ts

@@ -8,9 +8,9 @@
  * property. Hooks register listeners such that components using those hooks
  * re-render when data changes.
  *
- * Hook parameters accept either plain values or reactive getter functions
- * (`MaybeGetter<T> = T | (() => T)`), so passing `() => tableId` from a
- * `let`-bound Svelte prop makes the hook re-execute whenever the prop changes.
+ * Hook parameters accept either plain values or reactive getter functions (see
+ * the MaybeGetter type), so passing `() => tableId` from a `let`-bound Svelte
+ * prop makes the hook re-execute whenever the prop changes.
  *
  * The components in this module provide a further abstraction over those hooks
  * to ease the composition of user interfaces that use TinyBase.
@@ -104,8 +104,8 @@ import type {Synchronizer} from '../synchronizers/index.d.ts';
 export type MaybeGetter<T> = T | (() => T);
 
 /**
- * The StoreOrStoreId type is used when you need to refer to a Store in a
- * Svelte hook or component.
+ * The StoreOrStoreId type is used when you need to refer to a Store in a Svelte
+ * hook or component.
  *
  * In some simple cases you will already have a direct reference to the Store.
  *
@@ -2365,8 +2365,8 @@ export function useCheckpoints(id?: Id): Checkpoints | undefined;
 /**
  * The useCheckpointsOrCheckpointsById hook is used to get a reference to a
  * Checkpoints object from a Provider context, or have it passed directly.
- * @param checkpointsOrCheckpointsId The Checkpoints object, its Id, or a
- * getter returning either.
+ * @param checkpointsOrCheckpointsId The Checkpoints object, its Id, or a getter
+ * returning either.
  * @returns A getter function returning the Checkpoints object, or `undefined`.
  * @category Hook
  * @since v8.1.0
@@ -2543,14 +2543,13 @@ export function useSynchronizerStatus(
 ): {readonly current: Status};
 
 /**
- * The useHasTablesListener hook registers a listener that is
- * called whenever any Tables are added to or removed from the
- * Store. The listener is tied to the component's `$effect`
- * lifecycle and is removed when the component unmounts.
- * @param listener The function to call when table presence
- * changes.
- * @param mutator An optional boolean indicating the listener
- * mutates Store data.
+ * The useHasTablesListener hook registers a listener that is called whenever
+ * any Tables are added to or removed from the Store. The listener is tied to
+ * the component's `$effect` lifecycle and is removed when the component
+ * unmounts.
+ * @param listener The function to call when table presence changes.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
  * @since v8.1.0
@@ -2562,11 +2561,11 @@ export function useHasTablesListener(
 ): void;
 
 /**
- * The useTablesListener hook registers a listener that is
- * called whenever tabular data in the Store changes.
+ * The useTablesListener hook registers a listener that is called whenever
+ * tabular data in the Store changes.
  * @param listener The function to call when Tables change.
- * @param mutator An optional boolean indicating the listener
- * mutates Store data.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
  * @since v8.1.0
@@ -2578,11 +2577,11 @@ export function useTablesListener(
 ): void;
 
 /**
- * The useTableIdsListener hook registers a listener that is
- * called whenever the set of Table Ids in the Store changes.
+ * The useTableIdsListener hook registers a listener that is called whenever the
+ * set of Table Ids in the Store changes.
  * @param listener The function to call when Table Ids change.
- * @param mutator An optional boolean indicating the listener
- * mutates Store data.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
  * @since v8.1.0
@@ -2594,14 +2593,13 @@ export function useTableIdsListener(
 ): void;
 
 /**
- * The useHasTableListener hook registers a listener that is
- * called whenever a specified Table is added to or removed
- * from the Store.
- * @param tableId The Id of the Table to listen to, or `null`
- * to listen to any Table.
+ * The useHasTableListener hook registers a listener that is called whenever a
+ * specified Table is added to or removed from the Store.
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
+ * Table.
  * @param listener The function to call when the Table changes.
- * @param mutator An optional boolean indicating the listener
- * mutates Store data.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
  * @since v8.1.0
@@ -2614,13 +2612,13 @@ export function useHasTableListener(
 ): void;
 
 /**
- * The useTableListener hook registers a listener that is
- * called whenever data in a specified Table changes.
- * @param tableId The Id of the Table to listen to, or `null`
- * to listen to any Table.
+ * The useTableListener hook registers a listener that is called whenever data
+ * in a specified Table changes.
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
+ * Table.
  * @param listener The function to call when the Table changes.
- * @param mutator An optional boolean indicating the listener
- * mutates Store data.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
  * @since v8.1.0
@@ -2633,13 +2631,13 @@ export function useTableListener(
 ): void;
 
 /**
- * The useTableCellIdsListener hook registers a listener that
- * is called whenever the Cell Ids used across a Table change.
- * @param tableId The Id of the Table to listen to, or `null`
- * to listen to any Table.
+ * The useTableCellIdsListener hook registers a listener that is called whenever
+ * the Cell Ids used across a Table change.
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
+ * Table.
  * @param listener The function to call when Cell Ids change.
- * @param mutator An optional boolean indicating the listener
- * mutates Store data.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
  * @since v8.1.0
@@ -2652,17 +2650,15 @@ export function useTableCellIdsListener(
 ): void;
 
 /**
- * The useHasTableCellListener hook registers a listener that
- * is called whenever a specified Cell Id is added to or
- * removed from across a Table.
- * @param tableId The Id of the Table to listen to, or `null`
- * to listen to any Table.
- * @param cellId The Id of the Cell to listen to, or `null`
- * to listen to any Cell Id.
- * @param listener The function to call when the Cell Id
- * changes.
- * @param mutator An optional boolean indicating the listener
- * mutates Store data.
+ * The useHasTableCellListener hook registers a listener that is called whenever
+ * a specified Cell Id is added to or removed from across a Table.
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
+ * Table.
+ * @param cellId The Id of the Cell to listen to, or `null` to listen to any
+ * Cell Id.
+ * @param listener The function to call when the Cell Id changes.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
  * @since v8.1.0
@@ -2676,14 +2672,13 @@ export function useHasTableCellListener(
 ): void;
 
 /**
- * The useRowCountListener hook registers a listener that is
- * called whenever the count of Rows in a Table changes.
- * @param tableId The Id of the Table to listen to, or `null`
- * to listen to any Table.
- * @param listener The function to call when the Row count
- * changes.
- * @param mutator An optional boolean indicating the listener
- * mutates Store data.
+ * The useRowCountListener hook registers a listener that is called whenever the
+ * count of Rows in a Table changes.
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
+ * Table.
+ * @param listener The function to call when the Row count changes.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
  * @since v8.1.0
@@ -2696,13 +2691,13 @@ export function useRowCountListener(
 ): void;
 
 /**
- * The useRowIdsListener hook registers a listener that is
- * called whenever the Row Ids in a Table change.
- * @param tableId The Id of the Table to listen to, or `null`
- * to listen to any Table.
+ * The useRowIdsListener hook registers a listener that is called whenever the
+ * Row Ids in a Table change.
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
+ * Table.
  * @param listener The function to call when Row Ids change.
- * @param mutator An optional boolean indicating the listener
- * mutates Store data.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
  * @since v8.1.0
@@ -2715,19 +2710,17 @@ export function useRowIdsListener(
 ): void;
 
 /**
- * The useSortedRowIdsListener hook registers a listener that
- * is called whenever the sorted Row Ids in a Table change.
+ * The useSortedRowIdsListener hook registers a listener that is called whenever
+ * the sorted Row Ids in a Table change.
  * @param tableId The Id of the Table to listen to.
- * @param cellId The Id of the Cell to sort by, or `undefined`
- * for default order.
+ * @param cellId The Id of the Cell to sort by, or `undefined` for default
+ * order.
  * @param descending Whether to sort descending.
  * @param offset The index of the first Row to include.
- * @param limit The maximum number of Rows to include, or
- * `undefined` for all.
- * @param listener The function to call when sorted Row Ids
- * change.
- * @param mutator An optional boolean indicating the listener
- * mutates Store data.
+ * @param limit The maximum number of Rows to include, or `undefined` for all.
+ * @param listener The function to call when sorted Row Ids change.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
  * @since v8.1.0
@@ -2744,16 +2737,14 @@ export function useSortedRowIdsListener(
 ): void;
 
 /**
- * The useHasRowListener hook registers a listener that is
- * called whenever a specified Row is added to or removed from
- * a Table.
- * @param tableId The Id of the Table to listen to, or `null`
- * to listen to any Table.
- * @param rowId The Id of the Row to listen to, or `null` to
- * listen to any Row.
+ * The useHasRowListener hook registers a listener that is called whenever a
+ * specified Row is added to or removed from a Table.
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
+ * Table.
+ * @param rowId The Id of the Row to listen to, or `null` to listen to any Row.
  * @param listener The function to call when the Row changes.
- * @param mutator An optional boolean indicating the listener
- * mutates Store data.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
  * @since v8.1.0
@@ -2767,15 +2758,14 @@ export function useHasRowListener(
 ): void;
 
 /**
- * The useRowListener hook registers a listener that is called
- * whenever data in a specified Row changes.
- * @param tableId The Id of the Table to listen to, or `null`
- * to listen to any Table.
- * @param rowId The Id of the Row to listen to, or `null` to
- * listen to any Row.
+ * The useRowListener hook registers a listener that is called whenever data in
+ * a specified Row changes.
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
+ * Table.
+ * @param rowId The Id of the Row to listen to, or `null` to listen to any Row.
  * @param listener The function to call when the Row changes.
- * @param mutator An optional boolean indicating the listener
- * mutates Store data.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
  * @since v8.1.0
@@ -2789,15 +2779,14 @@ export function useRowListener(
 ): void;
 
 /**
- * The useCellIdsListener hook registers a listener that is
- * called whenever the Cell Ids in a Row change.
- * @param tableId The Id of the Table to listen to, or `null`
- * to listen to any Table.
- * @param rowId The Id of the Row to listen to, or `null` to
- * listen to any Row.
+ * The useCellIdsListener hook registers a listener that is called whenever the
+ * Cell Ids in a Row change.
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
+ * Table.
+ * @param rowId The Id of the Row to listen to, or `null` to listen to any Row.
  * @param listener The function to call when Cell Ids change.
- * @param mutator An optional boolean indicating the listener
- * mutates Store data.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
  * @since v8.1.0
@@ -2811,18 +2800,16 @@ export function useCellIdsListener(
 ): void;
 
 /**
- * The useHasCellListener hook registers a listener that is
- * called whenever a specified Cell is added to or removed from
- * a Row.
- * @param tableId The Id of the Table to listen to, or `null`
- * to listen to any Table.
- * @param rowId The Id of the Row to listen to, or `null` to
- * listen to any Row.
- * @param cellId The Id of the Cell to listen to, or `null` to
- * listen to any Cell.
+ * The useHasCellListener hook registers a listener that is called whenever a
+ * specified Cell is added to or removed from a Row.
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
+ * Table.
+ * @param rowId The Id of the Row to listen to, or `null` to listen to any Row.
+ * @param cellId The Id of the Cell to listen to, or `null` to listen to any
+ * Cell.
  * @param listener The function to call when the Cell changes.
- * @param mutator An optional boolean indicating the listener
- * mutates Store data.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
  * @since v8.1.0
@@ -2837,17 +2824,16 @@ export function useHasCellListener(
 ): void;
 
 /**
- * The useCellListener hook registers a listener that is called
- * whenever the value of a specified Cell changes.
- * @param tableId The Id of the Table to listen to, or `null`
- * to listen to any Table.
- * @param rowId The Id of the Row to listen to, or `null` to
- * listen to any Row.
- * @param cellId The Id of the Cell to listen to, or `null` to
- * listen to any Cell.
+ * The useCellListener hook registers a listener that is called whenever the
+ * value of a specified Cell changes.
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
+ * Table.
+ * @param rowId The Id of the Row to listen to, or `null` to listen to any Row.
+ * @param cellId The Id of the Cell to listen to, or `null` to listen to any
+ * Cell.
  * @param listener The function to call when the Cell changes.
- * @param mutator An optional boolean indicating the listener
- * mutates Store data.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
  * @since v8.1.0
@@ -2862,13 +2848,11 @@ export function useCellListener(
 ): void;
 
 /**
- * The useHasValuesListener hook registers a listener that is
- * called whenever any Values are added to or removed from the
- * Store.
- * @param listener The function to call when value presence
- * changes.
- * @param mutator An optional boolean indicating the listener
- * mutates Store data.
+ * The useHasValuesListener hook registers a listener that is called whenever
+ * any Values are added to or removed from the Store.
+ * @param listener The function to call when value presence changes.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
  * @since v8.1.0
@@ -2880,11 +2864,11 @@ export function useHasValuesListener(
 ): void;
 
 /**
- * The useValuesListener hook registers a listener that is
- * called whenever any Values in the Store change.
+ * The useValuesListener hook registers a listener that is called whenever any
+ * Values in the Store change.
  * @param listener The function to call when Values change.
- * @param mutator An optional boolean indicating the listener
- * mutates Store data.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
  * @since v8.1.0
@@ -2896,11 +2880,11 @@ export function useValuesListener(
 ): void;
 
 /**
- * The useValueIdsListener hook registers a listener that is
- * called whenever the Value Ids in the Store change.
+ * The useValueIdsListener hook registers a listener that is called whenever the
+ * Value Ids in the Store change.
  * @param listener The function to call when Value Ids change.
- * @param mutator An optional boolean indicating the listener
- * mutates Store data.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
  * @since v8.1.0
@@ -2912,14 +2896,13 @@ export function useValueIdsListener(
 ): void;
 
 /**
- * The useHasValueListener hook registers a listener that is
- * called whenever a specified Value is added to or removed
- * from the Store.
- * @param valueId The Id of the Value to listen to, or `null`
- * to listen to any Value.
+ * The useHasValueListener hook registers a listener that is called whenever a
+ * specified Value is added to or removed from the Store.
+ * @param valueId The Id of the Value to listen to, or `null` to listen to any
+ * Value.
  * @param listener The function to call when the Value changes.
- * @param mutator An optional boolean indicating the listener
- * mutates Store data.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
  * @since v8.1.0
@@ -2932,13 +2915,13 @@ export function useHasValueListener(
 ): void;
 
 /**
- * The useValueListener hook registers a listener that is
- * called whenever the value of a specified Value changes.
- * @param valueId The Id of the Value to listen to, or `null`
- * to listen to any Value.
+ * The useValueListener hook registers a listener that is called whenever the
+ * value of a specified Value changes.
+ * @param valueId The Id of the Value to listen to, or `null` to listen to any
+ * Value.
  * @param listener The function to call when the Value changes.
- * @param mutator An optional boolean indicating the listener
- * mutates Store data.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
  * @since v8.1.0
@@ -2951,8 +2934,8 @@ export function useValueListener(
 ): void;
 
 /**
- * The useStartTransactionListener hook registers a listener
- * that is called at the start of every Store transaction.
+ * The useStartTransactionListener hook registers a listener that is called at
+ * the start of every Store transaction.
  * @param listener The function to call at transaction start.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
@@ -2964,8 +2947,8 @@ export function useStartTransactionListener(
 ): void;
 
 /**
- * The useWillFinishTransactionListener hook registers a
- * listener called just before a Store transaction completes.
+ * The useWillFinishTransactionListener hook registers a listener called just
+ * before a Store transaction completes.
  * @param listener The function to call before transaction end.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
@@ -2977,8 +2960,8 @@ export function useWillFinishTransactionListener(
 ): void;
 
 /**
- * The useDidFinishTransactionListener hook registers a
- * listener called just after a Store transaction completes.
+ * The useDidFinishTransactionListener hook registers a listener called just
+ * after a Store transaction completes.
  * @param listener The function to call after transaction end.
  * @param storeOrStoreId The Store to use, or its Id.
  * @category Hook
@@ -2990,14 +2973,12 @@ export function useDidFinishTransactionListener(
 ): void;
 
 /**
- * The useMetricListener hook registers a listener that is
- * called whenever a specified Metric value changes.
- * @param metricId The Id of the Metric to listen to, or
- * `null` to listen to any Metric.
- * @param listener The function to call when the Metric
- * changes.
- * @param metricsOrMetricsId The Metrics object to use, or
- * its Id.
+ * The useMetricListener hook registers a listener that is called whenever a
+ * specified Metric value changes.
+ * @param metricId The Id of the Metric to listen to, or `null` to listen to any
+ * Metric.
+ * @param listener The function to call when the Metric changes.
+ * @param metricsOrMetricsId The Metrics object to use, or its Id.
  * @category Hook
  * @since v8.1.0
  */
@@ -3008,13 +2989,12 @@ export function useMetricListener(
 ): void;
 
 /**
- * The useSliceIdsListener hook registers a listener that is
- * called whenever the Slice Ids in an Index change.
- * @param indexId The Id of the Index to listen to, or `null`
- * to listen to any Index.
+ * The useSliceIdsListener hook registers a listener that is called whenever the
+ * Slice Ids in an Index change.
+ * @param indexId The Id of the Index to listen to, or `null` to listen to any
+ * Index.
  * @param listener The function to call when Slice Ids change.
- * @param indexesOrIndexesId The Indexes object to use, or its
- * Id.
+ * @param indexesOrIndexesId The Indexes object to use, or its Id.
  * @category Hook
  * @since v8.1.0
  */
@@ -3025,16 +3005,14 @@ export function useSliceIdsListener(
 ): void;
 
 /**
- * The useSliceRowIdsListener hook registers a listener that
- * is called whenever the Row Ids in a Slice change.
- * @param indexId The Id of the Index to listen to, or `null`
- * to listen to any Index.
- * @param sliceId The Id of the Slice to listen to, or `null`
- * to listen to any Slice.
- * @param listener The function to call when Slice Row Ids
- * change.
- * @param indexesOrIndexesId The Indexes object to use, or its
- * Id.
+ * The useSliceRowIdsListener hook registers a listener that is called whenever
+ * the Row Ids in a Slice change.
+ * @param indexId The Id of the Index to listen to, or `null` to listen to any
+ * Index.
+ * @param sliceId The Id of the Slice to listen to, or `null` to listen to any
+ * Slice.
+ * @param listener The function to call when Slice Row Ids change.
+ * @param indexesOrIndexesId The Indexes object to use, or its Id.
  * @category Hook
  * @since v8.1.0
  */
@@ -3046,17 +3024,15 @@ export function useSliceRowIdsListener(
 ): void;
 
 /**
- * The useRemoteRowIdListener hook registers a listener that
- * is called whenever the remote Row Id for a local Row
- * changes.
- * @param relationshipId The Id of the Relationship, or `null`
- * to listen to any Relationship.
- * @param localRowId The Id of the local Row, or `null` to
- * listen to any local Row.
- * @param listener The function to call when the remote Row Id
- * changes.
- * @param relationshipsOrRelationshipsId The Relationships
- * object to use, or its Id.
+ * The useRemoteRowIdListener hook registers a listener that is called whenever
+ * the remote Row Id for a local Row changes.
+ * @param relationshipId The Id of the Relationship, or `null` to listen to any
+ * Relationship.
+ * @param localRowId The Id of the local Row, or `null` to listen to any local
+ * Row.
+ * @param listener The function to call when the remote Row Id changes.
+ * @param relationshipsOrRelationshipsId The Relationships object to use, or its
+ * Id.
  * @category Hook
  * @since v8.1.0
  */
@@ -3070,17 +3046,15 @@ export function useRemoteRowIdListener(
 ): void;
 
 /**
- * The useLocalRowIdsListener hook registers a listener that
- * is called whenever the local Row Ids for a remote Row
- * change.
- * @param relationshipId The Id of the Relationship, or `null`
- * to listen to any Relationship.
- * @param remoteRowId The Id of the remote Row, or `null` to
- * listen to any remote Row.
- * @param listener The function to call when local Row Ids
- * change.
- * @param relationshipsOrRelationshipsId The Relationships
- * object to use, or its Id.
+ * The useLocalRowIdsListener hook registers a listener that is called whenever
+ * the local Row Ids for a remote Row change.
+ * @param relationshipId The Id of the Relationship, or `null` to listen to any
+ * Relationship.
+ * @param remoteRowId The Id of the remote Row, or `null` to listen to any
+ * remote Row.
+ * @param listener The function to call when local Row Ids change.
+ * @param relationshipsOrRelationshipsId The Relationships object to use, or its
+ * Id.
  * @category Hook
  * @since v8.1.0
  */
@@ -3094,15 +3068,13 @@ export function useLocalRowIdsListener(
 ): void;
 
 /**
- * The useLinkedRowIdsListener hook registers a listener that
- * is called whenever the linked Row Ids for a first Row
- * change.
+ * The useLinkedRowIdsListener hook registers a listener that is called whenever
+ * the linked Row Ids for a first Row change.
  * @param relationshipId The Id of the Relationship.
  * @param firstRowId The Id of the first Row.
- * @param listener The function to call when linked Row Ids
- * change.
- * @param relationshipsOrRelationshipsId The Relationships
- * object to use, or its Id.
+ * @param listener The function to call when linked Row Ids change.
+ * @param relationshipsOrRelationshipsId The Relationships object to use, or its
+ * Id.
  * @category Hook
  * @since v8.1.0
  */
@@ -3116,14 +3088,12 @@ export function useLinkedRowIdsListener(
 ): void;
 
 /**
- * The useResultTableListener hook registers a listener that
- * is called whenever the result Table of a query changes.
- * @param queryId The Id of the query to listen to, or `null`
- * to listen to any query.
- * @param listener The function to call when the result Table
- * changes.
- * @param queriesOrQueriesId The Queries object to use, or its
- * Id.
+ * The useResultTableListener hook registers a listener that is called whenever
+ * the result Table of a query changes.
+ * @param queryId The Id of the query to listen to, or `null` to listen to any
+ * query.
+ * @param listener The function to call when the result Table changes.
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
  * @category Hook
  * @since v8.1.0
  */
@@ -3134,14 +3104,12 @@ export function useResultTableListener(
 ): void;
 
 /**
- * The useResultTableCellIdsListener hook registers a listener
- * that is called whenever the Cell Ids across a result Table
- * change.
- * @param queryId The Id of the query to listen to, or `null`
- * to listen to any query.
+ * The useResultTableCellIdsListener hook registers a listener that is called
+ * whenever the Cell Ids across a result Table change.
+ * @param queryId The Id of the query to listen to, or `null` to listen to any
+ * query.
  * @param listener The function to call when Cell Ids change.
- * @param queriesOrQueriesId The Queries object to use, or its
- * Id.
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
  * @category Hook
  * @since v8.1.0
  */
@@ -3152,13 +3120,12 @@ export function useResultTableCellIdsListener(
 ): void;
 
 /**
- * The useResultRowCountListener hook registers a listener that
- * is called whenever the count of result Rows changes.
- * @param queryId The Id of the query to listen to, or `null`
- * to listen to any query.
+ * The useResultRowCountListener hook registers a listener that is called
+ * whenever the count of result Rows changes.
+ * @param queryId The Id of the query to listen to, or `null` to listen to any
+ * query.
  * @param listener The function to call when the count changes.
- * @param queriesOrQueriesId The Queries object to use, or its
- * Id.
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
  * @category Hook
  * @since v8.1.0
  */
@@ -3169,14 +3136,12 @@ export function useResultRowCountListener(
 ): void;
 
 /**
- * The useResultRowIdsListener hook registers a listener that
- * is called whenever the result Row Ids of a query change.
- * @param queryId The Id of the query to listen to, or `null`
- * to listen to any query.
- * @param listener The function to call when result Row Ids
- * change.
- * @param queriesOrQueriesId The Queries object to use, or its
- * Id.
+ * The useResultRowIdsListener hook registers a listener that is called whenever
+ * the result Row Ids of a query change.
+ * @param queryId The Id of the query to listen to, or `null` to listen to any
+ * query.
+ * @param listener The function to call when result Row Ids change.
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
  * @category Hook
  * @since v8.1.0
  */
@@ -3187,19 +3152,16 @@ export function useResultRowIdsListener(
 ): void;
 
 /**
- * The useResultSortedRowIdsListener hook registers a listener
- * that is called whenever the sorted result Row Ids change.
+ * The useResultSortedRowIdsListener hook registers a listener that is called
+ * whenever the sorted result Row Ids change.
  * @param queryId The Id of the query to listen to.
- * @param cellId The Id of the Cell to sort by, or `undefined`
- * for default order.
+ * @param cellId The Id of the Cell to sort by, or `undefined` for default
+ * order.
  * @param descending Whether to sort descending.
  * @param offset The index of the first Row to include.
- * @param limit The maximum number of Rows to include, or
- * `undefined` for all.
- * @param listener The function to call when sorted Row Ids
- * change.
- * @param queriesOrQueriesId The Queries object to use, or its
- * Id.
+ * @param limit The maximum number of Rows to include, or `undefined` for all.
+ * @param listener The function to call when sorted Row Ids change.
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
  * @category Hook
  * @since v8.1.0
  */
@@ -3214,16 +3176,14 @@ export function useResultSortedRowIdsListener(
 ): void;
 
 /**
- * The useResultRowListener hook registers a listener that is
- * called whenever a result Row changes.
- * @param queryId The Id of the query to listen to, or `null`
- * to listen to any query.
- * @param rowId The Id of the result Row to listen to, or
- * `null` to listen to any result Row.
- * @param listener The function to call when the result Row
- * changes.
- * @param queriesOrQueriesId The Queries object to use, or its
- * Id.
+ * The useResultRowListener hook registers a listener that is called whenever a
+ * result Row changes.
+ * @param queryId The Id of the query to listen to, or `null` to listen to any
+ * query.
+ * @param rowId The Id of the result Row to listen to, or `null` to listen to
+ * any result Row.
+ * @param listener The function to call when the result Row changes.
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
  * @category Hook
  * @since v8.1.0
  */
@@ -3235,15 +3195,14 @@ export function useResultRowListener(
 ): void;
 
 /**
- * The useResultCellIdsListener hook registers a listener that
- * is called whenever the Cell Ids in a result Row change.
- * @param queryId The Id of the query to listen to, or `null`
- * to listen to any query.
- * @param rowId The Id of the result Row to listen to, or
- * `null` to listen to any result Row.
+ * The useResultCellIdsListener hook registers a listener that is called
+ * whenever the Cell Ids in a result Row change.
+ * @param queryId The Id of the query to listen to, or `null` to listen to any
+ * query.
+ * @param rowId The Id of the result Row to listen to, or `null` to listen to
+ * any result Row.
  * @param listener The function to call when Cell Ids change.
- * @param queriesOrQueriesId The Queries object to use, or its
- * Id.
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
  * @category Hook
  * @since v8.1.0
  */
@@ -3255,18 +3214,16 @@ export function useResultCellIdsListener(
 ): void;
 
 /**
- * The useResultCellListener hook registers a listener that is
- * called whenever the value of a result Cell changes.
- * @param queryId The Id of the query to listen to, or `null`
- * to listen to any query.
- * @param rowId The Id of the result Row to listen to, or
- * `null` to listen to any result Row.
- * @param cellId The Id of the result Cell to listen to, or
- * `null` to listen to any result Cell.
- * @param listener The function to call when the result Cell
- * changes.
- * @param queriesOrQueriesId The Queries object to use, or its
- * Id.
+ * The useResultCellListener hook registers a listener that is called whenever
+ * the value of a result Cell changes.
+ * @param queryId The Id of the query to listen to, or `null` to listen to any
+ * query.
+ * @param rowId The Id of the result Row to listen to, or `null` to listen to
+ * any result Row.
+ * @param cellId The Id of the result Cell to listen to, or `null` to listen to
+ * any result Cell.
+ * @param listener The function to call when the result Cell changes.
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
  * @category Hook
  * @since v8.1.0
  */
@@ -3279,14 +3236,12 @@ export function useResultCellListener(
 ): void;
 
 /**
- * The useParamValuesListener hook registers a listener that
- * is called whenever the parameter values for a query change.
- * @param queryId The Id of the query to listen to, or `null`
- * to listen to any query.
- * @param listener The function to call when parameter values
- * change.
- * @param queriesOrQueriesId The Queries object to use, or its
- * Id.
+ * The useParamValuesListener hook registers a listener that is called whenever
+ * the parameter values for a query change.
+ * @param queryId The Id of the query to listen to, or `null` to listen to any
+ * query.
+ * @param listener The function to call when parameter values change.
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
  * @category Hook
  * @since v8.1.0
  */
@@ -3297,17 +3252,14 @@ export function useParamValuesListener(
 ): void;
 
 /**
- * The useParamValueListener hook registers a listener that is
- * called whenever a specific parameter value for a query
- * changes.
- * @param queryId The Id of the query to listen to, or `null`
- * to listen to any query.
- * @param paramId The Id of the parameter to listen to, or
- * `null` to listen to any parameter.
- * @param listener The function to call when the parameter
- * value changes.
- * @param queriesOrQueriesId The Queries object to use, or its
- * Id.
+ * The useParamValueListener hook registers a listener that is called whenever a
+ * specific parameter value for a query changes.
+ * @param queryId The Id of the query to listen to, or `null` to listen to any
+ * query.
+ * @param paramId The Id of the parameter to listen to, or `null` to listen to
+ * any parameter.
+ * @param listener The function to call when the parameter value changes.
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
  * @category Hook
  * @since v8.1.0
  */
@@ -3319,12 +3271,10 @@ export function useParamValueListener(
 ): void;
 
 /**
- * The useCheckpointIdsListener hook registers a listener that
- * is called whenever the Checkpoint Ids change.
- * @param listener The function to call when Checkpoint Ids
- * change.
- * @param checkpointsOrCheckpointsId The Checkpoints object to
- * use, or its Id.
+ * The useCheckpointIdsListener hook registers a listener that is called
+ * whenever the Checkpoint Ids change.
+ * @param listener The function to call when Checkpoint Ids change.
+ * @param checkpointsOrCheckpointsId The Checkpoints object to use, or its Id.
  * @category Hook
  * @since v8.1.0
  */
@@ -3336,14 +3286,12 @@ export function useCheckpointIdsListener(
 ): void;
 
 /**
- * The useCheckpointListener hook registers a listener that is
- * called whenever the label of a specified Checkpoint changes.
- * @param checkpointId The Id of the Checkpoint to listen to,
- * or `null` to listen to any Checkpoint.
- * @param listener The function to call when the Checkpoint
- * label changes.
- * @param checkpointsOrCheckpointsId The Checkpoints object to
- * use, or its Id.
+ * The useCheckpointListener hook registers a listener that is called whenever
+ * the label of a specified Checkpoint changes.
+ * @param checkpointId The Id of the Checkpoint to listen to, or `null` to
+ * listen to any Checkpoint.
+ * @param listener The function to call when the Checkpoint label changes.
+ * @param checkpointsOrCheckpointsId The Checkpoints object to use, or its Id.
  * @category Hook
  * @since v8.1.0
  */
@@ -3356,12 +3304,10 @@ export function useCheckpointListener(
 ): void;
 
 /**
- * The usePersisterStatusListener hook registers a listener
- * that is called whenever the status of a Persister changes.
- * @param listener The function to call when the status
- * changes.
- * @param persisterOrPersisterId The Persister to use, or its
- * Id.
+ * The usePersisterStatusListener hook registers a listener that is called
+ * whenever the status of a Persister changes.
+ * @param listener The function to call when the status changes.
+ * @param persisterOrPersisterId The Persister to use, or its Id.
  * @category Hook
  * @since v8.1.0
  */
@@ -3371,13 +3317,10 @@ export function usePersisterStatusListener(
 ): void;
 
 /**
- * The useSynchronizerStatusListener hook registers a listener
- * that is called whenever the status of a Synchronizer
- * changes.
- * @param listener The function to call when the status
- * changes.
- * @param synchronizerOrSynchronizerId The Synchronizer to use,
- * or its Id.
+ * The useSynchronizerStatusListener hook registers a listener that is called
+ * whenever the status of a Synchronizer changes.
+ * @param listener The function to call when the status changes.
+ * @param synchronizerOrSynchronizerId The Synchronizer to use, or its Id.
  * @category Hook
  * @since v8.1.0
  */