tinybase 8.1.0-beta.3 → 8.1.0-beta.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,19 +1,19 @@
1
1
  /**
2
- * The ui-svelte module of the TinyBase project provides both hooks and
3
- * components to make it easy to create reactive Svelte 5 apps with Store
4
- * objects.
2
+ * The ui-svelte module of the TinyBase project provides reactive functions,
3
+ * listener functions, and components to make it easy to create reactive Svelte
4
+ * 5 apps with Store objects.
5
5
  *
6
- * The hooks in this module provide access to the data and structures exposed by
7
- * other modules in the project. They return reactive objects with a `current`
8
- * property. Hooks register listeners such that components using those hooks
9
- * re-render when data changes.
6
+ * The reactive functions in this module provide access to the data and
7
+ * structures exposed by other modules in the project. They return reactive
8
+ * objects with a `current` property. Those functions register listeners such
9
+ * that components using them re-render when data changes.
10
10
  *
11
- * Hook parameters accept either plain values or reactive getter functions (see
12
- * the MaybeGetter type), so passing `() => tableId` from a `let`-bound Svelte
13
- * prop makes the hook re-execute whenever the prop changes.
11
+ * Function parameters accept either plain values or reactive getter functions
12
+ * (see the MaybeGetter type), so passing `() => tableId` from a `let`-bound
13
+ * Svelte prop makes the function re-execute whenever the prop changes.
14
14
  *
15
- * The components in this module provide a further abstraction over those hooks
16
- * to ease the composition of user interfaces that use TinyBase.
15
+ * The components in this module provide a further abstraction over those
16
+ * functions to ease the composition of user interfaces that use TinyBase.
17
17
  * @see Building UIs With Svelte guide
18
18
  * @packageDocumentation
19
19
  * @module ui-svelte
@@ -95,17 +95,17 @@ import type {Synchronizer} from '../synchronizers/index.d.ts';
95
95
  * The MaybeGetter type represents a value that can be provided either as a
96
96
  * plain value or as a reactive getter function.
97
97
  *
98
- * When a getter function is provided to a hook, the hook's internal `$effect`
99
- * will re-run whenever the getter's reactive dependencies change. This is the
100
- * mechanism that makes Svelte 5 props reactive in hooks.
98
+ * When a getter function is provided to a reactive function, its internal
99
+ * `$effect` will re-run whenever the getter's reactive dependencies change.
100
+ * This is the mechanism that makes Svelte 5 props reactive in these functions.
101
101
  * @category Identity
102
102
  * @since v8.1.0
103
103
  */
104
104
  export type MaybeGetter<T> = T | (() => T);
105
105
 
106
106
  /**
107
- * The StoreOrStoreId type is used when you need to refer to a Store in a Svelte
108
- * hook or component.
107
+ * The StoreOrStoreId type is used when you need to refer to a Store in a
108
+ * ui-svelte function or component.
109
109
  *
110
110
  * In some simple cases you will already have a direct reference to the Store.
111
111
  *
@@ -113,7 +113,7 @@ export type MaybeGetter<T> = T | (() => T);
113
113
  * multiple Store objects into a context that can be used throughout the app. In
114
114
  * this case you will want to refer to a Store by its Id in that context.
115
115
  *
116
- * Many hooks and components in this ui-svelte module take this type as a
116
+ * Many functions and components in this ui-svelte module take this type as a
117
117
  * parameter or a prop, allowing you to pass in either the Store or its Id.
118
118
  * @category Identity
119
119
  * @since v8.1.0
@@ -122,19 +122,19 @@ export type StoreOrStoreId = Store | Id;
122
122
 
123
123
  /**
124
124
  * The MetricsOrMetricsId type is used when you need to refer to a Metrics
125
- * object in a Svelte hook or component.
125
+ * object in a ui-svelte function or component.
126
126
  *
127
- * In some simple cases you will already have a direct reference to the Metrics
128
- * object.
127
+ * In some simple cases you will already have a direct reference to the
128
+ * Metrics object.
129
129
  *
130
130
  * This module also includes a Provider component that can be used to wrap
131
131
  * multiple Metrics objects into a context that can be used throughout the app.
132
- * In this case you will want to refer to a Metrics object by its Id in that
133
- * context.
132
+ * In this case you will want to refer to a Metrics object by its Id in
133
+ * that context.
134
134
  *
135
- * Many hooks and components in this ui-svelte module take this type as a
136
- * parameter or a prop, allowing you to pass in either the Metrics object or its
137
- * Id.
135
+ * Many functions and components in this ui-svelte module take this type as a
136
+ * parameter or a prop, allowing you to pass in either the Metrics object or
137
+ * its Id.
138
138
  * @category Identity
139
139
  * @since v8.1.0
140
140
  */
@@ -142,19 +142,19 @@ export type MetricsOrMetricsId = Metrics | Id;
142
142
 
143
143
  /**
144
144
  * The IndexesOrIndexesId type is used when you need to refer to an Indexes
145
- * object in a Svelte hook or component.
145
+ * object in a ui-svelte function or component.
146
146
  *
147
- * In some simple cases you will already have a direct reference to the Indexes
148
- * object.
147
+ * In some simple cases you will already have a direct reference to the
148
+ * Indexes object.
149
149
  *
150
150
  * This module also includes a Provider component that can be used to wrap
151
151
  * multiple Indexes objects into a context that can be used throughout the app.
152
- * In this case you will want to refer to an Indexes object by its Id in that
153
- * context.
152
+ * In this case you will want to refer to an Indexes object by its Id in
153
+ * that context.
154
154
  *
155
- * Many hooks and components in this ui-svelte module take this type as a
156
- * parameter or a prop, allowing you to pass in either the Indexes object or its
157
- * Id.
155
+ * Many functions and components in this ui-svelte module take this type as a
156
+ * parameter or a prop, allowing you to pass in either the Indexes object or
157
+ * its Id.
158
158
  * @category Identity
159
159
  * @since v8.1.0
160
160
  */
@@ -162,7 +162,7 @@ export type IndexesOrIndexesId = Indexes | Id;
162
162
 
163
163
  /**
164
164
  * The RelationshipsOrRelationshipsId type is used when you need to refer to a
165
- * Relationships object in a Svelte hook or component.
165
+ * Relationships object in a ui-svelte function or component.
166
166
  *
167
167
  * In some simple cases you will already have a direct reference to the
168
168
  * Relationships object.
@@ -172,7 +172,7 @@ export type IndexesOrIndexesId = Indexes | Id;
172
172
  * app. In this case you will want to refer to a Relationships object by its Id
173
173
  * in that context.
174
174
  *
175
- * Many hooks and components in this ui-svelte module take this type as a
175
+ * Many functions and components in this ui-svelte module take this type as a
176
176
  * parameter or a prop, allowing you to pass in either the Relationships object
177
177
  * or its Id.
178
178
  * @category Identity
@@ -182,19 +182,19 @@ export type RelationshipsOrRelationshipsId = Relationships | Id;
182
182
 
183
183
  /**
184
184
  * The QueriesOrQueriesId type is used when you need to refer to a Queries
185
- * object in a Svelte hook or component.
185
+ * object in a ui-svelte function or component.
186
186
  *
187
- * In some simple cases you will already have a direct reference to the Queries
188
- * object.
187
+ * In some simple cases you will already have a direct reference to the
188
+ * Queries object.
189
189
  *
190
190
  * This module also includes a Provider component that can be used to wrap
191
191
  * multiple Queries objects into a context that can be used throughout the app.
192
- * In this case you will want to refer to a Queries object by its Id in that
193
- * context.
192
+ * In this case you will want to refer to a Queries object by its Id in
193
+ * that context.
194
194
  *
195
- * Many hooks and components in this ui-svelte module take this type as a
196
- * parameter or a prop, allowing you to pass in either the Queries object or its
197
- * Id.
195
+ * Many functions and components in this ui-svelte module take this type as a
196
+ * parameter or a prop, allowing you to pass in either the Queries object or
197
+ * its Id.
198
198
  * @category Identity
199
199
  * @since v8.1.0
200
200
  */
@@ -202,7 +202,7 @@ export type QueriesOrQueriesId = Queries | Id;
202
202
 
203
203
  /**
204
204
  * The CheckpointsOrCheckpointsId type is used when you need to refer to a
205
- * Checkpoints object in a Svelte hook or component.
205
+ * Checkpoints object in a ui-svelte function or component.
206
206
  *
207
207
  * In some simple cases you will already have a direct reference to the
208
208
  * Checkpoints object.
@@ -212,7 +212,7 @@ export type QueriesOrQueriesId = Queries | Id;
212
212
  * app. In this case you will want to refer to a Checkpoints object by its Id in
213
213
  * that context.
214
214
  *
215
- * Many hooks and components in this ui-svelte module take this type as a
215
+ * Many functions and components in this ui-svelte module take this type as a
216
216
  * parameter or a prop, allowing you to pass in either the Checkpoints object or
217
217
  * its Id.
218
218
  * @category Identity
@@ -222,7 +222,7 @@ export type CheckpointsOrCheckpointsId = Checkpoints | Id;
222
222
 
223
223
  /**
224
224
  * The PersisterOrPersisterId type is used when you need to refer to a Persister
225
- * object in a Svelte hook or component.
225
+ * object in a ui-svelte function or component.
226
226
  *
227
227
  * In some simple cases you will already have a direct reference to the
228
228
  * Persister object.
@@ -232,7 +232,7 @@ export type CheckpointsOrCheckpointsId = Checkpoints | Id;
232
232
  * app. In this case you will want to refer to a Persister object by its Id in
233
233
  * that context.
234
234
  *
235
- * Many hooks and components in this ui-svelte module take this type as a
235
+ * Many functions and components in this ui-svelte module take this type as a
236
236
  * parameter or a prop, allowing you to pass in either the Persister or its Id.
237
237
  * @category Identity
238
238
  * @since v8.1.0
@@ -241,7 +241,7 @@ export type PersisterOrPersisterId = AnyPersister | Id;
241
241
 
242
242
  /**
243
243
  * The SynchronizerOrSynchronizerId type is used when you need to refer to a
244
- * Synchronizer object in a Svelte hook or component.
244
+ * Synchronizer object in a ui-svelte function or component.
245
245
  *
246
246
  * In some simple cases you will already have a direct reference to the
247
247
  * Synchronizer object.
@@ -251,9 +251,9 @@ export type PersisterOrPersisterId = AnyPersister | Id;
251
251
  * app. In this case you will want to refer to a Synchronizer object by its Id
252
252
  * in that context.
253
253
  *
254
- * Many hooks and components in this ui-svelte module take this type as a
255
- * parameter or a prop, allowing you to pass in either the Synchronizer or its
256
- * Id.
254
+ * Many functions and components in this ui-svelte module take this type as a
255
+ * parameter or a prop, allowing you to pass in either the Synchronizer or
256
+ * its Id.
257
257
  * @category Identity
258
258
  * @since v8.1.0
259
259
  */
@@ -483,8 +483,8 @@ export type MetricViewProps = {
483
483
  };
484
484
 
485
485
  /**
486
- * The CheckpointViewProps type describes the props of the CheckpointView
487
- * component.
486
+ * The CheckpointViewProps type describes the props of the
487
+ * CheckpointView component.
488
488
  * @category Props
489
489
  * @since v8.1.0
490
490
  */
@@ -604,8 +604,8 @@ export type TableViewProps = {
604
604
  };
605
605
 
606
606
  /**
607
- * The SortedTableViewProps type describes the props of the SortedTableView
608
- * component.
607
+ * The SortedTableViewProps type describes the props of the
608
+ * SortedTableView component.
609
609
  * @category Props
610
610
  * @since v8.1.0
611
611
  */
@@ -819,8 +819,8 @@ export type SliceViewProps = {
819
819
  };
820
820
 
821
821
  /**
822
- * The RemoteRowViewProps type describes the props of the RemoteRowView
823
- * component.
822
+ * The RemoteRowViewProps type describes the props of the
823
+ * RemoteRowView component.
824
824
  * @category Props
825
825
  * @since v8.1.0
826
826
  */
@@ -858,8 +858,8 @@ export type RemoteRowViewProps = {
858
858
  };
859
859
 
860
860
  /**
861
- * The LocalRowsViewProps type describes the props of the LocalRowsView
862
- * component.
861
+ * The LocalRowsViewProps type describes the props of the
862
+ * LocalRowsView component.
863
863
  * @category Props
864
864
  * @since v8.1.0
865
865
  */
@@ -903,8 +903,8 @@ export type LocalRowsViewProps = {
903
903
  };
904
904
 
905
905
  /**
906
- * The LinkedRowsViewProps type describes the props of the LinkedRowsView
907
- * component.
906
+ * The LinkedRowsViewProps type describes the props of the
907
+ * LinkedRowsView component.
908
908
  * @category Props
909
909
  * @since v8.1.0
910
910
  */
@@ -948,8 +948,8 @@ export type LinkedRowsViewProps = {
948
948
  };
949
949
 
950
950
  /**
951
- * The ResultCellViewProps type describes the props of the ResultCellView
952
- * component.
951
+ * The ResultCellViewProps type describes the props of the
952
+ * ResultCellView component.
953
953
  * @category Props
954
954
  * @since v8.1.0
955
955
  */
@@ -987,8 +987,8 @@ export type ResultCellViewProps = {
987
987
  };
988
988
 
989
989
  /**
990
- * The ResultRowViewProps type describes the props of the ResultRowView
991
- * component.
990
+ * The ResultRowViewProps type describes the props of the
991
+ * ResultRowView component.
992
992
  * @category Props
993
993
  * @since v8.1.0
994
994
  */
@@ -1032,8 +1032,8 @@ export type ResultRowViewProps = {
1032
1032
  };
1033
1033
 
1034
1034
  /**
1035
- * The ResultTableViewProps type describes the props of the ResultTableView
1036
- * component.
1035
+ * The ResultTableViewProps type describes the props of the
1036
+ * ResultTableView component.
1037
1037
  * @category Props
1038
1038
  * @since v8.1.0
1039
1039
  */
@@ -1315,8 +1315,8 @@ export const IndexView: Component<IndexViewProps>;
1315
1315
 
1316
1316
  /**
1317
1317
  * The LinkedRowsView component renders the Rows in a linked list Relationship,
1318
- * and registers a listener so that any changes to that result will cause a
1319
- * re-render.
1318
+ * and registers a listener so that any changes to that result will cause
1319
+ * a re-render.
1320
1320
  * @param props The props for this component.
1321
1321
  * @returns A rendering of the linked Row Ids.
1322
1322
  * @category Component
@@ -1403,8 +1403,8 @@ export const ResultTableView: Component<ResultTableViewProps>;
1403
1403
 
1404
1404
  /**
1405
1405
  * The RowView component renders the contents of a single Row in a given Table,
1406
- * and registers a listener so that any changes to that result will cause a
1407
- * re-render.
1406
+ * and registers a listener so that any changes to that result will cause
1407
+ * a re-render.
1408
1408
  * @param props The props for this component.
1409
1409
  * @returns A rendering of the Row, or nothing if not present.
1410
1410
  * @category Component
@@ -1414,8 +1414,8 @@ export const RowView: Component<RowViewProps>;
1414
1414
 
1415
1415
  /**
1416
1416
  * The SliceView component renders the Row Ids in a named Slice in an Index, and
1417
- * registers a listener so that any changes to that result will cause a
1418
- * re-render.
1417
+ * registers a listener so that any changes to that result will cause
1418
+ * a re-render.
1419
1419
  * @param props The props for this component.
1420
1420
  * @returns A rendering of the Rows in the Slice.
1421
1421
  * @category Component
@@ -1446,8 +1446,8 @@ export const TableView: Component<TableViewProps>;
1446
1446
 
1447
1447
  /**
1448
1448
  * The TablesView component renders the contents of all Tables in a Store, and
1449
- * registers a listener so that any changes to that result will cause a
1450
- * re-render.
1449
+ * registers a listener so that any changes to that result will cause
1450
+ * a re-render.
1451
1451
  * @param props The props for this component.
1452
1452
  * @returns A rendering of all Tables.
1453
1453
  * @category Component
@@ -1457,8 +1457,8 @@ export const TablesView: Component<TablesViewProps>;
1457
1457
 
1458
1458
  /**
1459
1459
  * The ValueView component renders the value of a single Value in a Store, and
1460
- * registers a listener so that any changes to that result will cause a
1461
- * re-render.
1460
+ * registers a listener so that any changes to that result will cause
1461
+ * a re-render.
1462
1462
  * @param props The props for this component.
1463
1463
  * @returns A rendering of the Value, or nothing if not present.
1464
1464
  * @category Component
@@ -1477,146 +1477,146 @@ export const ValueView: Component<ValueViewProps>;
1477
1477
  export const ValuesView: Component<ValuesViewProps>;
1478
1478
 
1479
1479
  /**
1480
- * The useHasTables hook returns a reactive object indicating whether any Tables
1481
- * exist in the Store, and registers a listener so that any changes to that
1482
- * result will update `.current`.
1480
+ * The createHasTables function returns a reactive object indicating whether any
1481
+ * Tables exist in the Store, and registers a listener so that any changes to
1482
+ * that result will update `.current`.
1483
1483
  * @param storeOrStoreId The Store to use, or its Id in a Provider context.
1484
1484
  * @returns A reactive object with a `current` boolean property.
1485
- * @category Hook
1485
+ * @category Getter
1486
1486
  * @since v8.1.0
1487
1487
  */
1488
- export function useHasTables(
1488
+ export function createHasTables(
1489
1489
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1490
1490
  ): {
1491
1491
  readonly current: boolean;
1492
1492
  };
1493
1493
 
1494
1494
  /**
1495
- * The useTables hook returns a reactive object reflecting the Tables in the
1496
- * Store, and registers a listener so that any changes to those Tables will
1495
+ * The createTables function returns a reactive object reflecting the Tables in
1496
+ * the Store, and registers a listener so that any changes to those Tables will
1497
1497
  * update `.current`.
1498
1498
  * @param storeOrStoreId The Store to use, or its Id in a Provider context.
1499
1499
  * @returns A reactive object with a `current` Tables property.
1500
- * @category Hook
1500
+ * @category Getter
1501
1501
  * @since v8.1.0
1502
1502
  */
1503
- export function useTables(
1503
+ export function createTables(
1504
1504
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1505
1505
  ): {
1506
1506
  readonly current: Tables;
1507
1507
  };
1508
1508
 
1509
1509
  /**
1510
- * The useTableIds hook returns a reactive object reflecting the Ids of the
1511
- * Tables in a Store, and registers a listener so that any changes to those Ids
1512
- * will update `.current`.
1510
+ * The createTableIds function returns a reactive object reflecting the Ids of
1511
+ * the Tables in a Store, and registers a listener so that any changes to those
1512
+ * Ids will update `.current`.
1513
1513
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1514
1514
  * @returns A reactive object with a `current` Ids property.
1515
- * @category Hook
1515
+ * @category Getter
1516
1516
  * @since v8.1.0
1517
1517
  */
1518
- export function useTableIds(
1518
+ export function createTableIds(
1519
1519
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1520
1520
  ): {
1521
1521
  readonly current: Ids;
1522
1522
  };
1523
1523
 
1524
1524
  /**
1525
- * The useHasTable hook returns a reactive object indicating whether a Table
1526
- * exists in the Store, and registers a listener so that any changes to that
1527
- * result will update `.current`.
1525
+ * The createHasTable function returns a reactive object indicating whether a
1526
+ * Table exists in the Store, and registers a listener so that any changes to
1527
+ * that result will update `.current`.
1528
1528
  * @param tableId The Id of the Table (or a getter returning it).
1529
1529
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1530
1530
  * @returns A reactive object with a `current` boolean property.
1531
- * @category Hook
1531
+ * @category Getter
1532
1532
  * @since v8.1.0
1533
1533
  */
1534
- export function useHasTable(
1534
+ export function createHasTable(
1535
1535
  tableId: MaybeGetter<Id>,
1536
1536
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1537
1537
  ): {readonly current: boolean};
1538
1538
 
1539
1539
  /**
1540
- * The useTable hook returns a reactive object reflecting a Table in a Store,
1541
- * and registers a listener so that any changes to that Table will update
1542
- * `.current`.
1540
+ * The createTable function returns a reactive object reflecting a Table in a
1541
+ * Store, and registers a listener so that any changes to that Table will
1542
+ * update `.current`.
1543
1543
  * @param tableId The Id of the Table (or a getter returning it).
1544
1544
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1545
1545
  * @returns A reactive object with a `current` Table property.
1546
- * @category Hook
1546
+ * @category Getter
1547
1547
  * @since v8.1.0
1548
1548
  */
1549
- export function useTable(
1549
+ export function createTable(
1550
1550
  tableId: MaybeGetter<Id>,
1551
1551
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1552
1552
  ): {readonly current: Table};
1553
1553
 
1554
1554
  /**
1555
- * The useTableCellIds hook returns a reactive object reflecting the Ids of all
1556
- * Cells used across a Table, and registers a listener so that any changes to
1557
- * those Ids will update `.current`.
1555
+ * The createTableCellIds function returns a reactive object reflecting the Ids
1556
+ * of all Cells used across a Table, and registers a listener so that any
1557
+ * changes to those Ids will update `.current`.
1558
1558
  * @param tableId The Id of the Table (or a getter returning it).
1559
1559
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1560
1560
  * @returns A reactive object with a `current` Ids property.
1561
- * @category Hook
1561
+ * @category Getter
1562
1562
  * @since v8.1.0
1563
1563
  */
1564
- export function useTableCellIds(
1564
+ export function createTableCellIds(
1565
1565
  tableId: MaybeGetter<Id>,
1566
1566
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1567
1567
  ): {readonly current: Ids};
1568
1568
 
1569
1569
  /**
1570
- * The useHasTableCell hook returns a reactive object indicating whether a
1571
- * particular Cell is used anywhere in a Table, and registers a listener so that
1572
- * any changes to that result will update `.current`.
1570
+ * The createHasTableCell function returns a reactive object indicating whether
1571
+ * a particular Cell is used anywhere in a Table, and registers a listener so
1572
+ * that any changes to that result will update `.current`.
1573
1573
  * @param tableId The Id of the Table (or a getter returning it).
1574
1574
  * @param cellId The Id of the Cell (or a getter returning it).
1575
1575
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1576
1576
  * @returns A reactive object with a `current` boolean property.
1577
- * @category Hook
1577
+ * @category Getter
1578
1578
  * @since v8.1.0
1579
1579
  */
1580
- export function useHasTableCell(
1580
+ export function createHasTableCell(
1581
1581
  tableId: MaybeGetter<Id>,
1582
1582
  cellId: MaybeGetter<Id>,
1583
1583
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1584
1584
  ): {readonly current: boolean};
1585
1585
 
1586
1586
  /**
1587
- * The useRowCount hook returns a reactive object reflecting the number of Rows
1588
- * in a Table, and registers a listener so that any changes will update
1589
- * `.current`.
1587
+ * The createRowCount function returns a reactive object reflecting the number
1588
+ * of Rows in a Table, and registers a listener so that any changes will
1589
+ * update `.current`.
1590
1590
  * @param tableId The Id of the Table (or a getter returning it).
1591
1591
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1592
1592
  * @returns A reactive object with a `current` number property.
1593
- * @category Hook
1593
+ * @category Getter
1594
1594
  * @since v8.1.0
1595
1595
  */
1596
- export function useRowCount(
1596
+ export function createRowCount(
1597
1597
  tableId: MaybeGetter<Id>,
1598
1598
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1599
1599
  ): {readonly current: number};
1600
1600
 
1601
1601
  /**
1602
- * The useRowIds hook returns a reactive object reflecting the Ids of the Rows
1603
- * in a Table, and registers a listener so that any changes will update
1604
- * `.current`.
1602
+ * The createRowIds function returns a reactive object reflecting the Ids of the
1603
+ * Rows in a Table, and registers a listener so that any changes will
1604
+ * update `.current`.
1605
1605
  * @param tableId The Id of the Table (or a getter returning it).
1606
1606
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1607
1607
  * @returns A reactive object with a `current` Ids property.
1608
- * @category Hook
1608
+ * @category Getter
1609
1609
  * @since v8.1.0
1610
1610
  */
1611
- export function useRowIds(
1611
+ export function createRowIds(
1612
1612
  tableId: MaybeGetter<Id>,
1613
1613
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1614
1614
  ): {readonly current: Ids};
1615
1615
 
1616
1616
  /**
1617
- * The useSortedRowIds hook returns a reactive object reflecting the sorted Row
1618
- * Ids in a Table, and registers a listener so that any changes will update
1619
- * `.current`.
1617
+ * The createSortedRowIds function returns a reactive object reflecting the
1618
+ * sorted Row Ids in a Table, and registers a listener so that any changes will
1619
+ * update `.current`.
1620
1620
  * @param tableId The Id of the Table (or a getter returning it).
1621
1621
  * @param cellId The Id of the Cell to sort by (or a getter returning it).
1622
1622
  * @param descending Whether to sort descending (or a getter returning it).
@@ -1624,10 +1624,10 @@ export function useRowIds(
1624
1624
  * @param limit The maximum number of Rows to return (or a getter returning it).
1625
1625
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1626
1626
  * @returns A reactive object with a `current` Ids property.
1627
- * @category Hook
1627
+ * @category Getter
1628
1628
  * @since v8.1.0
1629
1629
  */
1630
- export function useSortedRowIds(
1630
+ export function createSortedRowIds(
1631
1631
  tableId: MaybeGetter<Id>,
1632
1632
  cellId?: MaybeGetter<Id | undefined>,
1633
1633
  descending?: MaybeGetter<boolean>,
@@ -1637,68 +1637,69 @@ export function useSortedRowIds(
1637
1637
  ): {readonly current: Ids};
1638
1638
 
1639
1639
  /**
1640
- * The useHasRow hook returns a reactive object indicating whether a Row exists
1641
- * in a Table, and registers a listener so that any changes to that result will
1642
- * update `.current`.
1640
+ * The createHasRow function returns a reactive object indicating whether a Row
1641
+ * exists in a Table, and registers a listener so that any changes to that
1642
+ * result will update `.current`.
1643
1643
  * @param tableId The Id of the Table (or a getter returning it).
1644
1644
  * @param rowId The Id of the Row (or a getter returning it).
1645
1645
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1646
1646
  * @returns A reactive object with a `current` boolean property.
1647
- * @category Hook
1647
+ * @category Getter
1648
1648
  * @since v8.1.0
1649
1649
  */
1650
- export function useHasRow(
1650
+ export function createHasRow(
1651
1651
  tableId: MaybeGetter<Id>,
1652
1652
  rowId: MaybeGetter<Id>,
1653
1653
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1654
1654
  ): {readonly current: boolean};
1655
1655
 
1656
1656
  /**
1657
- * The useRow hook returns a reactive object reflecting a Row in a Table, and
1658
- * registers a listener so that any changes to that Row will update `.current`.
1657
+ * The createRow function returns a reactive object reflecting a Row in a Table,
1658
+ * and registers a listener so that any changes to that Row will
1659
+ * update `.current`.
1659
1660
  * @param tableId The Id of the Table (or a getter returning it).
1660
1661
  * @param rowId The Id of the Row (or a getter returning it).
1661
1662
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1662
1663
  * @returns A reactive object with a `current` Row property.
1663
- * @category Hook
1664
+ * @category Getter
1664
1665
  * @since v8.1.0
1665
1666
  */
1666
- export function useRow(
1667
+ export function createRow(
1667
1668
  tableId: MaybeGetter<Id>,
1668
1669
  rowId: MaybeGetter<Id>,
1669
1670
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1670
1671
  ): {readonly current: Row};
1671
1672
 
1672
1673
  /**
1673
- * The useCellIds hook returns a reactive object reflecting the Ids of the Cells
1674
- * in a Row, and registers a listener so that any changes will update
1675
- * `.current`.
1674
+ * The createCellIds function returns a reactive object reflecting the Ids of
1675
+ * the Cells in a Row, and registers a listener so that any changes will
1676
+ * update `.current`.
1676
1677
  * @param tableId The Id of the Table (or a getter returning it).
1677
1678
  * @param rowId The Id of the Row (or a getter returning it).
1678
1679
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1679
1680
  * @returns A reactive object with a `current` Ids property.
1680
- * @category Hook
1681
+ * @category Getter
1681
1682
  * @since v8.1.0
1682
1683
  */
1683
- export function useCellIds(
1684
+ export function createCellIds(
1684
1685
  tableId: MaybeGetter<Id>,
1685
1686
  rowId: MaybeGetter<Id>,
1686
1687
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1687
1688
  ): {readonly current: Ids};
1688
1689
 
1689
1690
  /**
1690
- * The useHasCell hook returns a reactive object indicating whether a Cell
1691
- * exists in a Row in a Table, and registers a listener so that any changes to
1692
- * that result will update `.current`.
1691
+ * The createHasCell function returns a reactive object indicating whether a
1692
+ * Cell exists in a Row in a Table, and registers a listener so that any changes
1693
+ * to that result will update `.current`.
1693
1694
  * @param tableId The Id of the Table (or a getter returning it).
1694
1695
  * @param rowId The Id of the Row (or a getter returning it).
1695
1696
  * @param cellId The Id of the Cell (or a getter returning it).
1696
1697
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1697
1698
  * @returns A reactive object with a `current` boolean property.
1698
- * @category Hook
1699
+ * @category Getter
1699
1700
  * @since v8.1.0
1700
1701
  */
1701
- export function useHasCell(
1702
+ export function createHasCell(
1702
1703
  tableId: MaybeGetter<Id>,
1703
1704
  rowId: MaybeGetter<Id>,
1704
1705
  cellId: MaybeGetter<Id>,
@@ -1706,45 +1707,30 @@ export function useHasCell(
1706
1707
  ): {readonly current: boolean};
1707
1708
 
1708
1709
  /**
1709
- * The useCell hook returns a reactive object reflecting the value of a Cell in
1710
- * a Row in a Table, and registers a listener so that any changes to that Cell
1711
- * will update `.current`.
1710
+ * The createCell function returns a reactive object reflecting the value of a
1711
+ * Cell in a Row in a Table, and registers a listener so that any changes to
1712
+ * that Cell will update `.current`.
1713
+ *
1714
+ * Since Cells are mutable leaf values in a Store, the returned object's
1715
+ * `current` property can also be assigned to write back to the Store.
1712
1716
  * @param tableId The Id of the Table (or a getter returning it).
1713
1717
  * @param rowId The Id of the Row (or a getter returning it).
1714
1718
  * @param cellId The Id of the Cell (or a getter returning it).
1715
1719
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1716
- * @returns A reactive object with a `current` CellOrUndefined property.
1720
+ * @returns A reactive object with gettable and settable `current`.
1717
1721
  * @example
1718
- * This example uses the useCell hook to display a Cell value reactively.
1722
+ * This example uses the createCell function to display a Cell value reactively.
1719
1723
  *
1720
1724
  * ```ts
1721
1725
  * // In a .svelte file:
1722
1726
  * // const store = createStore().setCell('pets', 'cat', 'name', 'Fido');
1723
- * // const name = useCell('pets', 'cat', 'name', store);
1727
+ * // const name = createCell('pets', 'cat', 'name', store);
1724
1728
  * // $: console.log(name.current); // 'Fido'
1725
1729
  * ```
1726
- * @category Hook
1730
+ * @category Getter
1727
1731
  * @since v8.1.0
1728
1732
  */
1729
- export function useCell(
1730
- tableId: MaybeGetter<Id>,
1731
- rowId: MaybeGetter<Id>,
1732
- cellId: MaybeGetter<Id>,
1733
- storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1734
- ): {readonly current: CellOrUndefined};
1735
-
1736
- /**
1737
- * The useBindableCell hook returns a reactive object reflecting the value of a
1738
- * Cell, with a settable `current` property that writes back to the Store.
1739
- * @param tableId The Id of the Table (or a getter returning it).
1740
- * @param rowId The Id of the Row (or a getter returning it).
1741
- * @param cellId The Id of the Cell (or a getter returning it).
1742
- * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1743
- * @returns A reactive object with gettable and settable `current`.
1744
- * @category Hook
1745
- * @since v8.1.0
1746
- */
1747
- export function useBindableCell(
1733
+ export function createCell(
1748
1734
  tableId: MaybeGetter<Id>,
1749
1735
  rowId: MaybeGetter<Id>,
1750
1736
  cellId: MaybeGetter<Id>,
@@ -1752,396 +1738,386 @@ export function useBindableCell(
1752
1738
  ): {get current(): CellOrUndefined; set current(v: Cell)};
1753
1739
 
1754
1740
  /**
1755
- * The useHasValues hook returns a reactive object indicating whether any Values
1756
- * exist in the Store, and registers a listener so that any changes to that
1757
- * result will update `.current`.
1741
+ * The createHasValues function returns a reactive object indicating whether any
1742
+ * Values exist in the Store, and registers a listener so that any changes to
1743
+ * that result will update `.current`.
1758
1744
  * @param storeOrStoreId The Store to use, or its Id in a Provider context.
1759
1745
  * @returns A reactive object with a `current` boolean property.
1760
- * @category Hook
1746
+ * @category Getter
1761
1747
  * @since v8.1.0
1762
1748
  */
1763
- export function useHasValues(
1749
+ export function createHasValues(
1764
1750
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1765
1751
  ): {
1766
1752
  readonly current: boolean;
1767
1753
  };
1768
1754
 
1769
1755
  /**
1770
- * The useValues hook returns a reactive object reflecting the Values in the
1771
- * Store, and registers a listener so that any changes will update `.current`.
1756
+ * The createValues function returns a reactive object reflecting the Values in
1757
+ * the Store, and registers a listener so that any changes will
1758
+ * update `.current`.
1772
1759
  * @param storeOrStoreId The Store to use, or its Id in a Provider context.
1773
1760
  * @returns A reactive object with a `current` Values property.
1774
- * @category Hook
1761
+ * @category Getter
1775
1762
  * @since v8.1.0
1776
1763
  */
1777
- export function useValues(
1764
+ export function createValues(
1778
1765
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1779
1766
  ): {
1780
1767
  readonly current: Values;
1781
1768
  };
1782
1769
 
1783
1770
  /**
1784
- * The useValueIds hook returns a reactive object reflecting the Ids of the
1785
- * Values in a Store, and registers a listener so that any changes will update
1786
- * `.current`.
1771
+ * The createValueIds function returns a reactive object reflecting the Ids of
1772
+ * the Values in a Store, and registers a listener so that any changes will
1773
+ * update `.current`.
1787
1774
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1788
1775
  * @returns A reactive object with a `current` Ids property.
1789
- * @category Hook
1776
+ * @category Getter
1790
1777
  * @since v8.1.0
1791
1778
  */
1792
- export function useValueIds(
1779
+ export function createValueIds(
1793
1780
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1794
1781
  ): {
1795
1782
  readonly current: Ids;
1796
1783
  };
1797
1784
 
1798
1785
  /**
1799
- * The useHasValue hook returns a reactive object indicating whether a Value
1800
- * exists in the Store, and registers a listener so that any changes to that
1801
- * result will update `.current`.
1786
+ * The createHasValue function returns a reactive object indicating whether a
1787
+ * Value exists in the Store, and registers a listener so that any changes to
1788
+ * that result will update `.current`.
1802
1789
  * @param valueId The Id of the Value (or a getter returning it).
1803
1790
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1804
1791
  * @returns A reactive object with a `current` boolean property.
1805
- * @category Hook
1792
+ * @category Getter
1806
1793
  * @since v8.1.0
1807
1794
  */
1808
- export function useHasValue(
1795
+ export function createHasValue(
1809
1796
  valueId: MaybeGetter<Id>,
1810
1797
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1811
1798
  ): {readonly current: boolean};
1812
1799
 
1813
1800
  /**
1814
- * The useValue hook returns a reactive object reflecting the value of a Value
1815
- * in a Store, and registers a listener so that any changes to that Value will
1816
- * update `.current`.
1817
- * @param valueId The Id of the Value (or a getter returning it).
1818
- * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1819
- * @returns A reactive object with a `current` ValueOrUndefined property.
1820
- * @category Hook
1821
- * @since v8.1.0
1822
- */
1823
- export function useValue(
1824
- valueId: MaybeGetter<Id>,
1825
- storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1826
- ): {readonly current: ValueOrUndefined};
1827
-
1828
- /**
1829
- * The useBindableValue hook returns a reactive object reflecting the value of a
1830
- * Value, with a settable `current` property that writes back to the Store.
1801
+ * The createValue function returns a reactive object reflecting the value of a
1802
+ * Value in a Store, and registers a listener so that any changes to that Value
1803
+ * will update `.current`.
1804
+ *
1805
+ * Since Values are mutable leaf values in a Store, the returned object's
1806
+ * `current` property can also be assigned to write back to the Store.
1831
1807
  * @param valueId The Id of the Value (or a getter returning it).
1832
1808
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1833
1809
  * @returns A reactive object with gettable and settable `current`.
1834
- * @category Hook
1810
+ * @category Getter
1835
1811
  * @since v8.1.0
1836
1812
  */
1837
- export function useBindableValue(
1813
+ export function createValue(
1838
1814
  valueId: MaybeGetter<Id>,
1839
1815
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1840
1816
  ): {get current(): ValueOrUndefined; set current(v: Value)};
1841
1817
 
1842
1818
  /**
1843
- * The useStore hook returns the default Store from the current Provider context
1844
- * (or a named Store if an Id is provided).
1819
+ * The getStore function returns the default Store from the current Provider
1820
+ * context (or a named Store if an Id is provided).
1845
1821
  * @param id An optional Id of a named Store in the Provider context.
1846
1822
  * @returns The Store, or `undefined` if not found.
1847
- * @category Hook
1823
+ * @category Getter
1848
1824
  * @since v8.1.0
1849
1825
  */
1850
- export function useStore(id?: Id): Store | undefined;
1826
+ export function getStore(id?: Id): Store | undefined;
1851
1827
 
1852
1828
  /**
1853
- * The useStoreOrStoreById hook is used to get a reference to a Store object
1854
- * from a Provider context, or have it passed directly.
1829
+ * The resolveStore function is used to get a reference to a Store object from a
1830
+ * Provider context, or have it passed directly.
1855
1831
  * @param storeOrStoreId The Store, its Id, or a getter returning either.
1856
1832
  * @returns A getter function returning the Store, or `undefined`.
1857
- * @category Hook
1833
+ * @category Getter
1858
1834
  * @since v8.1.0
1859
1835
  */
1860
- export function useStoreOrStoreById(
1836
+ export function resolveStore(
1861
1837
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1862
1838
  ): () => Store | undefined;
1863
1839
 
1864
1840
  /**
1865
- * The useStoreIds hook returns a reactive object with the Ids of all Stores
1866
- * registered in the current Provider context.
1841
+ * The createStoreIds function returns a reactive object with the Ids of all
1842
+ * Stores registered in the current Provider context.
1867
1843
  * @returns A reactive object with a `current` Ids property.
1868
- * @category Hook
1844
+ * @category Getter
1869
1845
  * @since v8.1.0
1870
1846
  */
1871
- export function useStoreIds(): {readonly current: Ids};
1847
+ export function createStoreIds(): {readonly current: Ids};
1872
1848
 
1873
1849
  /**
1874
- * The useMetrics hook returns the default Metrics object from the current
1850
+ * The getMetrics function returns the default Metrics object from the current
1875
1851
  * Provider context (or a named one if an Id is provided).
1876
1852
  * @param id An optional Id of a named Metrics object in the Provider context.
1877
1853
  * @returns The Metrics object, or `undefined` if not found.
1878
- * @category Hook
1854
+ * @category Getter
1879
1855
  * @since v8.1.0
1880
1856
  */
1881
- export function useMetrics(id?: Id): Metrics | undefined;
1857
+ export function getMetrics(id?: Id): Metrics | undefined;
1882
1858
 
1883
1859
  /**
1884
- * The useMetricsOrMetricsById hook is used to get a reference to a Metrics
1885
- * object from a Provider context, or have it passed directly.
1860
+ * The resolveMetrics function is used to get a reference to a Metrics object
1861
+ * from a Provider context, or have it passed directly.
1886
1862
  * @param metricsOrMetricsId The Metrics object, its Id, or a getter returning
1887
1863
  * either.
1888
1864
  * @returns A getter function returning the Metrics object, or `undefined`.
1889
- * @category Hook
1865
+ * @category Getter
1890
1866
  * @since v8.1.0
1891
1867
  */
1892
- export function useMetricsOrMetricsById(
1868
+ export function resolveMetrics(
1893
1869
  metricsOrMetricsId?: MaybeGetter<MetricsOrMetricsId | undefined>,
1894
1870
  ): () => Metrics | undefined;
1895
1871
 
1896
1872
  /**
1897
- * The useMetricsIds hook returns a reactive object with the Ids of all Metrics
1898
- * objects registered in the current Provider context.
1873
+ * The createMetricsIds function returns a reactive object with the Ids of all
1874
+ * Metrics objects registered in the current Provider context.
1899
1875
  * @returns A reactive object with a `current` Ids property.
1900
- * @category Hook
1876
+ * @category Getter
1901
1877
  * @since v8.1.0
1902
1878
  */
1903
- export function useMetricsIds(): {readonly current: Ids};
1879
+ export function createMetricsIds(): {readonly current: Ids};
1904
1880
 
1905
1881
  /**
1906
- * The useMetricIds hook returns a reactive object reflecting the Ids of the
1907
- * Metrics in a Metrics object, and registers a listener so that any changes
1882
+ * The createMetricIds function returns a reactive object reflecting the Ids of
1883
+ * the Metrics in a Metrics object, and registers a listener so that any changes
1908
1884
  * will update `.current`.
1909
1885
  * @param metricsOrMetricsId The Metrics object to use, or its Id.
1910
1886
  * @returns A reactive object with a `current` Ids property.
1911
- * @category Hook
1887
+ * @category Getter
1912
1888
  * @since v8.1.0
1913
1889
  */
1914
- export function useMetricIds(
1890
+ export function createMetricIds(
1915
1891
  metricsOrMetricsId?: MaybeGetter<MetricsOrMetricsId | undefined>,
1916
1892
  ): {
1917
1893
  readonly current: Ids;
1918
1894
  };
1919
1895
 
1920
1896
  /**
1921
- * The useMetric hook returns a reactive object reflecting the value of a named
1922
- * Metric in a Metrics object, and registers a listener so that any changes to
1923
- * that Metric will update `.current`.
1897
+ * The createMetric function returns a reactive object reflecting the value of a
1898
+ * named Metric in a Metrics object, and registers a listener so that any
1899
+ * changes to that Metric will update `.current`.
1924
1900
  * @param metricId The Id of the Metric (or a getter returning it).
1925
1901
  * @param metricsOrMetricsId The Metrics object to use (plain or getter), or its
1926
1902
  * Id.
1927
1903
  * @returns A reactive object with a `current` number | undefined property.
1928
- * @category Hook
1904
+ * @category Getter
1929
1905
  * @since v8.1.0
1930
1906
  */
1931
- export function useMetric(
1907
+ export function createMetric(
1932
1908
  metricId: MaybeGetter<Id>,
1933
1909
  metricsOrMetricsId?: MaybeGetter<MetricsOrMetricsId | undefined>,
1934
1910
  ): {readonly current: number | undefined};
1935
1911
 
1936
1912
  /**
1937
- * The useIndexes hook returns the default Indexes object from the current
1913
+ * The getIndexes function returns the default Indexes object from the current
1938
1914
  * Provider context (or a named one if an Id is provided).
1939
1915
  * @param id An optional Id of a named Indexes object in the Provider context.
1940
1916
  * @returns The Indexes object, or `undefined` if not found.
1941
- * @category Hook
1917
+ * @category Getter
1942
1918
  * @since v8.1.0
1943
1919
  */
1944
- export function useIndexes(id?: Id): Indexes | undefined;
1920
+ export function getIndexes(id?: Id): Indexes | undefined;
1945
1921
 
1946
1922
  /**
1947
- * The useIndexesOrIndexesById hook is used to get a reference to an Indexes
1948
- * object from a Provider context, or have it passed directly.
1923
+ * The resolveIndexes function is used to get a reference to an Indexes object
1924
+ * from a Provider context, or have it passed directly.
1949
1925
  * @param indexesOrIndexesId The Indexes object, its Id, or a getter returning
1950
1926
  * either.
1951
1927
  * @returns A getter function returning the Indexes object, or `undefined`.
1952
- * @category Hook
1928
+ * @category Getter
1953
1929
  * @since v8.1.0
1954
1930
  */
1955
- export function useIndexesOrIndexesById(
1931
+ export function resolveIndexes(
1956
1932
  indexesOrIndexesId?: MaybeGetter<IndexesOrIndexesId | undefined>,
1957
1933
  ): () => Indexes | undefined;
1958
1934
 
1959
1935
  /**
1960
- * The useIndexStoreTableId hook returns the Store and table Id for a given
1936
+ * The getIndexStoreTableId function returns the Store and table Id for a given
1961
1937
  * Indexes object and index Id.
1962
1938
  * @param indexesOrId The Indexes object, its Id, or a getter returning either.
1963
1939
  * @param indexId The Id of the index, or a getter returning it.
1964
1940
  * @returns An object with `store` and `tableId` getter properties.
1965
- * @category Hook
1941
+ * @category Getter
1966
1942
  * @since v8.1.0
1967
1943
  */
1968
- export function useIndexStoreTableId(
1944
+ export function getIndexStoreTableId(
1969
1945
  indexesOrId: MaybeGetter<IndexesOrIndexesId | undefined>,
1970
1946
  indexId: MaybeGetter<Id>,
1971
1947
  ): {readonly store: Store | undefined; readonly tableId: Id | undefined};
1972
1948
 
1973
1949
  /**
1974
- * The useIndexesIds hook returns a reactive object with the Ids of all Indexes
1975
- * objects registered in the current Provider context.
1950
+ * The createIndexesIds function returns a reactive object with the Ids of all
1951
+ * Indexes objects registered in the current Provider context.
1976
1952
  * @returns A reactive object with a `current` Ids property.
1977
- * @category Hook
1953
+ * @category Getter
1978
1954
  * @since v8.1.0
1979
1955
  */
1980
- export function useIndexesIds(): {readonly current: Ids};
1956
+ export function createIndexesIds(): {readonly current: Ids};
1981
1957
 
1982
1958
  /**
1983
- * The useIndexIds hook returns a reactive object reflecting the Ids of the
1984
- * Indexes in an Indexes object, and registers a listener so that any changes
1985
- * will update `.current`.
1959
+ * The createIndexIds function returns a reactive object reflecting the Ids of
1960
+ * the Indexes in an Indexes object, and registers a listener so that any
1961
+ * changes will update `.current`.
1986
1962
  * @param indexesOrIndexesId The Indexes object to use, or its Id.
1987
1963
  * @returns A reactive object with a `current` Ids property.
1988
- * @category Hook
1964
+ * @category Getter
1989
1965
  * @since v8.1.0
1990
1966
  */
1991
- export function useIndexIds(
1967
+ export function createIndexIds(
1992
1968
  indexesOrIndexesId?: MaybeGetter<IndexesOrIndexesId | undefined>,
1993
1969
  ): {
1994
1970
  readonly current: Ids;
1995
1971
  };
1996
1972
 
1997
1973
  /**
1998
- * The useSliceIds hook returns a reactive object reflecting the Ids of the
1999
- * Slices in an Index, and registers a listener so that any changes will update
2000
- * `.current`.
1974
+ * The createSliceIds function returns a reactive object reflecting the Ids of
1975
+ * the Slices in an Index, and registers a listener so that any changes will
1976
+ * update `.current`.
2001
1977
  * @param indexId The Id of the Index (or a getter returning it).
2002
1978
  * @param indexesOrIndexesId The Indexes object to use (plain or getter), or its
2003
1979
  * Id.
2004
1980
  * @returns A reactive object with a `current` Ids property.
2005
- * @category Hook
1981
+ * @category Getter
2006
1982
  * @since v8.1.0
2007
1983
  */
2008
- export function useSliceIds(
1984
+ export function createSliceIds(
2009
1985
  indexId: MaybeGetter<Id>,
2010
1986
  indexesOrIndexesId?: MaybeGetter<IndexesOrIndexesId | undefined>,
2011
1987
  ): {readonly current: Ids};
2012
1988
 
2013
1989
  /**
2014
- * The useSliceRowIds hook returns a reactive object reflecting the Ids of the
2015
- * Rows in a Slice, and registers a listener so that any changes will update
2016
- * `.current`.
1990
+ * The createSliceRowIds function returns a reactive object reflecting the Ids
1991
+ * of the Rows in a Slice, and registers a listener so that any changes will
1992
+ * update `.current`.
2017
1993
  * @param indexId The Id of the Index (or a getter returning it).
2018
1994
  * @param sliceId The Id of the Slice (or a getter returning it).
2019
1995
  * @param indexesOrIndexesId The Indexes object to use (plain or getter), or its
2020
1996
  * Id.
2021
1997
  * @returns A reactive object with a `current` Ids property.
2022
- * @category Hook
1998
+ * @category Getter
2023
1999
  * @since v8.1.0
2024
2000
  */
2025
- export function useSliceRowIds(
2001
+ export function createSliceRowIds(
2026
2002
  indexId: MaybeGetter<Id>,
2027
2003
  sliceId: MaybeGetter<Id>,
2028
2004
  indexesOrIndexesId?: MaybeGetter<IndexesOrIndexesId | undefined>,
2029
2005
  ): {readonly current: Ids};
2030
2006
 
2031
2007
  /**
2032
- * The useQueries hook returns the default Queries object from the current
2008
+ * The getQueries function returns the default Queries object from the current
2033
2009
  * Provider context (or a named one if an Id is provided).
2034
2010
  * @param id An optional Id of a named Queries object in the Provider context.
2035
2011
  * @returns The Queries object, or `undefined` if not found.
2036
- * @category Hook
2012
+ * @category Getter
2037
2013
  * @since v8.1.0
2038
2014
  */
2039
- export function useQueries(id?: Id): Queries | undefined;
2015
+ export function getQueries(id?: Id): Queries | undefined;
2040
2016
 
2041
2017
  /**
2042
- * The useQueriesOrQueriesById hook is used to get a reference to a Queries
2043
- * object from a Provider context, or have it passed directly.
2018
+ * The resolveQueries function is used to get a reference to a Queries object
2019
+ * from a Provider context, or have it passed directly.
2044
2020
  * @param queriesOrQueriesId The Queries object, its Id, or a getter returning
2045
2021
  * either.
2046
2022
  * @returns A getter function returning the Queries object, or `undefined`.
2047
- * @category Hook
2023
+ * @category Getter
2048
2024
  * @since v8.1.0
2049
2025
  */
2050
- export function useQueriesOrQueriesById(
2026
+ export function resolveQueries(
2051
2027
  queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
2052
2028
  ): () => Queries | undefined;
2053
2029
 
2054
2030
  /**
2055
- * The useQueriesIds hook returns a reactive object with the Ids of all Queries
2056
- * objects registered in the current Provider context.
2031
+ * The createQueriesIds function returns a reactive object with the Ids of all
2032
+ * Queries objects registered in the current Provider context.
2057
2033
  * @returns A reactive object with a `current` Ids property.
2058
- * @category Hook
2034
+ * @category Getter
2059
2035
  * @since v8.1.0
2060
2036
  */
2061
- export function useQueriesIds(): {readonly current: Ids};
2037
+ export function createQueriesIds(): {readonly current: Ids};
2062
2038
 
2063
2039
  /**
2064
- * The useQueryIds hook returns a reactive object reflecting the Ids of the
2065
- * Queries in a Queries object, and registers a listener so that any changes
2040
+ * The createQueryIds function returns a reactive object reflecting the Ids of
2041
+ * the Queries in a Queries object, and registers a listener so that any changes
2066
2042
  * will update `.current`.
2067
2043
  * @param queriesOrQueriesId The Queries object to use, or its Id.
2068
2044
  * @returns A reactive object with a `current` Ids property.
2069
- * @category Hook
2045
+ * @category Getter
2070
2046
  * @since v8.1.0
2071
2047
  */
2072
- export function useQueryIds(
2048
+ export function createQueryIds(
2073
2049
  queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
2074
2050
  ): {
2075
2051
  readonly current: Ids;
2076
2052
  };
2077
2053
 
2078
2054
  /**
2079
- * The useResultTable hook returns a reactive object reflecting a result Table
2080
- * in a Queries object, and registers a listener so that any changes to that
2081
- * result will update `.current`.
2055
+ * The createResultTable function returns a reactive object reflecting a result
2056
+ * Table in a Queries object, and registers a listener so that any changes to
2057
+ * that result will update `.current`.
2082
2058
  * @param queryId The Id of the Query (or a getter returning it).
2083
2059
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2084
2060
  * Id.
2085
2061
  * @returns A reactive object with a `current` Table property.
2086
- * @category Hook
2062
+ * @category Getter
2087
2063
  * @since v8.1.0
2088
2064
  */
2089
- export function useResultTable(
2065
+ export function createResultTable(
2090
2066
  queryId: MaybeGetter<Id>,
2091
2067
  queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
2092
2068
  ): {readonly current: Table};
2093
2069
 
2094
2070
  /**
2095
- * The useResultTableCellIds hook returns a reactive object reflecting the Ids
2096
- * of all Cells used across a result Table, and registers a listener so that any
2097
- * changes will update `.current`.
2071
+ * The createResultTableCellIds function returns a reactive object reflecting
2072
+ * the Ids of all Cells used across a result Table, and registers a listener so
2073
+ * that any changes will update `.current`.
2098
2074
  * @param queryId The Id of the Query (or a getter returning it).
2099
2075
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2100
2076
  * Id.
2101
2077
  * @returns A reactive object with a `current` Ids property.
2102
- * @category Hook
2078
+ * @category Getter
2103
2079
  * @since v8.1.0
2104
2080
  */
2105
- export function useResultTableCellIds(
2081
+ export function createResultTableCellIds(
2106
2082
  queryId: MaybeGetter<Id>,
2107
2083
  queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
2108
2084
  ): {readonly current: Ids};
2109
2085
 
2110
2086
  /**
2111
- * The useResultRowCount hook returns a reactive object reflecting the number of
2112
- * Rows in a result Table, and registers a listener so that any changes will
2113
- * update `.current`.
2087
+ * The createResultRowCount function returns a reactive object reflecting the
2088
+ * number of Rows in a result Table, and registers a listener so that any
2089
+ * changes will update `.current`.
2114
2090
  * @param queryId The Id of the Query (or a getter returning it).
2115
2091
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2116
2092
  * Id.
2117
2093
  * @returns A reactive object with a `current` number property.
2118
- * @category Hook
2094
+ * @category Getter
2119
2095
  * @since v8.1.0
2120
2096
  */
2121
- export function useResultRowCount(
2097
+ export function createResultRowCount(
2122
2098
  queryId: MaybeGetter<Id>,
2123
2099
  queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
2124
2100
  ): {readonly current: number};
2125
2101
 
2126
2102
  /**
2127
- * The useResultRowIds hook returns a reactive object reflecting the Ids of the
2128
- * Rows in a result Table, and registers a listener so that any changes will
2129
- * update `.current`.
2103
+ * The createResultRowIds function returns a reactive object reflecting the Ids
2104
+ * of the Rows in a result Table, and registers a listener so that any changes
2105
+ * will update `.current`.
2130
2106
  * @param queryId The Id of the Query (or a getter returning it).
2131
2107
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2132
2108
  * Id.
2133
2109
  * @returns A reactive object with a `current` Ids property.
2134
- * @category Hook
2110
+ * @category Getter
2135
2111
  * @since v8.1.0
2136
2112
  */
2137
- export function useResultRowIds(
2113
+ export function createResultRowIds(
2138
2114
  queryId: MaybeGetter<Id>,
2139
2115
  queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
2140
2116
  ): {readonly current: Ids};
2141
2117
 
2142
2118
  /**
2143
- * The useResultSortedRowIds hook returns a reactive object reflecting the
2144
- * sorted Row Ids in a result Table, and registers a listener so that any
2119
+ * The createResultSortedRowIds function returns a reactive object reflecting
2120
+ * the sorted Row Ids in a result Table, and registers a listener so that any
2145
2121
  * changes will update `.current`.
2146
2122
  * @param queryId The Id of the Query (or a getter returning it).
2147
2123
  * @param cellId The Id of the Cell to sort by (or a getter returning it).
@@ -2151,10 +2127,10 @@ export function useResultRowIds(
2151
2127
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2152
2128
  * Id.
2153
2129
  * @returns A reactive object with a `current` Ids property.
2154
- * @category Hook
2130
+ * @category Getter
2155
2131
  * @since v8.1.0
2156
2132
  */
2157
- export function useResultSortedRowIds(
2133
+ export function createResultSortedRowIds(
2158
2134
  queryId: MaybeGetter<Id>,
2159
2135
  cellId?: MaybeGetter<Id | undefined>,
2160
2136
  descending?: MaybeGetter<boolean>,
@@ -2164,44 +2140,44 @@ export function useResultSortedRowIds(
2164
2140
  ): {readonly current: Ids};
2165
2141
 
2166
2142
  /**
2167
- * The useResultRow hook returns a reactive object reflecting a result Row in a
2168
- * result Table, and registers a listener so that any changes will update
2169
- * `.current`.
2143
+ * The createResultRow function returns a reactive object reflecting a result
2144
+ * Row in a result Table, and registers a listener so that any changes will
2145
+ * update `.current`.
2170
2146
  * @param queryId The Id of the Query (or a getter returning it).
2171
2147
  * @param rowId The Id of the Row (or a getter returning it).
2172
2148
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2173
2149
  * Id.
2174
2150
  * @returns A reactive object with a `current` Row property.
2175
- * @category Hook
2151
+ * @category Getter
2176
2152
  * @since v8.1.0
2177
2153
  */
2178
- export function useResultRow(
2154
+ export function createResultRow(
2179
2155
  queryId: MaybeGetter<Id>,
2180
2156
  rowId: MaybeGetter<Id>,
2181
2157
  queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
2182
2158
  ): {readonly current: Row};
2183
2159
 
2184
2160
  /**
2185
- * The useResultCellIds hook returns a reactive object reflecting the Ids of the
2186
- * Cells in a result Row, and registers a listener so that any changes will
2187
- * update `.current`.
2161
+ * The createResultCellIds function returns a reactive object reflecting the Ids
2162
+ * of the Cells in a result Row, and registers a listener so that any changes
2163
+ * will update `.current`.
2188
2164
  * @param queryId The Id of the Query (or a getter returning it).
2189
2165
  * @param rowId The Id of the Row (or a getter returning it).
2190
2166
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2191
2167
  * Id.
2192
2168
  * @returns A reactive object with a `current` Ids property.
2193
- * @category Hook
2169
+ * @category Getter
2194
2170
  * @since v8.1.0
2195
2171
  */
2196
- export function useResultCellIds(
2172
+ export function createResultCellIds(
2197
2173
  queryId: MaybeGetter<Id>,
2198
2174
  rowId: MaybeGetter<Id>,
2199
2175
  queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
2200
2176
  ): {readonly current: Ids};
2201
2177
 
2202
2178
  /**
2203
- * The useResultCell hook returns a reactive object reflecting the value of a
2204
- * Cell in a result Row, and registers a listener so that any changes will
2179
+ * The createResultCell function returns a reactive object reflecting the value
2180
+ * of a Cell in a result Row, and registers a listener so that any changes will
2205
2181
  * update `.current`.
2206
2182
  * @param queryId The Id of the Query (or a getter returning it).
2207
2183
  * @param rowId The Id of the Row (or a getter returning it).
@@ -2209,10 +2185,10 @@ export function useResultCellIds(
2209
2185
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2210
2186
  * Id.
2211
2187
  * @returns A reactive object with a `current` Cell | undefined property.
2212
- * @category Hook
2188
+ * @category Getter
2213
2189
  * @since v8.1.0
2214
2190
  */
2215
- export function useResultCell(
2191
+ export function createResultCell(
2216
2192
  queryId: MaybeGetter<Id>,
2217
2193
  rowId: MaybeGetter<Id>,
2218
2194
  cellId: MaybeGetter<Id>,
@@ -2220,44 +2196,44 @@ export function useResultCell(
2220
2196
  ): {readonly current: CellOrUndefined};
2221
2197
 
2222
2198
  /**
2223
- * The useRelationships hook returns the default Relationships object from the
2224
- * current Provider context (or a named one if an Id is provided).
2199
+ * The getRelationships function returns the default Relationships object from
2200
+ * the current Provider context (or a named one if an Id is provided).
2225
2201
  * @param id An optional Id of a named Relationships object in the Provider
2226
2202
  * context.
2227
2203
  * @returns The Relationships object, or `undefined` if not found.
2228
- * @category Hook
2204
+ * @category Getter
2229
2205
  * @since v8.1.0
2230
2206
  */
2231
- export function useRelationships(id?: Id): Relationships | undefined;
2207
+ export function getRelationships(id?: Id): Relationships | undefined;
2232
2208
 
2233
2209
  /**
2234
- * The useRelationshipsOrRelationshipsById hook is used to get a reference to a
2210
+ * The resolveRelationships function is used to get a reference to a
2235
2211
  * Relationships object from a Provider context, or have it passed directly.
2236
2212
  * @param relationshipsOrRelationshipsId The Relationships object, its Id, or a
2237
2213
  * getter returning either.
2238
2214
  * @returns A getter function returning the Relationships object, or
2239
2215
  * `undefined`.
2240
- * @category Hook
2216
+ * @category Getter
2241
2217
  * @since v8.1.0
2242
2218
  */
2243
- export function useRelationshipsOrRelationshipsById(
2219
+ export function resolveRelationships(
2244
2220
  relationshipsOrRelationshipsId?: MaybeGetter<
2245
2221
  RelationshipsOrRelationshipsId | undefined
2246
2222
  >,
2247
2223
  ): () => Relationships | undefined;
2248
2224
 
2249
2225
  /**
2250
- * The useRelationshipsStoreTableIds hook returns the Store, local table Id, and
2251
- * remote table Id for a given Relationships object and relationship Id.
2226
+ * The getRelationshipsStoreTableIds function returns the Store, local table Id,
2227
+ * and remote table Id for a given Relationships object and relationship Id.
2252
2228
  * @param relationshipsOrId The Relationships object, its Id, or a getter
2253
2229
  * returning either.
2254
2230
  * @param relationshipId The Id of the relationship, or a getter returning it.
2255
2231
  * @returns An object with `store`, `localTableId`, and `remoteTableId` getter
2256
2232
  * properties.
2257
- * @category Hook
2233
+ * @category Getter
2258
2234
  * @since v8.1.0
2259
2235
  */
2260
- export function useRelationshipsStoreTableIds(
2236
+ export function getRelationshipsStoreTableIds(
2261
2237
  relationshipsOrId: MaybeGetter<RelationshipsOrRelationshipsId | undefined>,
2262
2238
  relationshipId: MaybeGetter<Id>,
2263
2239
  ): {
@@ -2267,43 +2243,43 @@ export function useRelationshipsStoreTableIds(
2267
2243
  };
2268
2244
 
2269
2245
  /**
2270
- * The useRelationshipsIds hook returns a reactive object with the Ids of all
2271
- * Relationships objects registered in the current Provider context.
2246
+ * The createRelationshipsIds function returns a reactive object with the Ids of
2247
+ * all Relationships objects registered in the current Provider context.
2272
2248
  * @returns A reactive object with a `current` Ids property.
2273
- * @category Hook
2249
+ * @category Getter
2274
2250
  * @since v8.1.0
2275
2251
  */
2276
- export function useRelationshipsIds(): {readonly current: Ids};
2252
+ export function createRelationshipsIds(): {readonly current: Ids};
2277
2253
 
2278
2254
  /**
2279
- * The useRelationshipIds hook returns a reactive object reflecting the Ids of
2280
- * the Relationships in a Relationships object, and registers a listener so that
2281
- * any changes will update `.current`.
2255
+ * The createRelationshipIds function returns a reactive object reflecting the
2256
+ * Ids of the Relationships in a Relationships object, and registers a listener
2257
+ * so that any changes will update `.current`.
2282
2258
  * @param relationshipsOrRelationshipsId The Relationships object to use, or its
2283
2259
  * Id.
2284
2260
  * @returns A reactive object with a `current` Ids property.
2285
- * @category Hook
2261
+ * @category Getter
2286
2262
  * @since v8.1.0
2287
2263
  */
2288
- export function useRelationshipIds(
2264
+ export function createRelationshipIds(
2289
2265
  relationshipsOrRelationshipsId?: MaybeGetter<
2290
2266
  RelationshipsOrRelationshipsId | undefined
2291
2267
  >,
2292
2268
  ): {readonly current: Ids};
2293
2269
 
2294
2270
  /**
2295
- * The useRemoteRowId hook returns a reactive object reflecting the remote Row
2296
- * Id for a given local Row in a Relationship, and registers a listener so that
2297
- * any changes will update `.current`.
2271
+ * The createRemoteRowId function returns a reactive object reflecting the
2272
+ * remote Row Id for a given local Row in a Relationship, and registers a
2273
+ * listener so that any changes will update `.current`.
2298
2274
  * @param relationshipId The Id of the Relationship (or a getter returning it).
2299
2275
  * @param localRowId The Id of the local Row (or a getter returning it).
2300
2276
  * @param relationshipsOrRelationshipsId The Relationships object to use (plain
2301
2277
  * or getter), or its Id.
2302
2278
  * @returns A reactive object with a `current` Id | undefined property.
2303
- * @category Hook
2279
+ * @category Getter
2304
2280
  * @since v8.1.0
2305
2281
  */
2306
- export function useRemoteRowId(
2282
+ export function createRemoteRowId(
2307
2283
  relationshipId: MaybeGetter<Id>,
2308
2284
  localRowId: MaybeGetter<Id>,
2309
2285
  relationshipsOrRelationshipsId?: MaybeGetter<
@@ -2312,18 +2288,18 @@ export function useRemoteRowId(
2312
2288
  ): {readonly current: Id | undefined};
2313
2289
 
2314
2290
  /**
2315
- * The useLocalRowIds hook returns a reactive object reflecting the local Row
2316
- * Ids for a given remote Row in a Relationship, and registers a listener so
2291
+ * The createLocalRowIds function returns a reactive object reflecting the local
2292
+ * Row Ids for a given remote Row in a Relationship, and registers a listener so
2317
2293
  * that any changes will update `.current`.
2318
2294
  * @param relationshipId The Id of the Relationship (or a getter returning it).
2319
2295
  * @param remoteRowId The Id of the remote Row (or a getter returning it).
2320
2296
  * @param relationshipsOrRelationshipsId The Relationships object to use (plain
2321
2297
  * or getter), or its Id.
2322
2298
  * @returns A reactive object with a `current` Ids property.
2323
- * @category Hook
2299
+ * @category Getter
2324
2300
  * @since v8.1.0
2325
2301
  */
2326
- export function useLocalRowIds(
2302
+ export function createLocalRowIds(
2327
2303
  relationshipId: MaybeGetter<Id>,
2328
2304
  remoteRowId: MaybeGetter<Id>,
2329
2305
  relationshipsOrRelationshipsId?: MaybeGetter<
@@ -2332,18 +2308,18 @@ export function useLocalRowIds(
2332
2308
  ): {readonly current: Ids};
2333
2309
 
2334
2310
  /**
2335
- * The useLinkedRowIds hook returns a reactive object reflecting the linked Row
2336
- * Ids in a Relationship, and registers a listener so that any changes will
2337
- * update `.current`.
2311
+ * The createLinkedRowIds function returns a reactive object reflecting the
2312
+ * linked Row Ids in a Relationship, and registers a listener so that any
2313
+ * changes will update `.current`.
2338
2314
  * @param relationshipId The Id of the Relationship (or a getter returning it).
2339
2315
  * @param firstRowId The Id of the first Row (or a getter returning it).
2340
2316
  * @param relationshipsOrRelationshipsId The Relationships object to use (plain
2341
2317
  * or getter), or its Id.
2342
2318
  * @returns A reactive object with a `current` Ids property.
2343
- * @category Hook
2319
+ * @category Getter
2344
2320
  * @since v8.1.0
2345
2321
  */
2346
- export function useLinkedRowIds(
2322
+ export function createLinkedRowIds(
2347
2323
  relationshipId: MaybeGetter<Id>,
2348
2324
  firstRowId: MaybeGetter<Id>,
2349
2325
  relationshipsOrRelationshipsId?: MaybeGetter<
@@ -2352,68 +2328,68 @@ export function useLinkedRowIds(
2352
2328
  ): {readonly current: Ids};
2353
2329
 
2354
2330
  /**
2355
- * The useCheckpoints hook returns the default Checkpoints object from the
2331
+ * The getCheckpoints function returns the default Checkpoints object from the
2356
2332
  * current Provider context (or a named one if an Id is provided).
2357
2333
  * @param id An optional Id of a named Checkpoints object in the Provider
2358
2334
  * context.
2359
2335
  * @returns The Checkpoints object, or `undefined` if not found.
2360
- * @category Hook
2336
+ * @category Getter
2361
2337
  * @since v8.1.0
2362
2338
  */
2363
- export function useCheckpoints(id?: Id): Checkpoints | undefined;
2339
+ export function getCheckpoints(id?: Id): Checkpoints | undefined;
2364
2340
 
2365
2341
  /**
2366
- * The useCheckpointsOrCheckpointsById hook is used to get a reference to a
2367
- * Checkpoints object from a Provider context, or have it passed directly.
2342
+ * The resolveCheckpoints function is used to get a reference to a Checkpoints
2343
+ * object from a Provider context, or have it passed directly.
2368
2344
  * @param checkpointsOrCheckpointsId The Checkpoints object, its Id, or a getter
2369
2345
  * returning either.
2370
2346
  * @returns A getter function returning the Checkpoints object, or `undefined`.
2371
- * @category Hook
2347
+ * @category Getter
2372
2348
  * @since v8.1.0
2373
2349
  */
2374
- export function useCheckpointsOrCheckpointsById(
2350
+ export function resolveCheckpoints(
2375
2351
  checkpointsOrCheckpointsId?: MaybeGetter<
2376
2352
  CheckpointsOrCheckpointsId | undefined
2377
2353
  >,
2378
2354
  ): () => Checkpoints | undefined;
2379
2355
 
2380
2356
  /**
2381
- * The useCheckpointsIds hook returns a reactive object with the Ids of all
2382
- * Checkpoints objects registered in the current Provider context.
2357
+ * The createCheckpointsIds function returns a reactive object with the Ids of
2358
+ * all Checkpoints objects registered in the current Provider context.
2383
2359
  * @returns A reactive object with a `current` Ids property.
2384
- * @category Hook
2360
+ * @category Getter
2385
2361
  * @since v8.1.0
2386
2362
  */
2387
- export function useCheckpointsIds(): {readonly current: Ids};
2363
+ export function createCheckpointsIds(): {readonly current: Ids};
2388
2364
 
2389
2365
  /**
2390
- * The useCheckpointIds hook returns a reactive object reflecting the
2366
+ * The createCheckpointIds function returns a reactive object reflecting the
2391
2367
  * CheckpointIds (backward, current, forward) in a Checkpoints object, and
2392
2368
  * registers a listener so that any changes will update `.current`.
2393
2369
  * @param checkpointsOrCheckpointsId The Checkpoints object to use (plain or
2394
2370
  * getter), or its Id.
2395
2371
  * @returns A reactive object with a `current` CheckpointIds property.
2396
- * @category Hook
2372
+ * @category Getter
2397
2373
  * @since v8.1.0
2398
2374
  */
2399
- export function useCheckpointIds(
2375
+ export function createCheckpointIds(
2400
2376
  checkpointsOrCheckpointsId?: MaybeGetter<
2401
2377
  CheckpointsOrCheckpointsId | undefined
2402
2378
  >,
2403
2379
  ): {readonly current: CheckpointIds};
2404
2380
 
2405
2381
  /**
2406
- * The useCheckpoint hook returns a reactive object reflecting the label of a
2407
- * checkpoint, and registers a listener so that any changes will update
2408
- * `.current`.
2382
+ * The createCheckpoint function returns a reactive object reflecting the label
2383
+ * of a checkpoint, and registers a listener so that any changes will
2384
+ * update `.current`.
2409
2385
  * @param checkpointId The Id of the checkpoint (or a getter returning it).
2410
2386
  * @param checkpointsOrCheckpointsId The Checkpoints object to use (plain or
2411
2387
  * getter), or its Id.
2412
2388
  * @returns A reactive object with a `current` string | undefined property.
2413
- * @category Hook
2389
+ * @category Getter
2414
2390
  * @since v8.1.0
2415
2391
  */
2416
- export function useCheckpoint(
2392
+ export function createCheckpoint(
2417
2393
  checkpointId: MaybeGetter<Id>,
2418
2394
  checkpointsOrCheckpointsId?: MaybeGetter<
2419
2395
  CheckpointsOrCheckpointsId | undefined
@@ -2421,179 +2397,178 @@ export function useCheckpoint(
2421
2397
  ): {readonly current: string | undefined};
2422
2398
 
2423
2399
  /**
2424
- * The useGoBackwardCallback hook returns a callback function that, when called,
2425
- * moves the Checkpoints object backward to the previous checkpoint.
2400
+ * The createGoBackwardCallback function returns a callback function that, when
2401
+ * called, moves the Checkpoints object backward to the previous checkpoint.
2426
2402
  * @param checkpointsOrCheckpointsId The Checkpoints object to use, or its Id.
2427
2403
  * @returns A callback function.
2428
- * @category Hook
2404
+ * @category Callback
2429
2405
  * @since v8.1.0
2430
2406
  */
2431
- export function useGoBackwardCallback(
2407
+ export function createGoBackwardCallback(
2432
2408
  checkpointsOrCheckpointsId?: MaybeGetter<
2433
2409
  CheckpointsOrCheckpointsId | undefined
2434
2410
  >,
2435
2411
  ): () => void;
2436
2412
 
2437
2413
  /**
2438
- * The useGoForwardCallback hook returns a callback function that, when called,
2439
- * moves the Checkpoints object forward to the next checkpoint.
2414
+ * The createGoForwardCallback function returns a callback function that, when
2415
+ * called, moves the Checkpoints object forward to the next checkpoint.
2440
2416
  * @param checkpointsOrCheckpointsId The Checkpoints object to use, or its Id.
2441
2417
  * @returns A callback function.
2442
- * @category Hook
2418
+ * @category Callback
2443
2419
  * @since v8.1.0
2444
2420
  */
2445
- export function useGoForwardCallback(
2421
+ export function createGoForwardCallback(
2446
2422
  checkpointsOrCheckpointsId?: MaybeGetter<
2447
2423
  CheckpointsOrCheckpointsId | undefined
2448
2424
  >,
2449
2425
  ): () => void;
2450
2426
 
2451
2427
  /**
2452
- * The usePersister hook returns the default Persister from the current Provider
2453
- * context (or a named one if an Id is provided).
2428
+ * The getPersister function returns the default Persister from the current
2429
+ * Provider context (or a named one if an Id is provided).
2454
2430
  * @param id An optional Id of a named Persister in the Provider context.
2455
2431
  * @returns The Persister, or `undefined` if not found.
2456
- * @category Hook
2432
+ * @category Getter
2457
2433
  * @since v8.1.0
2458
2434
  */
2459
- export function usePersister(id?: Id): AnyPersister | undefined;
2435
+ export function getPersister(id?: Id): AnyPersister | undefined;
2460
2436
 
2461
2437
  /**
2462
- * The usePersisterOrPersisterById hook is used to get a reference to a
2463
- * Persister object from a Provider context, or have it passed directly.
2438
+ * The resolvePersister function is used to get a reference to a Persister
2439
+ * object from a Provider context, or have it passed directly.
2464
2440
  * @param persisterOrPersisterId The Persister object, its Id, or a getter
2465
2441
  * returning either.
2466
2442
  * @returns A getter function returning the Persister object, or `undefined`.
2467
- * @category Hook
2443
+ * @category Getter
2468
2444
  * @since v8.1.0
2469
2445
  */
2470
- export function usePersisterOrPersisterById(
2446
+ export function resolvePersister(
2471
2447
  persisterOrPersisterId?: MaybeGetter<PersisterOrPersisterId | undefined>,
2472
2448
  ): () => AnyPersister | undefined;
2473
2449
 
2474
2450
  /**
2475
- * The usePersisterIds hook returns a reactive object with the Ids of all
2451
+ * The createPersisterIds function returns a reactive object with the Ids of all
2476
2452
  * Persisters registered in the current Provider context.
2477
2453
  * @returns A reactive object with a `current` Ids property.
2478
- * @category Hook
2454
+ * @category Getter
2479
2455
  * @since v8.1.0
2480
2456
  */
2481
- export function usePersisterIds(): {readonly current: Ids};
2457
+ export function createPersisterIds(): {readonly current: Ids};
2482
2458
 
2483
2459
  /**
2484
- * The usePersisterStatus hook returns a reactive object reflecting the status
2485
- * of a Persister, and registers a listener so that any changes will update
2486
- * `.current`.
2460
+ * The createPersisterStatus function returns a reactive object reflecting the
2461
+ * status of a Persister, and registers a listener so that any changes will
2462
+ * update `.current`.
2487
2463
  * @param persisterOrPersisterId The Persister to use, or its Id.
2488
2464
  * @returns A reactive object with a `current` Status property.
2489
- * @category Hook
2465
+ * @category Getter
2490
2466
  * @since v8.1.0
2491
2467
  */
2492
- export function usePersisterStatus(
2468
+ export function createPersisterStatus(
2493
2469
  persisterOrPersisterId?: MaybeGetter<PersisterOrPersisterId | undefined>,
2494
2470
  ): {readonly current: Status};
2495
2471
 
2496
2472
  /**
2497
- * The useSynchronizer hook returns the default Synchronizer from the current
2498
- * Provider context (or a named one if an Id is provided).
2473
+ * The getSynchronizer function returns the default Synchronizer from the
2474
+ * current Provider context (or a named one if an Id is provided).
2499
2475
  * @param id An optional Id of a named Synchronizer in the Provider context.
2500
2476
  * @returns The Synchronizer, or `undefined` if not found.
2501
- * @category Hook
2477
+ * @category Getter
2502
2478
  * @since v8.1.0
2503
2479
  */
2504
- export function useSynchronizer(id?: Id): Synchronizer | undefined;
2480
+ export function getSynchronizer(id?: Id): Synchronizer | undefined;
2505
2481
 
2506
2482
  /**
2507
- * The useSynchronizerOrSynchronizerById hook is used to get a reference to a
2508
- * Synchronizer object from a Provider context, or have it passed directly.
2483
+ * The resolveSynchronizer function is used to get a reference to a Synchronizer
2484
+ * object from a Provider context, or have it passed directly.
2509
2485
  * @param synchronizerOrSynchronizerId The Synchronizer object, its Id, or a
2510
2486
  * getter returning either.
2511
2487
  * @returns A getter function returning the Synchronizer object, or `undefined`.
2512
- * @category Hook
2488
+ * @category Getter
2513
2489
  * @since v8.1.0
2514
2490
  */
2515
- export function useSynchronizerOrSynchronizerById(
2491
+ export function resolveSynchronizer(
2516
2492
  synchronizerOrSynchronizerId?: MaybeGetter<
2517
2493
  SynchronizerOrSynchronizerId | undefined
2518
2494
  >,
2519
2495
  ): () => Synchronizer | undefined;
2520
2496
 
2521
2497
  /**
2522
- * The useSynchronizerIds hook returns a reactive object with the Ids of all
2523
- * Synchronizers registered in the current Provider context.
2498
+ * The createSynchronizerIds function returns a reactive object with the Ids of
2499
+ * all Synchronizers registered in the current Provider context.
2524
2500
  * @returns A reactive object with a `current` Ids property.
2525
- * @category Hook
2501
+ * @category Getter
2526
2502
  * @since v8.1.0
2527
2503
  */
2528
- export function useSynchronizerIds(): {readonly current: Ids};
2504
+ export function createSynchronizerIds(): {readonly current: Ids};
2529
2505
 
2530
2506
  /**
2531
- * The useSynchronizerStatus hook returns a reactive object reflecting the
2532
- * status of a Synchronizer, and registers a listener so that any changes will
2533
- * update `.current`.
2507
+ * The createSynchronizerStatus function returns a reactive object reflecting
2508
+ * the status of a Synchronizer, and registers a listener so that any changes
2509
+ * will update `.current`.
2534
2510
  * @param synchronizerOrSynchronizerId The Synchronizer to use, or its Id.
2535
2511
  * @returns A reactive object with a `current` Status property.
2536
- * @category Hook
2512
+ * @category Getter
2537
2513
  * @since v8.1.0
2538
2514
  */
2539
- export function useSynchronizerStatus(
2515
+ export function createSynchronizerStatus(
2540
2516
  synchronizerOrSynchronizerId?: MaybeGetter<
2541
2517
  SynchronizerOrSynchronizerId | undefined
2542
2518
  >,
2543
2519
  ): {readonly current: Status};
2544
2520
 
2545
2521
  /**
2546
- * The useHasTablesListener hook registers a listener that is called whenever
2547
- * any Tables are added to or removed from the Store. The listener is tied to
2548
- * the component's `$effect` lifecycle and is removed when the component
2549
- * unmounts.
2522
+ * The onHasTables function registers a listener that is called whenever any
2523
+ * Tables are added to or removed from the Store. The listener is tied to the
2524
+ * component's `$effect` lifecycle and is removed when the component unmounts.
2550
2525
  * @param listener The function to call when table presence changes.
2551
2526
  * @param mutator An optional boolean indicating the listener mutates Store
2552
2527
  * data.
2553
2528
  * @param storeOrStoreId The Store to use, or its Id.
2554
- * @category Hook
2529
+ * @category Listener
2555
2530
  * @since v8.1.0
2556
2531
  */
2557
- export function useHasTablesListener(
2532
+ export function onHasTables(
2558
2533
  listener: HasTablesListener,
2559
2534
  mutator?: boolean,
2560
2535
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
2561
2536
  ): void;
2562
2537
 
2563
2538
  /**
2564
- * The useTablesListener hook registers a listener that is called whenever
2565
- * tabular data in the Store changes.
2539
+ * The onTables function registers a listener that is called whenever tabular
2540
+ * data in the Store changes.
2566
2541
  * @param listener The function to call when Tables change.
2567
2542
  * @param mutator An optional boolean indicating the listener mutates Store
2568
2543
  * data.
2569
2544
  * @param storeOrStoreId The Store to use, or its Id.
2570
- * @category Hook
2545
+ * @category Listener
2571
2546
  * @since v8.1.0
2572
2547
  */
2573
- export function useTablesListener(
2548
+ export function onTables(
2574
2549
  listener: TablesListener,
2575
2550
  mutator?: boolean,
2576
2551
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
2577
2552
  ): void;
2578
2553
 
2579
2554
  /**
2580
- * The useTableIdsListener hook registers a listener that is called whenever the
2581
- * set of Table Ids in the Store changes.
2555
+ * The onTableIds function registers a listener that is called whenever the set
2556
+ * of Table Ids in the Store changes.
2582
2557
  * @param listener The function to call when Table Ids change.
2583
2558
  * @param mutator An optional boolean indicating the listener mutates Store
2584
2559
  * data.
2585
2560
  * @param storeOrStoreId The Store to use, or its Id.
2586
- * @category Hook
2561
+ * @category Listener
2587
2562
  * @since v8.1.0
2588
2563
  */
2589
- export function useTableIdsListener(
2564
+ export function onTableIds(
2590
2565
  listener: TableIdsListener,
2591
2566
  mutator?: boolean,
2592
2567
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
2593
2568
  ): void;
2594
2569
 
2595
2570
  /**
2596
- * The useHasTableListener hook registers a listener that is called whenever a
2571
+ * The onHasTable function registers a listener that is called whenever a
2597
2572
  * specified Table is added to or removed from the Store.
2598
2573
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2599
2574
  * Table.
@@ -2601,10 +2576,10 @@ export function useTableIdsListener(
2601
2576
  * @param mutator An optional boolean indicating the listener mutates Store
2602
2577
  * data.
2603
2578
  * @param storeOrStoreId The Store to use, or its Id.
2604
- * @category Hook
2579
+ * @category Listener
2605
2580
  * @since v8.1.0
2606
2581
  */
2607
- export function useHasTableListener(
2582
+ export function onHasTable(
2608
2583
  tableId: MaybeGetter<IdOrNull>,
2609
2584
  listener: HasTableListener,
2610
2585
  mutator?: boolean,
@@ -2612,18 +2587,18 @@ export function useHasTableListener(
2612
2587
  ): void;
2613
2588
 
2614
2589
  /**
2615
- * The useTableListener hook registers a listener that is called whenever data
2616
- * in a specified Table changes.
2590
+ * The onTable function registers a listener that is called whenever data in a
2591
+ * specified Table changes.
2617
2592
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2618
2593
  * Table.
2619
2594
  * @param listener The function to call when the Table changes.
2620
2595
  * @param mutator An optional boolean indicating the listener mutates Store
2621
2596
  * data.
2622
2597
  * @param storeOrStoreId The Store to use, or its Id.
2623
- * @category Hook
2598
+ * @category Listener
2624
2599
  * @since v8.1.0
2625
2600
  */
2626
- export function useTableListener(
2601
+ export function onTable(
2627
2602
  tableId: MaybeGetter<IdOrNull>,
2628
2603
  listener: TableListener,
2629
2604
  mutator?: boolean,
@@ -2631,18 +2606,18 @@ export function useTableListener(
2631
2606
  ): void;
2632
2607
 
2633
2608
  /**
2634
- * The useTableCellIdsListener hook registers a listener that is called whenever
2635
- * the Cell Ids used across a Table change.
2609
+ * The onTableCellIds function registers a listener that is called whenever the
2610
+ * Cell Ids used across a Table change.
2636
2611
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2637
2612
  * Table.
2638
2613
  * @param listener The function to call when Cell Ids change.
2639
2614
  * @param mutator An optional boolean indicating the listener mutates Store
2640
2615
  * data.
2641
2616
  * @param storeOrStoreId The Store to use, or its Id.
2642
- * @category Hook
2617
+ * @category Listener
2643
2618
  * @since v8.1.0
2644
2619
  */
2645
- export function useTableCellIdsListener(
2620
+ export function onTableCellIds(
2646
2621
  tableId: MaybeGetter<IdOrNull>,
2647
2622
  listener: TableCellIdsListener,
2648
2623
  mutator?: boolean,
@@ -2650,8 +2625,8 @@ export function useTableCellIdsListener(
2650
2625
  ): void;
2651
2626
 
2652
2627
  /**
2653
- * The useHasTableCellListener hook registers a listener that is called whenever
2654
- * a specified Cell Id is added to or removed from across a Table.
2628
+ * The onHasTableCell function registers a listener that is called whenever a
2629
+ * specified Cell Id is added to or removed from across a Table.
2655
2630
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2656
2631
  * Table.
2657
2632
  * @param cellId The Id of the Cell to listen to, or `null` to listen to any
@@ -2660,10 +2635,10 @@ export function useTableCellIdsListener(
2660
2635
  * @param mutator An optional boolean indicating the listener mutates Store
2661
2636
  * data.
2662
2637
  * @param storeOrStoreId The Store to use, or its Id.
2663
- * @category Hook
2638
+ * @category Listener
2664
2639
  * @since v8.1.0
2665
2640
  */
2666
- export function useHasTableCellListener(
2641
+ export function onHasTableCell(
2667
2642
  tableId: MaybeGetter<IdOrNull>,
2668
2643
  cellId: MaybeGetter<IdOrNull>,
2669
2644
  listener: HasTableCellListener,
@@ -2672,7 +2647,7 @@ export function useHasTableCellListener(
2672
2647
  ): void;
2673
2648
 
2674
2649
  /**
2675
- * The useRowCountListener hook registers a listener that is called whenever the
2650
+ * The onRowCount function registers a listener that is called whenever the
2676
2651
  * count of Rows in a Table changes.
2677
2652
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2678
2653
  * Table.
@@ -2680,10 +2655,10 @@ export function useHasTableCellListener(
2680
2655
  * @param mutator An optional boolean indicating the listener mutates Store
2681
2656
  * data.
2682
2657
  * @param storeOrStoreId The Store to use, or its Id.
2683
- * @category Hook
2658
+ * @category Listener
2684
2659
  * @since v8.1.0
2685
2660
  */
2686
- export function useRowCountListener(
2661
+ export function onRowCount(
2687
2662
  tableId: MaybeGetter<IdOrNull>,
2688
2663
  listener: RowCountListener,
2689
2664
  mutator?: boolean,
@@ -2691,18 +2666,18 @@ export function useRowCountListener(
2691
2666
  ): void;
2692
2667
 
2693
2668
  /**
2694
- * The useRowIdsListener hook registers a listener that is called whenever the
2695
- * Row Ids in a Table change.
2669
+ * The onRowIds function registers a listener that is called whenever the Row
2670
+ * Ids in a Table change.
2696
2671
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2697
2672
  * Table.
2698
2673
  * @param listener The function to call when Row Ids change.
2699
2674
  * @param mutator An optional boolean indicating the listener mutates Store
2700
2675
  * data.
2701
2676
  * @param storeOrStoreId The Store to use, or its Id.
2702
- * @category Hook
2677
+ * @category Listener
2703
2678
  * @since v8.1.0
2704
2679
  */
2705
- export function useRowIdsListener(
2680
+ export function onRowIds(
2706
2681
  tableId: MaybeGetter<IdOrNull>,
2707
2682
  listener: RowIdsListener,
2708
2683
  mutator?: boolean,
@@ -2710,8 +2685,8 @@ export function useRowIdsListener(
2710
2685
  ): void;
2711
2686
 
2712
2687
  /**
2713
- * The useSortedRowIdsListener hook registers a listener that is called whenever
2714
- * the sorted Row Ids in a Table change.
2688
+ * The onSortedRowIds function registers a listener that is called whenever the
2689
+ * sorted Row Ids in a Table change.
2715
2690
  * @param tableId The Id of the Table to listen to.
2716
2691
  * @param cellId The Id of the Cell to sort by, or `undefined` for default
2717
2692
  * order.
@@ -2722,10 +2697,10 @@ export function useRowIdsListener(
2722
2697
  * @param mutator An optional boolean indicating the listener mutates Store
2723
2698
  * data.
2724
2699
  * @param storeOrStoreId The Store to use, or its Id.
2725
- * @category Hook
2700
+ * @category Listener
2726
2701
  * @since v8.1.0
2727
2702
  */
2728
- export function useSortedRowIdsListener(
2703
+ export function onSortedRowIds(
2729
2704
  tableId: MaybeGetter<Id>,
2730
2705
  cellId: MaybeGetter<Id | undefined>,
2731
2706
  descending: MaybeGetter<boolean>,
@@ -2737,7 +2712,7 @@ export function useSortedRowIdsListener(
2737
2712
  ): void;
2738
2713
 
2739
2714
  /**
2740
- * The useHasRowListener hook registers a listener that is called whenever a
2715
+ * The onHasRow function registers a listener that is called whenever a
2741
2716
  * specified Row is added to or removed from a Table.
2742
2717
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2743
2718
  * Table.
@@ -2746,10 +2721,10 @@ export function useSortedRowIdsListener(
2746
2721
  * @param mutator An optional boolean indicating the listener mutates Store
2747
2722
  * data.
2748
2723
  * @param storeOrStoreId The Store to use, or its Id.
2749
- * @category Hook
2724
+ * @category Listener
2750
2725
  * @since v8.1.0
2751
2726
  */
2752
- export function useHasRowListener(
2727
+ export function onHasRow(
2753
2728
  tableId: MaybeGetter<IdOrNull>,
2754
2729
  rowId: MaybeGetter<IdOrNull>,
2755
2730
  listener: HasRowListener,
@@ -2758,8 +2733,8 @@ export function useHasRowListener(
2758
2733
  ): void;
2759
2734
 
2760
2735
  /**
2761
- * The useRowListener hook registers a listener that is called whenever data in
2762
- * a specified Row changes.
2736
+ * The onRow function registers a listener that is called whenever data in a
2737
+ * specified Row changes.
2763
2738
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2764
2739
  * Table.
2765
2740
  * @param rowId The Id of the Row to listen to, or `null` to listen to any Row.
@@ -2767,10 +2742,10 @@ export function useHasRowListener(
2767
2742
  * @param mutator An optional boolean indicating the listener mutates Store
2768
2743
  * data.
2769
2744
  * @param storeOrStoreId The Store to use, or its Id.
2770
- * @category Hook
2745
+ * @category Listener
2771
2746
  * @since v8.1.0
2772
2747
  */
2773
- export function useRowListener(
2748
+ export function onRow(
2774
2749
  tableId: MaybeGetter<IdOrNull>,
2775
2750
  rowId: MaybeGetter<IdOrNull>,
2776
2751
  listener: RowListener,
@@ -2779,8 +2754,8 @@ export function useRowListener(
2779
2754
  ): void;
2780
2755
 
2781
2756
  /**
2782
- * The useCellIdsListener hook registers a listener that is called whenever the
2783
- * Cell Ids in a Row change.
2757
+ * The onCellIds function registers a listener that is called whenever the Cell
2758
+ * Ids in a Row change.
2784
2759
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2785
2760
  * Table.
2786
2761
  * @param rowId The Id of the Row to listen to, or `null` to listen to any Row.
@@ -2788,10 +2763,10 @@ export function useRowListener(
2788
2763
  * @param mutator An optional boolean indicating the listener mutates Store
2789
2764
  * data.
2790
2765
  * @param storeOrStoreId The Store to use, or its Id.
2791
- * @category Hook
2766
+ * @category Listener
2792
2767
  * @since v8.1.0
2793
2768
  */
2794
- export function useCellIdsListener(
2769
+ export function onCellIds(
2795
2770
  tableId: MaybeGetter<IdOrNull>,
2796
2771
  rowId: MaybeGetter<IdOrNull>,
2797
2772
  listener: CellIdsListener,
@@ -2800,7 +2775,7 @@ export function useCellIdsListener(
2800
2775
  ): void;
2801
2776
 
2802
2777
  /**
2803
- * The useHasCellListener hook registers a listener that is called whenever a
2778
+ * The onHasCell function registers a listener that is called whenever a
2804
2779
  * specified Cell is added to or removed from a Row.
2805
2780
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2806
2781
  * Table.
@@ -2811,10 +2786,10 @@ export function useCellIdsListener(
2811
2786
  * @param mutator An optional boolean indicating the listener mutates Store
2812
2787
  * data.
2813
2788
  * @param storeOrStoreId The Store to use, or its Id.
2814
- * @category Hook
2789
+ * @category Listener
2815
2790
  * @since v8.1.0
2816
2791
  */
2817
- export function useHasCellListener(
2792
+ export function onHasCell(
2818
2793
  tableId: MaybeGetter<IdOrNull>,
2819
2794
  rowId: MaybeGetter<IdOrNull>,
2820
2795
  cellId: MaybeGetter<IdOrNull>,
@@ -2824,8 +2799,8 @@ export function useHasCellListener(
2824
2799
  ): void;
2825
2800
 
2826
2801
  /**
2827
- * The useCellListener hook registers a listener that is called whenever the
2828
- * value of a specified Cell changes.
2802
+ * The onCell function registers a listener that is called whenever the value of
2803
+ * a specified Cell changes.
2829
2804
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2830
2805
  * Table.
2831
2806
  * @param rowId The Id of the Row to listen to, or `null` to listen to any Row.
@@ -2835,10 +2810,10 @@ export function useHasCellListener(
2835
2810
  * @param mutator An optional boolean indicating the listener mutates Store
2836
2811
  * data.
2837
2812
  * @param storeOrStoreId The Store to use, or its Id.
2838
- * @category Hook
2813
+ * @category Listener
2839
2814
  * @since v8.1.0
2840
2815
  */
2841
- export function useCellListener(
2816
+ export function onCell(
2842
2817
  tableId: MaybeGetter<IdOrNull>,
2843
2818
  rowId: MaybeGetter<IdOrNull>,
2844
2819
  cellId: MaybeGetter<IdOrNull>,
@@ -2848,55 +2823,55 @@ export function useCellListener(
2848
2823
  ): void;
2849
2824
 
2850
2825
  /**
2851
- * The useHasValuesListener hook registers a listener that is called whenever
2852
- * any Values are added to or removed from the Store.
2826
+ * The onHasValues function registers a listener that is called whenever any
2827
+ * Values are added to or removed from the Store.
2853
2828
  * @param listener The function to call when value presence changes.
2854
2829
  * @param mutator An optional boolean indicating the listener mutates Store
2855
2830
  * data.
2856
2831
  * @param storeOrStoreId The Store to use, or its Id.
2857
- * @category Hook
2832
+ * @category Listener
2858
2833
  * @since v8.1.0
2859
2834
  */
2860
- export function useHasValuesListener(
2835
+ export function onHasValues(
2861
2836
  listener: HasValuesListener,
2862
2837
  mutator?: boolean,
2863
2838
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
2864
2839
  ): void;
2865
2840
 
2866
2841
  /**
2867
- * The useValuesListener hook registers a listener that is called whenever any
2868
- * Values in the Store change.
2842
+ * The onValues function registers a listener that is called whenever any Values
2843
+ * in the Store change.
2869
2844
  * @param listener The function to call when Values change.
2870
2845
  * @param mutator An optional boolean indicating the listener mutates Store
2871
2846
  * data.
2872
2847
  * @param storeOrStoreId The Store to use, or its Id.
2873
- * @category Hook
2848
+ * @category Listener
2874
2849
  * @since v8.1.0
2875
2850
  */
2876
- export function useValuesListener(
2851
+ export function onValues(
2877
2852
  listener: ValuesListener,
2878
2853
  mutator?: boolean,
2879
2854
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
2880
2855
  ): void;
2881
2856
 
2882
2857
  /**
2883
- * The useValueIdsListener hook registers a listener that is called whenever the
2858
+ * The onValueIds function registers a listener that is called whenever the
2884
2859
  * Value Ids in the Store change.
2885
2860
  * @param listener The function to call when Value Ids change.
2886
2861
  * @param mutator An optional boolean indicating the listener mutates Store
2887
2862
  * data.
2888
2863
  * @param storeOrStoreId The Store to use, or its Id.
2889
- * @category Hook
2864
+ * @category Listener
2890
2865
  * @since v8.1.0
2891
2866
  */
2892
- export function useValueIdsListener(
2867
+ export function onValueIds(
2893
2868
  listener: ValueIdsListener,
2894
2869
  mutator?: boolean,
2895
2870
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
2896
2871
  ): void;
2897
2872
 
2898
2873
  /**
2899
- * The useHasValueListener hook registers a listener that is called whenever a
2874
+ * The onHasValue function registers a listener that is called whenever a
2900
2875
  * specified Value is added to or removed from the Store.
2901
2876
  * @param valueId The Id of the Value to listen to, or `null` to listen to any
2902
2877
  * Value.
@@ -2904,10 +2879,10 @@ export function useValueIdsListener(
2904
2879
  * @param mutator An optional boolean indicating the listener mutates Store
2905
2880
  * data.
2906
2881
  * @param storeOrStoreId The Store to use, or its Id.
2907
- * @category Hook
2882
+ * @category Listener
2908
2883
  * @since v8.1.0
2909
2884
  */
2910
- export function useHasValueListener(
2885
+ export function onHasValue(
2911
2886
  valueId: MaybeGetter<IdOrNull>,
2912
2887
  listener: HasValueListener,
2913
2888
  mutator?: boolean,
@@ -2915,18 +2890,18 @@ export function useHasValueListener(
2915
2890
  ): void;
2916
2891
 
2917
2892
  /**
2918
- * The useValueListener hook registers a listener that is called whenever the
2919
- * value of a specified Value changes.
2893
+ * The onValue function registers a listener that is called whenever the value
2894
+ * of a specified Value changes.
2920
2895
  * @param valueId The Id of the Value to listen to, or `null` to listen to any
2921
2896
  * Value.
2922
2897
  * @param listener The function to call when the Value changes.
2923
2898
  * @param mutator An optional boolean indicating the listener mutates Store
2924
2899
  * data.
2925
2900
  * @param storeOrStoreId The Store to use, or its Id.
2926
- * @category Hook
2901
+ * @category Listener
2927
2902
  * @since v8.1.0
2928
2903
  */
2929
- export function useValueListener(
2904
+ export function onValue(
2930
2905
  valueId: MaybeGetter<IdOrNull>,
2931
2906
  listener: ValueListener,
2932
2907
  mutator?: boolean,
@@ -2934,89 +2909,89 @@ export function useValueListener(
2934
2909
  ): void;
2935
2910
 
2936
2911
  /**
2937
- * The useStartTransactionListener hook registers a listener that is called at
2938
- * the start of every Store transaction.
2912
+ * The onStartTransaction function registers a listener that is called at the
2913
+ * start of every Store transaction.
2939
2914
  * @param listener The function to call at transaction start.
2940
2915
  * @param storeOrStoreId The Store to use, or its Id.
2941
- * @category Hook
2916
+ * @category Listener
2942
2917
  * @since v8.1.0
2943
2918
  */
2944
- export function useStartTransactionListener(
2919
+ export function onStartTransaction(
2945
2920
  listener: TransactionListener,
2946
2921
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
2947
2922
  ): void;
2948
2923
 
2949
2924
  /**
2950
- * The useWillFinishTransactionListener hook registers a listener called just
2951
- * before a Store transaction completes.
2925
+ * The onWillFinishTransaction function registers a listener called just before
2926
+ * a Store transaction completes.
2952
2927
  * @param listener The function to call before transaction end.
2953
2928
  * @param storeOrStoreId The Store to use, or its Id.
2954
- * @category Hook
2929
+ * @category Listener
2955
2930
  * @since v8.1.0
2956
2931
  */
2957
- export function useWillFinishTransactionListener(
2932
+ export function onWillFinishTransaction(
2958
2933
  listener: TransactionListener,
2959
2934
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
2960
2935
  ): void;
2961
2936
 
2962
2937
  /**
2963
- * The useDidFinishTransactionListener hook registers a listener called just
2964
- * after a Store transaction completes.
2938
+ * The onDidFinishTransaction function registers a listener called just after a
2939
+ * Store transaction completes.
2965
2940
  * @param listener The function to call after transaction end.
2966
2941
  * @param storeOrStoreId The Store to use, or its Id.
2967
- * @category Hook
2942
+ * @category Listener
2968
2943
  * @since v8.1.0
2969
2944
  */
2970
- export function useDidFinishTransactionListener(
2945
+ export function onDidFinishTransaction(
2971
2946
  listener: TransactionListener,
2972
2947
  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
2973
2948
  ): void;
2974
2949
 
2975
2950
  /**
2976
- * The useMetricListener hook registers a listener that is called whenever a
2951
+ * The onMetric function registers a listener that is called whenever a
2977
2952
  * specified Metric value changes.
2978
2953
  * @param metricId The Id of the Metric to listen to, or `null` to listen to any
2979
2954
  * Metric.
2980
2955
  * @param listener The function to call when the Metric changes.
2981
2956
  * @param metricsOrMetricsId The Metrics object to use, or its Id.
2982
- * @category Hook
2957
+ * @category Listener
2983
2958
  * @since v8.1.0
2984
2959
  */
2985
- export function useMetricListener(
2960
+ export function onMetric(
2986
2961
  metricId: MaybeGetter<IdOrNull>,
2987
2962
  listener: MetricListener,
2988
2963
  metricsOrMetricsId?: MaybeGetter<MetricsOrMetricsId | undefined>,
2989
2964
  ): void;
2990
2965
 
2991
2966
  /**
2992
- * The useSliceIdsListener hook registers a listener that is called whenever the
2967
+ * The onSliceIds function registers a listener that is called whenever the
2993
2968
  * Slice Ids in an Index change.
2994
2969
  * @param indexId The Id of the Index to listen to, or `null` to listen to any
2995
2970
  * Index.
2996
2971
  * @param listener The function to call when Slice Ids change.
2997
2972
  * @param indexesOrIndexesId The Indexes object to use, or its Id.
2998
- * @category Hook
2973
+ * @category Listener
2999
2974
  * @since v8.1.0
3000
2975
  */
3001
- export function useSliceIdsListener(
2976
+ export function onSliceIds(
3002
2977
  indexId: MaybeGetter<IdOrNull>,
3003
2978
  listener: SliceIdsListener,
3004
2979
  indexesOrIndexesId?: MaybeGetter<IndexesOrIndexesId | undefined>,
3005
2980
  ): void;
3006
2981
 
3007
2982
  /**
3008
- * The useSliceRowIdsListener hook registers a listener that is called whenever
3009
- * the Row Ids in a Slice change.
2983
+ * The onSliceRowIds function registers a listener that is called whenever the
2984
+ * Row Ids in a Slice change.
3010
2985
  * @param indexId The Id of the Index to listen to, or `null` to listen to any
3011
2986
  * Index.
3012
2987
  * @param sliceId The Id of the Slice to listen to, or `null` to listen to any
3013
2988
  * Slice.
3014
2989
  * @param listener The function to call when Slice Row Ids change.
3015
2990
  * @param indexesOrIndexesId The Indexes object to use, or its Id.
3016
- * @category Hook
2991
+ * @category Listener
3017
2992
  * @since v8.1.0
3018
2993
  */
3019
- export function useSliceRowIdsListener(
2994
+ export function onSliceRowIds(
3020
2995
  indexId: MaybeGetter<IdOrNull>,
3021
2996
  sliceId: MaybeGetter<IdOrNull>,
3022
2997
  listener: SliceRowIdsListener,
@@ -3024,8 +2999,8 @@ export function useSliceRowIdsListener(
3024
2999
  ): void;
3025
3000
 
3026
3001
  /**
3027
- * The useRemoteRowIdListener hook registers a listener that is called whenever
3028
- * the remote Row Id for a local Row changes.
3002
+ * The onRemoteRowId function registers a listener that is called whenever the
3003
+ * remote Row Id for a local Row changes.
3029
3004
  * @param relationshipId The Id of the Relationship, or `null` to listen to any
3030
3005
  * Relationship.
3031
3006
  * @param localRowId The Id of the local Row, or `null` to listen to any local
@@ -3033,10 +3008,10 @@ export function useSliceRowIdsListener(
3033
3008
  * @param listener The function to call when the remote Row Id changes.
3034
3009
  * @param relationshipsOrRelationshipsId The Relationships object to use, or its
3035
3010
  * Id.
3036
- * @category Hook
3011
+ * @category Listener
3037
3012
  * @since v8.1.0
3038
3013
  */
3039
- export function useRemoteRowIdListener(
3014
+ export function onRemoteRowId(
3040
3015
  relationshipId: MaybeGetter<IdOrNull>,
3041
3016
  localRowId: MaybeGetter<IdOrNull>,
3042
3017
  listener: RemoteRowIdListener,
@@ -3046,8 +3021,8 @@ export function useRemoteRowIdListener(
3046
3021
  ): void;
3047
3022
 
3048
3023
  /**
3049
- * The useLocalRowIdsListener hook registers a listener that is called whenever
3050
- * the local Row Ids for a remote Row change.
3024
+ * The onLocalRowIds function registers a listener that is called whenever the
3025
+ * local Row Ids for a remote Row change.
3051
3026
  * @param relationshipId The Id of the Relationship, or `null` to listen to any
3052
3027
  * Relationship.
3053
3028
  * @param remoteRowId The Id of the remote Row, or `null` to listen to any
@@ -3055,10 +3030,10 @@ export function useRemoteRowIdListener(
3055
3030
  * @param listener The function to call when local Row Ids change.
3056
3031
  * @param relationshipsOrRelationshipsId The Relationships object to use, or its
3057
3032
  * Id.
3058
- * @category Hook
3033
+ * @category Listener
3059
3034
  * @since v8.1.0
3060
3035
  */
3061
- export function useLocalRowIdsListener(
3036
+ export function onLocalRowIds(
3062
3037
  relationshipId: MaybeGetter<IdOrNull>,
3063
3038
  remoteRowId: MaybeGetter<IdOrNull>,
3064
3039
  listener: LocalRowIdsListener,
@@ -3068,17 +3043,17 @@ export function useLocalRowIdsListener(
3068
3043
  ): void;
3069
3044
 
3070
3045
  /**
3071
- * The useLinkedRowIdsListener hook registers a listener that is called whenever
3072
- * the linked Row Ids for a first Row change.
3046
+ * The onLinkedRowIds function registers a listener that is called whenever the
3047
+ * linked Row Ids for a first Row change.
3073
3048
  * @param relationshipId The Id of the Relationship.
3074
3049
  * @param firstRowId The Id of the first Row.
3075
3050
  * @param listener The function to call when linked Row Ids change.
3076
3051
  * @param relationshipsOrRelationshipsId The Relationships object to use, or its
3077
3052
  * Id.
3078
- * @category Hook
3053
+ * @category Listener
3079
3054
  * @since v8.1.0
3080
3055
  */
3081
- export function useLinkedRowIdsListener(
3056
+ export function onLinkedRowIds(
3082
3057
  relationshipId: MaybeGetter<Id>,
3083
3058
  firstRowId: MaybeGetter<Id>,
3084
3059
  listener: LinkedRowIdsListener,
@@ -3088,71 +3063,71 @@ export function useLinkedRowIdsListener(
3088
3063
  ): void;
3089
3064
 
3090
3065
  /**
3091
- * The useResultTableListener hook registers a listener that is called whenever
3092
- * the result Table of a query changes.
3066
+ * The onResultTable function registers a listener that is called whenever the
3067
+ * result Table of a query changes.
3093
3068
  * @param queryId The Id of the query to listen to, or `null` to listen to any
3094
3069
  * query.
3095
3070
  * @param listener The function to call when the result Table changes.
3096
3071
  * @param queriesOrQueriesId The Queries object to use, or its Id.
3097
- * @category Hook
3072
+ * @category Listener
3098
3073
  * @since v8.1.0
3099
3074
  */
3100
- export function useResultTableListener(
3075
+ export function onResultTable(
3101
3076
  queryId: MaybeGetter<IdOrNull>,
3102
3077
  listener: ResultTableListener,
3103
3078
  queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
3104
3079
  ): void;
3105
3080
 
3106
3081
  /**
3107
- * The useResultTableCellIdsListener hook registers a listener that is called
3082
+ * The onResultTableCellIds function registers a listener that is called
3108
3083
  * whenever the Cell Ids across a result Table change.
3109
3084
  * @param queryId The Id of the query to listen to, or `null` to listen to any
3110
3085
  * query.
3111
3086
  * @param listener The function to call when Cell Ids change.
3112
3087
  * @param queriesOrQueriesId The Queries object to use, or its Id.
3113
- * @category Hook
3088
+ * @category Listener
3114
3089
  * @since v8.1.0
3115
3090
  */
3116
- export function useResultTableCellIdsListener(
3091
+ export function onResultTableCellIds(
3117
3092
  queryId: MaybeGetter<IdOrNull>,
3118
3093
  listener: ResultTableCellIdsListener,
3119
3094
  queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
3120
3095
  ): void;
3121
3096
 
3122
3097
  /**
3123
- * The useResultRowCountListener hook registers a listener that is called
3124
- * whenever the count of result Rows changes.
3098
+ * The onResultRowCount function registers a listener that is called whenever
3099
+ * the count of result Rows changes.
3125
3100
  * @param queryId The Id of the query to listen to, or `null` to listen to any
3126
3101
  * query.
3127
3102
  * @param listener The function to call when the count changes.
3128
3103
  * @param queriesOrQueriesId The Queries object to use, or its Id.
3129
- * @category Hook
3104
+ * @category Listener
3130
3105
  * @since v8.1.0
3131
3106
  */
3132
- export function useResultRowCountListener(
3107
+ export function onResultRowCount(
3133
3108
  queryId: MaybeGetter<IdOrNull>,
3134
3109
  listener: ResultRowCountListener,
3135
3110
  queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
3136
3111
  ): void;
3137
3112
 
3138
3113
  /**
3139
- * The useResultRowIdsListener hook registers a listener that is called whenever
3140
- * the result Row Ids of a query change.
3114
+ * The onResultRowIds function registers a listener that is called whenever the
3115
+ * result Row Ids of a query change.
3141
3116
  * @param queryId The Id of the query to listen to, or `null` to listen to any
3142
3117
  * query.
3143
3118
  * @param listener The function to call when result Row Ids change.
3144
3119
  * @param queriesOrQueriesId The Queries object to use, or its Id.
3145
- * @category Hook
3120
+ * @category Listener
3146
3121
  * @since v8.1.0
3147
3122
  */
3148
- export function useResultRowIdsListener(
3123
+ export function onResultRowIds(
3149
3124
  queryId: MaybeGetter<IdOrNull>,
3150
3125
  listener: ResultRowIdsListener,
3151
3126
  queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
3152
3127
  ): void;
3153
3128
 
3154
3129
  /**
3155
- * The useResultSortedRowIdsListener hook registers a listener that is called
3130
+ * The onResultSortedRowIds function registers a listener that is called
3156
3131
  * whenever the sorted result Row Ids change.
3157
3132
  * @param queryId The Id of the query to listen to.
3158
3133
  * @param cellId The Id of the Cell to sort by, or `undefined` for default
@@ -3162,10 +3137,10 @@ export function useResultRowIdsListener(
3162
3137
  * @param limit The maximum number of Rows to include, or `undefined` for all.
3163
3138
  * @param listener The function to call when sorted Row Ids change.
3164
3139
  * @param queriesOrQueriesId The Queries object to use, or its Id.
3165
- * @category Hook
3140
+ * @category Listener
3166
3141
  * @since v8.1.0
3167
3142
  */
3168
- export function useResultSortedRowIdsListener(
3143
+ export function onResultSortedRowIds(
3169
3144
  queryId: MaybeGetter<Id>,
3170
3145
  cellId: MaybeGetter<Id | undefined>,
3171
3146
  descending: MaybeGetter<boolean>,
@@ -3176,7 +3151,7 @@ export function useResultSortedRowIdsListener(
3176
3151
  ): void;
3177
3152
 
3178
3153
  /**
3179
- * The useResultRowListener hook registers a listener that is called whenever a
3154
+ * The onResultRow function registers a listener that is called whenever a
3180
3155
  * result Row changes.
3181
3156
  * @param queryId The Id of the query to listen to, or `null` to listen to any
3182
3157
  * query.
@@ -3184,10 +3159,10 @@ export function useResultSortedRowIdsListener(
3184
3159
  * any result Row.
3185
3160
  * @param listener The function to call when the result Row changes.
3186
3161
  * @param queriesOrQueriesId The Queries object to use, or its Id.
3187
- * @category Hook
3162
+ * @category Listener
3188
3163
  * @since v8.1.0
3189
3164
  */
3190
- export function useResultRowListener(
3165
+ export function onResultRow(
3191
3166
  queryId: MaybeGetter<IdOrNull>,
3192
3167
  rowId: MaybeGetter<IdOrNull>,
3193
3168
  listener: ResultRowListener,
@@ -3195,18 +3170,18 @@ export function useResultRowListener(
3195
3170
  ): void;
3196
3171
 
3197
3172
  /**
3198
- * The useResultCellIdsListener hook registers a listener that is called
3199
- * whenever the Cell Ids in a result Row change.
3173
+ * The onResultCellIds function registers a listener that is called whenever the
3174
+ * Cell Ids in a result Row change.
3200
3175
  * @param queryId The Id of the query to listen to, or `null` to listen to any
3201
3176
  * query.
3202
3177
  * @param rowId The Id of the result Row to listen to, or `null` to listen to
3203
3178
  * any result Row.
3204
3179
  * @param listener The function to call when Cell Ids change.
3205
3180
  * @param queriesOrQueriesId The Queries object to use, or its Id.
3206
- * @category Hook
3181
+ * @category Listener
3207
3182
  * @since v8.1.0
3208
3183
  */
3209
- export function useResultCellIdsListener(
3184
+ export function onResultCellIds(
3210
3185
  queryId: MaybeGetter<IdOrNull>,
3211
3186
  rowId: MaybeGetter<IdOrNull>,
3212
3187
  listener: ResultCellIdsListener,
@@ -3214,8 +3189,8 @@ export function useResultCellIdsListener(
3214
3189
  ): void;
3215
3190
 
3216
3191
  /**
3217
- * The useResultCellListener hook registers a listener that is called whenever
3218
- * the value of a result Cell changes.
3192
+ * The onResultCell function registers a listener that is called whenever the
3193
+ * value of a result Cell changes.
3219
3194
  * @param queryId The Id of the query to listen to, or `null` to listen to any
3220
3195
  * query.
3221
3196
  * @param rowId The Id of the result Row to listen to, or `null` to listen to
@@ -3224,10 +3199,10 @@ export function useResultCellIdsListener(
3224
3199
  * any result Cell.
3225
3200
  * @param listener The function to call when the result Cell changes.
3226
3201
  * @param queriesOrQueriesId The Queries object to use, or its Id.
3227
- * @category Hook
3202
+ * @category Listener
3228
3203
  * @since v8.1.0
3229
3204
  */
3230
- export function useResultCellListener(
3205
+ export function onResultCell(
3231
3206
  queryId: MaybeGetter<IdOrNull>,
3232
3207
  rowId: MaybeGetter<IdOrNull>,
3233
3208
  cellId: MaybeGetter<IdOrNull>,
@@ -3236,23 +3211,23 @@ export function useResultCellListener(
3236
3211
  ): void;
3237
3212
 
3238
3213
  /**
3239
- * The useParamValuesListener hook registers a listener that is called whenever
3240
- * the parameter values for a query change.
3214
+ * The onParamValues function registers a listener that is called whenever the
3215
+ * parameter values for a query change.
3241
3216
  * @param queryId The Id of the query to listen to, or `null` to listen to any
3242
3217
  * query.
3243
3218
  * @param listener The function to call when parameter values change.
3244
3219
  * @param queriesOrQueriesId The Queries object to use, or its Id.
3245
- * @category Hook
3220
+ * @category Listener
3246
3221
  * @since v8.1.0
3247
3222
  */
3248
- export function useParamValuesListener(
3223
+ export function onParamValues(
3249
3224
  queryId: MaybeGetter<IdOrNull>,
3250
3225
  listener: ParamValuesListener,
3251
3226
  queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
3252
3227
  ): void;
3253
3228
 
3254
3229
  /**
3255
- * The useParamValueListener hook registers a listener that is called whenever a
3230
+ * The onParamValue function registers a listener that is called whenever a
3256
3231
  * specific parameter value for a query changes.
3257
3232
  * @param queryId The Id of the query to listen to, or `null` to listen to any
3258
3233
  * query.
@@ -3260,10 +3235,10 @@ export function useParamValuesListener(
3260
3235
  * any parameter.
3261
3236
  * @param listener The function to call when the parameter value changes.
3262
3237
  * @param queriesOrQueriesId The Queries object to use, or its Id.
3263
- * @category Hook
3238
+ * @category Listener
3264
3239
  * @since v8.1.0
3265
3240
  */
3266
- export function useParamValueListener(
3241
+ export function onParamValue(
3267
3242
  queryId: MaybeGetter<IdOrNull>,
3268
3243
  paramId: MaybeGetter<IdOrNull>,
3269
3244
  listener: ParamValueListener,
@@ -3271,14 +3246,14 @@ export function useParamValueListener(
3271
3246
  ): void;
3272
3247
 
3273
3248
  /**
3274
- * The useCheckpointIdsListener hook registers a listener that is called
3275
- * whenever the Checkpoint Ids change.
3249
+ * The onCheckpointIds function registers a listener that is called whenever the
3250
+ * Checkpoint Ids change.
3276
3251
  * @param listener The function to call when Checkpoint Ids change.
3277
3252
  * @param checkpointsOrCheckpointsId The Checkpoints object to use, or its Id.
3278
- * @category Hook
3253
+ * @category Listener
3279
3254
  * @since v8.1.0
3280
3255
  */
3281
- export function useCheckpointIdsListener(
3256
+ export function onCheckpointIds(
3282
3257
  listener: CheckpointIdsListener,
3283
3258
  checkpointsOrCheckpointsId?: MaybeGetter<
3284
3259
  CheckpointsOrCheckpointsId | undefined
@@ -3286,16 +3261,16 @@ export function useCheckpointIdsListener(
3286
3261
  ): void;
3287
3262
 
3288
3263
  /**
3289
- * The useCheckpointListener hook registers a listener that is called whenever
3290
- * the label of a specified Checkpoint changes.
3264
+ * The onCheckpoint function registers a listener that is called whenever the
3265
+ * label of a specified Checkpoint changes.
3291
3266
  * @param checkpointId The Id of the Checkpoint to listen to, or `null` to
3292
3267
  * listen to any Checkpoint.
3293
3268
  * @param listener The function to call when the Checkpoint label changes.
3294
3269
  * @param checkpointsOrCheckpointsId The Checkpoints object to use, or its Id.
3295
- * @category Hook
3270
+ * @category Listener
3296
3271
  * @since v8.1.0
3297
3272
  */
3298
- export function useCheckpointListener(
3273
+ export function onCheckpoint(
3299
3274
  checkpointId: MaybeGetter<IdOrNull>,
3300
3275
  listener: CheckpointListener,
3301
3276
  checkpointsOrCheckpointsId?: MaybeGetter<
@@ -3304,27 +3279,27 @@ export function useCheckpointListener(
3304
3279
  ): void;
3305
3280
 
3306
3281
  /**
3307
- * The usePersisterStatusListener hook registers a listener that is called
3308
- * whenever the status of a Persister changes.
3282
+ * The onPersisterStatus function registers a listener that is called whenever
3283
+ * the status of a Persister changes.
3309
3284
  * @param listener The function to call when the status changes.
3310
3285
  * @param persisterOrPersisterId The Persister to use, or its Id.
3311
- * @category Hook
3286
+ * @category Listener
3312
3287
  * @since v8.1.0
3313
3288
  */
3314
- export function usePersisterStatusListener(
3289
+ export function onPersisterStatus(
3315
3290
  listener: StatusListener,
3316
3291
  persisterOrPersisterId?: MaybeGetter<PersisterOrPersisterId | undefined>,
3317
3292
  ): void;
3318
3293
 
3319
3294
  /**
3320
- * The useSynchronizerStatusListener hook registers a listener that is called
3295
+ * The onSynchronizerStatus function registers a listener that is called
3321
3296
  * whenever the status of a Synchronizer changes.
3322
3297
  * @param listener The function to call when the status changes.
3323
3298
  * @param synchronizerOrSynchronizerId The Synchronizer to use, or its Id.
3324
- * @category Hook
3299
+ * @category Listener
3325
3300
  * @since v8.1.0
3326
3301
  */
3327
- export function useSynchronizerStatusListener(
3302
+ export function onSynchronizerStatus(
3328
3303
  listener: StatusListener,
3329
3304
  synchronizerOrSynchronizerId?: MaybeGetter<
3330
3305
  SynchronizerOrSynchronizerId | undefined
@@ -3335,8 +3310,8 @@ export function useSynchronizerStatusListener(
3335
3310
  * The provideStore function registers a Store with a given Id into the current
3336
3311
  * Provider context, making it available to all descendant components.
3337
3312
  *
3338
- * This function must be called inside a Svelte component's `<script>` block
3339
- * that is a descendant of a Provider component.
3313
+ * The provideStore function must be called inside a Svelte component's
3314
+ * `<script>` block that is a descendant of a Provider component.
3340
3315
  * @param storeId The Id to register the Store under.
3341
3316
  * @param store The Store to register.
3342
3317
  * @category Provider