tinybase 8.1.0-beta.2 → 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.
Files changed (65) hide show
  1. package/@types/ui-svelte/index.d.ts +743 -825
  2. package/@types/ui-svelte/with-schemas/index.d.ts +747 -841
  3. package/index.js +1 -1
  4. package/mergeable-store/index.js +1 -1
  5. package/mergeable-store/with-schemas/index.js +1 -1
  6. package/min/index.js +1 -1
  7. package/min/index.js.gz +0 -0
  8. package/min/mergeable-store/index.js +1 -1
  9. package/min/mergeable-store/index.js.gz +0 -0
  10. package/min/mergeable-store/with-schemas/index.js +1 -1
  11. package/min/mergeable-store/with-schemas/index.js.gz +0 -0
  12. package/min/omni/index.js +1 -1
  13. package/min/omni/index.js.gz +0 -0
  14. package/min/omni/with-schemas/index.js +1 -1
  15. package/min/omni/with-schemas/index.js.gz +0 -0
  16. package/min/persisters/persister-remote/index.js +1 -1
  17. package/min/persisters/persister-remote/index.js.gz +0 -0
  18. package/min/persisters/persister-remote/with-schemas/index.js +1 -1
  19. package/min/persisters/persister-remote/with-schemas/index.js.gz +0 -0
  20. package/min/queries/index.js +1 -1
  21. package/min/queries/index.js.gz +0 -0
  22. package/min/queries/with-schemas/index.js +1 -1
  23. package/min/queries/with-schemas/index.js.gz +0 -0
  24. package/min/store/index.js +1 -1
  25. package/min/store/index.js.gz +0 -0
  26. package/min/store/with-schemas/index.js +1 -1
  27. package/min/store/with-schemas/index.js.gz +0 -0
  28. package/min/ui-react/index.js +1 -1
  29. package/min/ui-react/index.js.gz +0 -0
  30. package/min/ui-react/with-schemas/index.js +1 -1
  31. package/min/ui-react/with-schemas/index.js.gz +0 -0
  32. package/min/ui-react-dom/index.js +1 -1
  33. package/min/ui-react-dom/index.js.gz +0 -0
  34. package/min/ui-react-dom/with-schemas/index.js +1 -1
  35. package/min/ui-react-dom/with-schemas/index.js.gz +0 -0
  36. package/min/ui-react-inspector/index.js +1 -1
  37. package/min/ui-react-inspector/index.js.gz +0 -0
  38. package/min/ui-react-inspector/with-schemas/index.js +1 -1
  39. package/min/ui-react-inspector/with-schemas/index.js.gz +0 -0
  40. package/min/ui-svelte/index.js +1 -1
  41. package/min/ui-svelte/index.js.gz +0 -0
  42. package/min/ui-svelte/with-schemas/index.js +1 -1
  43. package/min/ui-svelte/with-schemas/index.js.gz +0 -0
  44. package/min/with-schemas/index.js +1 -1
  45. package/min/with-schemas/index.js.gz +0 -0
  46. package/omni/index.js +11 -10
  47. package/omni/with-schemas/index.js +11 -10
  48. package/package.json +17 -17
  49. package/persisters/persister-remote/index.js +10 -9
  50. package/persisters/persister-remote/with-schemas/index.js +10 -9
  51. package/queries/index.js +1 -1
  52. package/queries/with-schemas/index.js +1 -1
  53. package/readme.md +3 -3
  54. package/releases.md +16 -5
  55. package/store/index.js +1 -1
  56. package/store/with-schemas/index.js +1 -1
  57. package/ui-react/index.js +7 -6
  58. package/ui-react/with-schemas/index.js +7 -6
  59. package/ui-react-dom/index.js +7 -6
  60. package/ui-react-dom/with-schemas/index.js +7 -6
  61. package/ui-react-inspector/index.js +29 -21
  62. package/ui-react-inspector/with-schemas/index.js +29 -21
  63. package/ui-svelte/index.js +550 -598
  64. package/ui-svelte/with-schemas/index.js +550 -598
  65. package/with-schemas/index.js +1 -1
@@ -100,9 +100,9 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
100
100
  * The MaybeGetter type represents a value that can be provided either as a
101
101
  * plain value or as a reactive getter function.
102
102
  *
103
- * When a getter function is provided to a hook, the hook's internal `$effect`
104
- * will re-run whenever the getter's reactive dependencies change. This is the
105
- * mechanism that makes Svelte 5 props reactive in hooks.
103
+ * When a getter function is provided to a reactive function, its internal
104
+ * `$effect` will re-run whenever the getter's reactive dependencies change.
105
+ * This is the mechanism that makes Svelte 5 props reactive in these functions.
106
106
  * @category Identity
107
107
  * @since v8.1.0
108
108
  */
@@ -110,7 +110,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
110
110
 
111
111
  /**
112
112
  * The StoreOrStoreId type is used when you need to refer to a Store in a
113
- * Svelte hook or component.
113
+ * ui-svelte function or component.
114
114
  *
115
115
  * This has schema-based typing. The following is a simplified representation:
116
116
  *
@@ -124,7 +124,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
124
124
  * multiple Store objects into a context that can be used throughout the app. In
125
125
  * this case you will want to refer to a Store by its Id in that context.
126
126
  *
127
- * Many hooks and components in this ui-svelte module take this type as a
127
+ * Many functions and components in this ui-svelte module take this type as a
128
128
  * parameter or a prop, allowing you to pass in either the Store or its Id.
129
129
  * @category Identity
130
130
  * @since v8.1.0
@@ -133,7 +133,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
133
133
 
134
134
  /**
135
135
  * The MetricsOrMetricsId type is used when you need to refer to a Metrics
136
- * object in a Svelte hook or component.
136
+ * object in a ui-svelte function or component.
137
137
  *
138
138
  * This has schema-based typing. The following is a simplified representation:
139
139
  *
@@ -141,17 +141,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
141
141
  * Metrics | Id;
142
142
  * ```
143
143
  *
144
- * In some simple cases you will already have a direct reference to the Metrics
145
- * object.
144
+ * In some simple cases you will already have a direct reference to the
145
+ * Metrics object.
146
146
  *
147
147
  * This module also includes a Provider component that can be used to wrap
148
148
  * multiple Metrics objects into a context that can be used throughout the app.
149
- * In this case you will want to refer to a Metrics object by its Id in that
150
- * context.
149
+ * In this case you will want to refer to a Metrics object by its Id in
150
+ * that context.
151
151
  *
152
- * Many hooks and components in this ui-svelte module take this type as a
153
- * parameter or a prop, allowing you to pass in either the Metrics object or its
154
- * Id.
152
+ * Many functions and components in this ui-svelte module take this type as a
153
+ * parameter or a prop, allowing you to pass in either the Metrics object or
154
+ * its Id.
155
155
  * @category Identity
156
156
  * @since v8.1.0
157
157
  */
@@ -159,7 +159,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
159
159
 
160
160
  /**
161
161
  * The IndexesOrIndexesId type is used when you need to refer to an Indexes
162
- * object in a Svelte hook or component.
162
+ * object in a ui-svelte function or component.
163
163
  *
164
164
  * This has schema-based typing. The following is a simplified representation:
165
165
  *
@@ -167,17 +167,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
167
167
  * Indexes | Id;
168
168
  * ```
169
169
  *
170
- * In some simple cases you will already have a direct reference to the Indexes
171
- * object.
170
+ * In some simple cases you will already have a direct reference to the
171
+ * Indexes object.
172
172
  *
173
173
  * This module also includes a Provider component that can be used to wrap
174
174
  * multiple Indexes objects into a context that can be used throughout the app.
175
- * In this case you will want to refer to an Indexes object by its Id in that
176
- * context.
175
+ * In this case you will want to refer to an Indexes object by its Id in
176
+ * that context.
177
177
  *
178
- * Many hooks and components in this ui-svelte module take this type as a
179
- * parameter or a prop, allowing you to pass in either the Indexes object or its
180
- * Id.
178
+ * Many functions and components in this ui-svelte module take this type as a
179
+ * parameter or a prop, allowing you to pass in either the Indexes object or
180
+ * its Id.
181
181
  * @category Identity
182
182
  * @since v8.1.0
183
183
  */
@@ -185,7 +185,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
185
185
 
186
186
  /**
187
187
  * The RelationshipsOrRelationshipsId type is used when you need to refer to a
188
- * Relationships object in a Svelte hook or component.
188
+ * Relationships object in a ui-svelte function or component.
189
189
  *
190
190
  * This has schema-based typing. The following is a simplified representation:
191
191
  *
@@ -201,7 +201,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
201
201
  * app. In this case you will want to refer to a Relationships object by its Id
202
202
  * in that context.
203
203
  *
204
- * Many hooks and components in this ui-svelte module take this type as a
204
+ * Many functions and components in this ui-svelte module take this type as a
205
205
  * parameter or a prop, allowing you to pass in either the Relationships object
206
206
  * or its Id.
207
207
  * @category Identity
@@ -211,7 +211,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
211
211
 
212
212
  /**
213
213
  * The QueriesOrQueriesId type is used when you need to refer to a Queries
214
- * object in a Svelte hook or component.
214
+ * object in a ui-svelte function or component.
215
215
  *
216
216
  * This has schema-based typing. The following is a simplified representation:
217
217
  *
@@ -219,17 +219,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
219
219
  * Queries | Id;
220
220
  * ```
221
221
  *
222
- * In some simple cases you will already have a direct reference to the Queries
223
- * object.
222
+ * In some simple cases you will already have a direct reference to the
223
+ * Queries object.
224
224
  *
225
225
  * This module also includes a Provider component that can be used to wrap
226
226
  * multiple Queries objects into a context that can be used throughout the app.
227
- * In this case you will want to refer to a Queries object by its Id in that
228
- * context.
227
+ * In this case you will want to refer to a Queries object by its Id in
228
+ * that context.
229
229
  *
230
- * Many hooks and components in this ui-svelte module take this type as a
231
- * parameter or a prop, allowing you to pass in either the Queries object or its
232
- * Id.
230
+ * Many functions and components in this ui-svelte module take this type as a
231
+ * parameter or a prop, allowing you to pass in either the Queries object or
232
+ * its Id.
233
233
  * @category Identity
234
234
  * @since v8.1.0
235
235
  */
@@ -237,7 +237,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
237
237
 
238
238
  /**
239
239
  * The CheckpointsOrCheckpointsId type is used when you need to refer to a
240
- * Checkpoints object in a Svelte hook or component.
240
+ * Checkpoints object in a ui-svelte function or component.
241
241
  *
242
242
  * This has schema-based typing. The following is a simplified representation:
243
243
  *
@@ -253,7 +253,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
253
253
  * app. In this case you will want to refer to a Checkpoints object by its Id in
254
254
  * that context.
255
255
  *
256
- * Many hooks and components in this ui-svelte module take this type as a
256
+ * Many functions and components in this ui-svelte module take this type as a
257
257
  * parameter or a prop, allowing you to pass in either the Checkpoints object or
258
258
  * its Id.
259
259
  * @category Identity
@@ -263,7 +263,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
263
263
 
264
264
  /**
265
265
  * The PersisterOrPersisterId type is used when you need to refer to a Persister
266
- * object in a Svelte hook or component.
266
+ * object in a ui-svelte function or component.
267
267
  *
268
268
  * This has schema-based typing. The following is a simplified representation:
269
269
  *
@@ -279,7 +279,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
279
279
  * app. In this case you will want to refer to a Persister object by its Id in
280
280
  * that context.
281
281
  *
282
- * Many hooks and components in this ui-svelte module take this type as a
282
+ * Many functions and components in this ui-svelte module take this type as a
283
283
  * parameter or a prop, allowing you to pass in either the Persister or its Id.
284
284
  * @category Identity
285
285
  * @since v8.1.0
@@ -288,7 +288,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
288
288
 
289
289
  /**
290
290
  * The SynchronizerOrSynchronizerId type is used when you need to refer to a
291
- * Synchronizer object in a Svelte hook or component.
291
+ * Synchronizer object in a ui-svelte function or component.
292
292
  *
293
293
  * This has schema-based typing. The following is a simplified representation:
294
294
  *
@@ -304,9 +304,9 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
304
304
  * app. In this case you will want to refer to a Synchronizer object by its Id
305
305
  * in that context.
306
306
  *
307
- * Many hooks and components in this ui-svelte module take this type as a
308
- * parameter or a prop, allowing you to pass in either the Synchronizer or its
309
- * Id.
307
+ * Many functions and components in this ui-svelte module take this type as a
308
+ * parameter or a prop, allowing you to pass in either the Synchronizer or
309
+ * its Id.
310
310
  * @category Identity
311
311
  * @since v8.1.0
312
312
  */
@@ -536,8 +536,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
536
536
  };
537
537
 
538
538
  /**
539
- * The CheckpointViewProps type describes the props of the CheckpointView
540
- * component.
539
+ * The CheckpointViewProps type describes the props of the
540
+ * CheckpointView component.
541
541
  * @category Props
542
542
  * @since v8.1.0
543
543
  */
@@ -657,8 +657,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
657
657
  };
658
658
 
659
659
  /**
660
- * The SortedTableViewProps type describes the props of the SortedTableView
661
- * component.
660
+ * The SortedTableViewProps type describes the props of the
661
+ * SortedTableView component.
662
662
  * @category Props
663
663
  * @since v8.1.0
664
664
  */
@@ -872,8 +872,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
872
872
  };
873
873
 
874
874
  /**
875
- * The RemoteRowViewProps type describes the props of the RemoteRowView
876
- * component.
875
+ * The RemoteRowViewProps type describes the props of the
876
+ * RemoteRowView component.
877
877
  * @category Props
878
878
  * @since v8.1.0
879
879
  */
@@ -911,8 +911,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
911
911
  };
912
912
 
913
913
  /**
914
- * The LocalRowsViewProps type describes the props of the LocalRowsView
915
- * component.
914
+ * The LocalRowsViewProps type describes the props of the
915
+ * LocalRowsView component.
916
916
  * @category Props
917
917
  * @since v8.1.0
918
918
  */
@@ -956,8 +956,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
956
956
  };
957
957
 
958
958
  /**
959
- * The LinkedRowsViewProps type describes the props of the LinkedRowsView
960
- * component.
959
+ * The LinkedRowsViewProps type describes the props of the
960
+ * LinkedRowsView component.
961
961
  * @category Props
962
962
  * @since v8.1.0
963
963
  */
@@ -1001,8 +1001,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1001
1001
  };
1002
1002
 
1003
1003
  /**
1004
- * The ResultCellViewProps type describes the props of the ResultCellView
1005
- * component.
1004
+ * The ResultCellViewProps type describes the props of the
1005
+ * ResultCellView component.
1006
1006
  * @category Props
1007
1007
  * @since v8.1.0
1008
1008
  */
@@ -1040,8 +1040,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1040
1040
  };
1041
1041
 
1042
1042
  /**
1043
- * The ResultRowViewProps type describes the props of the ResultRowView
1044
- * component.
1043
+ * The ResultRowViewProps type describes the props of the
1044
+ * ResultRowView component.
1045
1045
  * @category Props
1046
1046
  * @since v8.1.0
1047
1047
  */
@@ -1085,8 +1085,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1085
1085
  };
1086
1086
 
1087
1087
  /**
1088
- * The ResultTableViewProps type describes the props of the ResultTableView
1089
- * component.
1088
+ * The ResultTableViewProps type describes the props of the
1089
+ * ResultTableView component.
1090
1090
  * @category Props
1091
1091
  * @since v8.1.0
1092
1092
  */
@@ -1320,8 +1320,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1320
1320
 
1321
1321
  /**
1322
1322
  * The ValueView component renders the value of a single Value in a Store, and
1323
- * registers a listener so that any changes to that result will cause a
1324
- * re-render.
1323
+ * registers a listener so that any changes to that result will cause
1324
+ * a re-render.
1325
1325
  * @param props The props for this component.
1326
1326
  * @returns A rendering of the Value, or nothing if not present.
1327
1327
  * @category Component
@@ -1331,8 +1331,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1331
1331
 
1332
1332
  /**
1333
1333
  * The RowView component renders the contents of a single Row in a given Table,
1334
- * and registers a listener so that any changes to that result will cause a
1335
- * re-render.
1334
+ * and registers a listener so that any changes to that result will cause
1335
+ * a re-render.
1336
1336
  * @param props The props for this component.
1337
1337
  * @returns A rendering of the Row, or nothing if not present.
1338
1338
  * @category Component
@@ -1363,8 +1363,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1363
1363
 
1364
1364
  /**
1365
1365
  * The TablesView component renders the contents of all Tables in a Store, and
1366
- * registers a listener so that any changes to that result will cause a
1367
- * re-render.
1366
+ * registers a listener so that any changes to that result will cause
1367
+ * a re-render.
1368
1368
  * @param props The props for this component.
1369
1369
  * @returns A rendering of all Tables.
1370
1370
  * @category Component
@@ -1405,8 +1405,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1405
1405
 
1406
1406
  /**
1407
1407
  * The SliceView component renders the Row Ids in a named Slice in an Index, and
1408
- * registers a listener so that any changes to that result will cause a
1409
- * re-render.
1408
+ * registers a listener so that any changes to that result will cause
1409
+ * a re-render.
1410
1410
  * @param props The props for this component.
1411
1411
  * @returns A rendering of the Rows in the Slice.
1412
1412
  * @category Component
@@ -1438,8 +1438,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1438
1438
 
1439
1439
  /**
1440
1440
  * The LinkedRowsView component renders the Rows in a linked list Relationship,
1441
- * and registers a listener so that any changes to that result will cause a
1442
- * re-render.
1441
+ * and registers a listener so that any changes to that result will cause
1442
+ * a re-render.
1443
1443
  * @param props The props for this component.
1444
1444
  * @returns A rendering of the linked Row Ids.
1445
1445
  * @category Component
@@ -1544,144 +1544,144 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1544
1544
  >;
1545
1545
 
1546
1546
  /**
1547
- * The useHasTables hook returns a reactive object indicating whether any Tables
1548
- * exist in the Store, and registers a listener so that any changes to that
1549
- * result will update `.current`.
1547
+ * The createHasTables function returns a reactive object indicating whether any
1548
+ * Tables exist in the Store, and registers a listener so that any changes to
1549
+ * that result will update `.current`.
1550
1550
  * @param storeOrStoreId The Store to use, or its Id in a Provider context.
1551
1551
  * @returns A reactive object with a `current` boolean property.
1552
- * @category Hook
1552
+ * @category Getter
1553
1553
  * @since v8.1.0
1554
1554
  */
1555
- useHasTables: (
1555
+ createHasTables: (
1556
1556
  storeOrStoreId?: MaybeGetter<StoreOrStoreId<Schemas> | undefined>,
1557
1557
  ) => {
1558
1558
  readonly current: boolean;
1559
1559
  };
1560
1560
 
1561
1561
  /**
1562
- * The useTables hook returns a reactive object reflecting the Tables in the
1563
- * Store, and registers a listener so that any changes to those Tables will
1562
+ * The createTables function returns a reactive object reflecting the Tables in
1563
+ * the Store, and registers a listener so that any changes to those Tables will
1564
1564
  * update `.current`.
1565
1565
  * @param storeOrStoreId The Store to use, or its Id in a Provider context.
1566
1566
  * @returns A reactive object with a `current` Tables property.
1567
- * @category Hook
1567
+ * @category Getter
1568
1568
  * @since v8.1.0
1569
1569
  */
1570
- useTables: (
1570
+ createTables: (
1571
1571
  storeOrStoreId?: MaybeGetter<StoreOrStoreId<Schemas> | undefined>,
1572
1572
  ) => {
1573
1573
  readonly current: Tables<Schemas[0]>;
1574
1574
  };
1575
1575
 
1576
1576
  /**
1577
- * The useTableIds hook returns a reactive object reflecting the Ids of the
1578
- * Tables in a Store, and registers a listener so that any changes to those Ids
1579
- * will update `.current`.
1577
+ * The createTableIds function returns a reactive object reflecting the Ids of
1578
+ * the Tables in a Store, and registers a listener so that any changes to those
1579
+ * Ids will update `.current`.
1580
1580
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1581
1581
  * @returns A reactive object with a `current` Ids property.
1582
- * @category Hook
1582
+ * @category Getter
1583
1583
  * @since v8.1.0
1584
1584
  */
1585
- useTableIds: (storeOrStoreId?: StoreOrStoreId<Schemas>) => {
1585
+ createTableIds: (storeOrStoreId?: StoreOrStoreId<Schemas>) => {
1586
1586
  readonly current: TableIdFromSchema<Schemas[0]>[];
1587
1587
  };
1588
1588
 
1589
1589
  /**
1590
- * The useHasTable hook returns a reactive object indicating whether a Table
1591
- * exists in the Store, and registers a listener so that any changes to that
1592
- * result will update `.current`.
1590
+ * The createHasTable function returns a reactive object indicating whether a
1591
+ * Table exists in the Store, and registers a listener so that any changes to
1592
+ * that result will update `.current`.
1593
1593
  * @param tableId The Id of the Table (or a getter returning it).
1594
1594
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1595
1595
  * @returns A reactive object with a `current` boolean property.
1596
- * @category Hook
1596
+ * @category Getter
1597
1597
  * @since v8.1.0
1598
1598
  */
1599
- useHasTable: <TableId extends TableIdFromSchema<Schemas[0]>>(
1599
+ createHasTable: <TableId extends TableIdFromSchema<Schemas[0]>>(
1600
1600
  tableId: MaybeGetter<TableId>,
1601
1601
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1602
1602
  ) => {readonly current: boolean};
1603
1603
 
1604
1604
  /**
1605
- * The useTable hook returns a reactive object reflecting a Table in a Store,
1606
- * and registers a listener so that any changes to that Table will update
1607
- * `.current`.
1605
+ * The createTable function returns a reactive object reflecting a Table in a
1606
+ * Store, and registers a listener so that any changes to that Table will
1607
+ * update `.current`.
1608
1608
  * @param tableId The Id of the Table (or a getter returning it).
1609
1609
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1610
1610
  * @returns A reactive object with a `current` Table property.
1611
- * @category Hook
1611
+ * @category Getter
1612
1612
  * @since v8.1.0
1613
1613
  */
1614
- useTable: <TableId extends TableIdFromSchema<Schemas[0]>>(
1614
+ createTable: <TableId extends TableIdFromSchema<Schemas[0]>>(
1615
1615
  tableId: MaybeGetter<TableId>,
1616
1616
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1617
1617
  ) => {readonly current: Table<Schemas[0], TableId>};
1618
1618
 
1619
1619
  /**
1620
- * The useTableCellIds hook returns a reactive object reflecting the Ids of all
1621
- * Cells used across a Table, and registers a listener so that any changes to
1622
- * those Ids will update `.current`.
1620
+ * The createTableCellIds function returns a reactive object reflecting the Ids
1621
+ * of all Cells used across a Table, and registers a listener so that any
1622
+ * changes to those Ids will update `.current`.
1623
1623
  * @param tableId The Id of the Table (or a getter returning it).
1624
1624
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1625
1625
  * @returns A reactive object with a `current` Ids property.
1626
- * @category Hook
1626
+ * @category Getter
1627
1627
  * @since v8.1.0
1628
1628
  */
1629
- useTableCellIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
1629
+ createTableCellIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
1630
1630
  tableId: MaybeGetter<TableId>,
1631
1631
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1632
1632
  ) => {readonly current: CellIdFromSchema<Schemas[0], TableId>[]};
1633
1633
 
1634
1634
  /**
1635
- * The useHasTableCell hook returns a reactive object indicating whether a
1636
- * particular Cell is used anywhere in a Table, and registers a listener so that
1637
- * any changes to that result will update `.current`.
1635
+ * The createHasTableCell function returns a reactive object indicating whether
1636
+ * a particular Cell is used anywhere in a Table, and registers a listener so
1637
+ * that any changes to that result will update `.current`.
1638
1638
  * @param tableId The Id of the Table (or a getter returning it).
1639
1639
  * @param cellId The Id of the Cell (or a getter returning it).
1640
1640
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1641
1641
  * @returns A reactive object with a `current` boolean property.
1642
- * @category Hook
1642
+ * @category Getter
1643
1643
  * @since v8.1.0
1644
1644
  */
1645
- useHasTableCell: <TableId extends TableIdFromSchema<Schemas[0]>>(
1645
+ createHasTableCell: <TableId extends TableIdFromSchema<Schemas[0]>>(
1646
1646
  tableId: MaybeGetter<TableId>,
1647
1647
  cellId: MaybeGetter<CellIdFromSchema<Schemas[0], TableId>>,
1648
1648
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1649
1649
  ) => {readonly current: boolean};
1650
1650
 
1651
1651
  /**
1652
- * The useRowCount hook returns a reactive object reflecting the number of Rows
1653
- * in a Table, and registers a listener so that any changes will update
1654
- * `.current`.
1652
+ * The createRowCount function returns a reactive object reflecting the number
1653
+ * of Rows in a Table, and registers a listener so that any changes will
1654
+ * update `.current`.
1655
1655
  * @param tableId The Id of the Table (or a getter returning it).
1656
1656
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1657
1657
  * @returns A reactive object with a `current` number property.
1658
- * @category Hook
1658
+ * @category Getter
1659
1659
  * @since v8.1.0
1660
1660
  */
1661
- useRowCount: (
1661
+ createRowCount: (
1662
1662
  tableId: MaybeGetter<TableIdFromSchema<Schemas[0]>>,
1663
1663
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1664
1664
  ) => {readonly current: number};
1665
1665
 
1666
1666
  /**
1667
- * The useRowIds hook returns a reactive object reflecting the Ids of the Rows
1668
- * in a Table, and registers a listener so that any changes will update
1669
- * `.current`.
1667
+ * The createRowIds function returns a reactive object reflecting the Ids of the
1668
+ * Rows in a Table, and registers a listener so that any changes will
1669
+ * update `.current`.
1670
1670
  * @param tableId The Id of the Table (or a getter returning it).
1671
1671
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1672
1672
  * @returns A reactive object with a `current` Ids property.
1673
- * @category Hook
1673
+ * @category Getter
1674
1674
  * @since v8.1.0
1675
1675
  */
1676
- useRowIds: (
1676
+ createRowIds: (
1677
1677
  tableId: MaybeGetter<TableIdFromSchema<Schemas[0]>>,
1678
1678
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1679
1679
  ) => {readonly current: Ids};
1680
1680
 
1681
1681
  /**
1682
- * The useSortedRowIds hook returns a reactive object reflecting the sorted Row
1683
- * Ids in a Table, and registers a listener so that any changes will update
1684
- * `.current`.
1682
+ * The createSortedRowIds function returns a reactive object reflecting the
1683
+ * sorted Row Ids in a Table, and registers a listener so that any changes will
1684
+ * update `.current`.
1685
1685
  * @param tableId The Id of the Table (or a getter returning it).
1686
1686
  * @param cellId The Id of the Cell to sort by (or a getter returning it).
1687
1687
  * @param descending Whether to sort descending (or a getter returning it).
@@ -1689,10 +1689,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1689
1689
  * @param limit The maximum number of Rows to return (or a getter returning it).
1690
1690
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1691
1691
  * @returns A reactive object with a `current` Ids property.
1692
- * @category Hook
1692
+ * @category Getter
1693
1693
  * @since v8.1.0
1694
1694
  */
1695
- useSortedRowIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
1695
+ createSortedRowIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
1696
1696
  tableId: MaybeGetter<TableId>,
1697
1697
  cellId?: MaybeGetter<CellIdFromSchema<Schemas[0], TableId> | undefined>,
1698
1698
  descending?: MaybeGetter<boolean>,
@@ -1702,68 +1702,69 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1702
1702
  ) => {readonly current: Ids};
1703
1703
 
1704
1704
  /**
1705
- * The useHasRow hook returns a reactive object indicating whether a Row exists
1706
- * in a Table, and registers a listener so that any changes to that result will
1707
- * update `.current`.
1705
+ * The createHasRow function returns a reactive object indicating whether a Row
1706
+ * exists in a Table, and registers a listener so that any changes to that
1707
+ * result will update `.current`.
1708
1708
  * @param tableId The Id of the Table (or a getter returning it).
1709
1709
  * @param rowId The Id of the Row (or a getter returning it).
1710
1710
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1711
1711
  * @returns A reactive object with a `current` boolean property.
1712
- * @category Hook
1712
+ * @category Getter
1713
1713
  * @since v8.1.0
1714
1714
  */
1715
- useHasRow: (
1715
+ createHasRow: (
1716
1716
  tableId: MaybeGetter<TableIdFromSchema<Schemas[0]>>,
1717
1717
  rowId: MaybeGetter<Id>,
1718
1718
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1719
1719
  ) => {readonly current: boolean};
1720
1720
 
1721
1721
  /**
1722
- * The useRow hook returns a reactive object reflecting a Row in a Table, and
1723
- * registers a listener so that any changes to that Row will update `.current`.
1722
+ * The createRow function returns a reactive object reflecting a Row in a Table,
1723
+ * and registers a listener so that any changes to that Row will
1724
+ * update `.current`.
1724
1725
  * @param tableId The Id of the Table (or a getter returning it).
1725
1726
  * @param rowId The Id of the Row (or a getter returning it).
1726
1727
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1727
1728
  * @returns A reactive object with a `current` Row property.
1728
- * @category Hook
1729
+ * @category Getter
1729
1730
  * @since v8.1.0
1730
1731
  */
1731
- useRow: <TableId extends TableIdFromSchema<Schemas[0]>>(
1732
+ createRow: <TableId extends TableIdFromSchema<Schemas[0]>>(
1732
1733
  tableId: MaybeGetter<TableId>,
1733
1734
  rowId: MaybeGetter<Id>,
1734
1735
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1735
1736
  ) => {readonly current: Row<Schemas[0], TableId>};
1736
1737
 
1737
1738
  /**
1738
- * The useCellIds hook returns a reactive object reflecting the Ids of the Cells
1739
- * in a Row, and registers a listener so that any changes will update
1740
- * `.current`.
1739
+ * The createCellIds function returns a reactive object reflecting the Ids of
1740
+ * the Cells in a Row, and registers a listener so that any changes will
1741
+ * update `.current`.
1741
1742
  * @param tableId The Id of the Table (or a getter returning it).
1742
1743
  * @param rowId The Id of the Row (or a getter returning it).
1743
1744
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1744
1745
  * @returns A reactive object with a `current` Ids property.
1745
- * @category Hook
1746
+ * @category Getter
1746
1747
  * @since v8.1.0
1747
1748
  */
1748
- useCellIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
1749
+ createCellIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
1749
1750
  tableId: MaybeGetter<TableId>,
1750
1751
  rowId: MaybeGetter<Id>,
1751
1752
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1752
1753
  ) => {readonly current: CellIdFromSchema<Schemas[0], TableId>[]};
1753
1754
 
1754
1755
  /**
1755
- * The useHasCell hook returns a reactive object indicating whether a Cell
1756
- * exists in a Row in a Table, and registers a listener so that any changes to
1757
- * that result will update `.current`.
1756
+ * The createHasCell function returns a reactive object indicating whether a
1757
+ * Cell exists in a Row in a Table, and registers a listener so that any changes
1758
+ * to that result will update `.current`.
1758
1759
  * @param tableId The Id of the Table (or a getter returning it).
1759
1760
  * @param rowId The Id of the Row (or a getter returning it).
1760
1761
  * @param cellId The Id of the Cell (or a getter returning it).
1761
1762
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1762
1763
  * @returns A reactive object with a `current` boolean property.
1763
- * @category Hook
1764
+ * @category Getter
1764
1765
  * @since v8.1.0
1765
1766
  */
1766
- useHasCell: <
1767
+ createHasCell: <
1767
1768
  TableId extends TableIdFromSchema<Schemas[0]>,
1768
1769
  CellId extends CellIdFromSchema<Schemas[0], TableId>,
1769
1770
  >(
@@ -1774,61 +1775,41 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1774
1775
  ) => {readonly current: boolean};
1775
1776
 
1776
1777
  /**
1777
- * The useCell hook returns a reactive object reflecting the value of a Cell in
1778
- * a Row in a Table, and registers a listener so that any changes to that Cell
1779
- * will update `.current`.
1780
- * @param tableId The Id of the Table (or a getter returning it).
1781
- * @param rowId The Id of the Row (or a getter returning it).
1782
- * @param cellId The Id of the Cell (or a getter returning it).
1783
- * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1784
- * @returns A reactive object with a `current` CellOrUndefined property.
1785
- * @example
1786
- * This example uses the useCell hook to display a Cell value reactively.
1778
+ * The createCell function returns a reactive object reflecting the value of a
1779
+ * Cell in a Row in a Table, and registers a listener so that any changes to
1780
+ * that Cell will update `.current`.
1787
1781
  *
1788
1782
  * This has schema-based typing. The following is a simplified representation:
1789
1783
  *
1790
1784
  * ```ts override
1791
- * useCell(
1785
+ * createCell(
1792
1786
  * tableId: MaybeGetter<Id>,
1793
1787
  * rowId: MaybeGetter<Id>,
1794
1788
  * cellId: MaybeGetter<Id>,
1795
1789
  * storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1796
- * ): {readonly current: CellOrUndefined};
1790
+ * ): {get current(): CellOrUndefined; set current(v: Cell)};
1797
1791
  * ```
1798
1792
  *
1799
- * ```ts
1800
- * // In a .svelte file:
1801
- * // const store = createStore().setCell('pets', 'cat', 'name', 'Fido');
1802
- * // const name = useCell('pets', 'cat', 'name', store);
1803
- * // $: console.log(name.current); // 'Fido'
1804
- * ```
1805
- * @category Hook
1806
- * @since v8.1.0
1807
- */
1808
- useCell: <
1809
- TableId extends TableIdFromSchema<Schemas[0]>,
1810
- CellId extends CellIdFromSchema<Schemas[0], TableId>,
1811
- >(
1812
- tableId: MaybeGetter<TableId>,
1813
- rowId: MaybeGetter<Id>,
1814
- cellId: MaybeGetter<CellId>,
1815
- storeOrStoreId?: StoreOrStoreId<Schemas>,
1816
- ) => {
1817
- readonly current: NoInfer<CellOrUndefined<Schemas[0], TableId, CellId>>;
1818
- };
1819
-
1820
- /**
1821
- * The useBindableCell hook returns a reactive object reflecting the value of a
1822
- * Cell, with a settable `current` property that writes back to the Store.
1793
+ * Since Cells are mutable leaf values in a Store, the returned object's
1794
+ * `current` property can also be assigned to write back to the Store.
1823
1795
  * @param tableId The Id of the Table (or a getter returning it).
1824
1796
  * @param rowId The Id of the Row (or a getter returning it).
1825
1797
  * @param cellId The Id of the Cell (or a getter returning it).
1826
1798
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1827
1799
  * @returns A reactive object with gettable and settable `current`.
1828
- * @category Hook
1800
+ * @example
1801
+ * This example uses the createCell function to display a Cell value reactively.
1802
+ *
1803
+ * ```ts
1804
+ * // In a .svelte file:
1805
+ * // const store = createStore().setCell('pets', 'cat', 'name', 'Fido');
1806
+ * // const name = createCell('pets', 'cat', 'name', store);
1807
+ * // $: console.log(name.current); // 'Fido'
1808
+ * ```
1809
+ * @category Getter
1829
1810
  * @since v8.1.0
1830
1811
  */
1831
- useBindableCell: <
1812
+ createCell: <
1832
1813
  TableId extends TableIdFromSchema<Schemas[0]>,
1833
1814
  CellId extends CellIdFromSchema<Schemas[0], TableId>,
1834
1815
  >(
@@ -1842,89 +1823,86 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1842
1823
  };
1843
1824
 
1844
1825
  /**
1845
- * The useHasValues hook returns a reactive object indicating whether any Values
1846
- * exist in the Store, and registers a listener so that any changes to that
1847
- * result will update `.current`.
1826
+ * The createHasValues function returns a reactive object indicating whether any
1827
+ * Values exist in the Store, and registers a listener so that any changes to
1828
+ * that result will update `.current`.
1848
1829
  * @param storeOrStoreId The Store to use, or its Id in a Provider context.
1849
1830
  * @returns A reactive object with a `current` boolean property.
1850
- * @category Hook
1831
+ * @category Getter
1851
1832
  * @since v8.1.0
1852
1833
  */
1853
- useHasValues: (
1834
+ createHasValues: (
1854
1835
  storeOrStoreId?: MaybeGetter<StoreOrStoreId<Schemas> | undefined>,
1855
1836
  ) => {
1856
1837
  readonly current: boolean;
1857
1838
  };
1858
1839
 
1859
1840
  /**
1860
- * The useValues hook returns a reactive object reflecting the Values in the
1861
- * Store, and registers a listener so that any changes will update `.current`.
1841
+ * The createValues function returns a reactive object reflecting the Values in
1842
+ * the Store, and registers a listener so that any changes will
1843
+ * update `.current`.
1862
1844
  * @param storeOrStoreId The Store to use, or its Id in a Provider context.
1863
1845
  * @returns A reactive object with a `current` Values property.
1864
- * @category Hook
1846
+ * @category Getter
1865
1847
  * @since v8.1.0
1866
1848
  */
1867
- useValues: (
1849
+ createValues: (
1868
1850
  storeOrStoreId?: MaybeGetter<StoreOrStoreId<Schemas> | undefined>,
1869
1851
  ) => {
1870
1852
  readonly current: Values<Schemas[1]>;
1871
1853
  };
1872
1854
 
1873
1855
  /**
1874
- * The useValueIds hook returns a reactive object reflecting the Ids of the
1875
- * Values in a Store, and registers a listener so that any changes will update
1876
- * `.current`.
1856
+ * The createValueIds function returns a reactive object reflecting the Ids of
1857
+ * the Values in a Store, and registers a listener so that any changes will
1858
+ * update `.current`.
1877
1859
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1878
1860
  * @returns A reactive object with a `current` Ids property.
1879
- * @category Hook
1861
+ * @category Getter
1880
1862
  * @since v8.1.0
1881
1863
  */
1882
- useValueIds: (storeOrStoreId?: StoreOrStoreId<Schemas>) => {
1864
+ createValueIds: (storeOrStoreId?: StoreOrStoreId<Schemas>) => {
1883
1865
  readonly current: ValueIdFromSchema<Schemas[1]>[];
1884
1866
  };
1885
1867
 
1886
1868
  /**
1887
- * The useHasValue hook returns a reactive object indicating whether a Value
1888
- * exists in the Store, and registers a listener so that any changes to that
1889
- * result will update `.current`.
1869
+ * The createHasValue function returns a reactive object indicating whether a
1870
+ * Value exists in the Store, and registers a listener so that any changes to
1871
+ * that result will update `.current`.
1890
1872
  * @param valueId The Id of the Value (or a getter returning it).
1891
1873
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1892
1874
  * @returns A reactive object with a `current` boolean property.
1893
- * @category Hook
1875
+ * @category Getter
1894
1876
  * @since v8.1.0
1895
1877
  */
1896
- useHasValue: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
1878
+ createHasValue: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
1897
1879
  valueId: MaybeGetter<ValueId>,
1898
1880
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1899
1881
  ) => {readonly current: boolean};
1900
1882
 
1901
1883
  /**
1902
- * The useValue hook returns a reactive object reflecting the value of a Value
1903
- * in a Store, and registers a listener so that any changes to that Value will
1904
- * update `.current`.
1905
- * @param valueId The Id of the Value (or a getter returning it).
1906
- * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1907
- * @returns A reactive object with a `current` ValueOrUndefined property.
1908
- * @category Hook
1909
- * @since v8.1.0
1910
- */
1911
- useValue: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
1912
- valueId: MaybeGetter<ValueId>,
1913
- storeOrStoreId?: StoreOrStoreId<Schemas>,
1914
- ) => {
1915
- readonly current: NoInfer<DefaultedValueFromSchema<Schemas[1], ValueId>>;
1916
- };
1917
-
1918
- /**
1919
- * The useBindableValue hook returns a reactive object reflecting the value of a
1920
- * Value, with a settable `current` property that writes back to the Store.
1884
+ * The createValue function returns a reactive object reflecting the value of a
1885
+ * Value in a Store, and registers a listener so that any changes to that Value
1886
+ * will update `.current`.
1887
+ *
1888
+ * This has schema-based typing. The following is a simplified representation:
1889
+ *
1890
+ * ```ts override
1891
+ * createValue(
1892
+ * valueId: MaybeGetter<Id>,
1893
+ * storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1894
+ * ): {get current(): ValueOrUndefined; set current(v: Value)};
1895
+ * ```
1896
+ *
1897
+ * Since Values are mutable leaf values in a Store, the returned object's
1898
+ * `current` property can also be assigned to write back to the Store.
1921
1899
  * @param valueId The Id of the Value (or a getter returning it).
1922
1900
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1923
1901
  * @returns A reactive object with gettable and settable `current`.
1924
- * @category Hook
1902
+ * @category Getter
1925
1903
  * @since v8.1.0
1926
1904
  */
1927
- useBindableValue: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
1905
+ createValue: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
1928
1906
  valueId: MaybeGetter<ValueId>,
1929
1907
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1930
1908
  ) => {
@@ -1933,132 +1911,132 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1933
1911
  };
1934
1912
 
1935
1913
  /**
1936
- * The useStore hook returns the default Store from the current Provider context
1937
- * (or a named Store if an Id is provided).
1914
+ * The getStore function returns the default Store from the current Provider
1915
+ * context (or a named Store if an Id is provided).
1938
1916
  * @param id An optional Id of a named Store in the Provider context.
1939
1917
  * @returns The Store, or `undefined` if not found.
1940
- * @category Hook
1918
+ * @category Getter
1941
1919
  * @since v8.1.0
1942
1920
  */
1943
- useStore: (id?: Id) => Store<Schemas> | undefined;
1921
+ getStore: (id?: Id) => Store<Schemas> | undefined;
1944
1922
 
1945
1923
  /**
1946
- * The useStoreOrStoreById hook is used to get a reference to a Store object
1947
- * from a Provider context, or have it passed directly.
1924
+ * The resolveStore function is used to get a reference to a Store object from a
1925
+ * Provider context, or have it passed directly.
1948
1926
  * @param storeOrStoreId The Store, its Id, or a getter returning either.
1949
1927
  * @returns A getter function returning the Store, or `undefined`.
1950
- * @category Hook
1928
+ * @category Getter
1951
1929
  * @since v8.1.0
1952
1930
  */
1953
- useStoreOrStoreById: (
1931
+ resolveStore: (
1954
1932
  storeOrStoreId?: MaybeGetter<StoreOrStoreId<Schemas> | undefined>,
1955
1933
  ) => () => Store<Schemas> | undefined;
1956
1934
 
1957
1935
  /**
1958
- * The useStoreIds hook returns a reactive object with the Ids of all Stores
1959
- * registered in the current Provider context.
1936
+ * The createStoreIds function returns a reactive object with the Ids of all
1937
+ * Stores registered in the current Provider context.
1960
1938
  * @returns A reactive object with a `current` Ids property.
1961
- * @category Hook
1939
+ * @category Getter
1962
1940
  * @since v8.1.0
1963
1941
  */
1964
- useStoreIds: () => {readonly current: Ids};
1942
+ createStoreIds: () => {readonly current: Ids};
1965
1943
 
1966
1944
  /**
1967
- * The useMetrics hook returns the default Metrics object from the current
1945
+ * The getMetrics function returns the default Metrics object from the current
1968
1946
  * Provider context (or a named one if an Id is provided).
1969
1947
  * @param id An optional Id of a named Metrics object in the Provider context.
1970
1948
  * @returns The Metrics object, or `undefined` if not found.
1971
- * @category Hook
1949
+ * @category Getter
1972
1950
  * @since v8.1.0
1973
1951
  */
1974
- useMetrics: (id?: Id) => Metrics<Schemas> | undefined;
1952
+ getMetrics: (id?: Id) => Metrics<Schemas> | undefined;
1975
1953
 
1976
1954
  /**
1977
- * The useMetricsOrMetricsById hook is used to get a reference to a Metrics
1978
- * object from a Provider context, or have it passed directly.
1955
+ * The resolveMetrics function is used to get a reference to a Metrics object
1956
+ * from a Provider context, or have it passed directly.
1979
1957
  * @param metricsOrMetricsId The Metrics object, its Id, or a getter returning
1980
1958
  * either.
1981
1959
  * @returns A getter function returning the Metrics object, or `undefined`.
1982
- * @category Hook
1960
+ * @category Getter
1983
1961
  * @since v8.1.0
1984
1962
  */
1985
- useMetricsOrMetricsById: (
1963
+ resolveMetrics: (
1986
1964
  metricsOrMetricsId?: MaybeGetter<MetricsOrMetricsId<Schemas> | undefined>,
1987
1965
  ) => () => Metrics<Schemas> | undefined;
1988
1966
 
1989
1967
  /**
1990
- * The useMetricsIds hook returns a reactive object with the Ids of all Metrics
1991
- * objects registered in the current Provider context.
1968
+ * The createMetricsIds function returns a reactive object with the Ids of all
1969
+ * Metrics objects registered in the current Provider context.
1992
1970
  * @returns A reactive object with a `current` Ids property.
1993
- * @category Hook
1971
+ * @category Getter
1994
1972
  * @since v8.1.0
1995
1973
  */
1996
- useMetricsIds: () => {readonly current: Ids};
1974
+ createMetricsIds: () => {readonly current: Ids};
1997
1975
 
1998
1976
  /**
1999
- * The useMetricIds hook returns a reactive object reflecting the Ids of the
2000
- * Metrics in a Metrics object, and registers a listener so that any changes
1977
+ * The createMetricIds function returns a reactive object reflecting the Ids of
1978
+ * the Metrics in a Metrics object, and registers a listener so that any changes
2001
1979
  * will update `.current`.
2002
1980
  * @param metricsOrMetricsId The Metrics object to use, or its Id.
2003
1981
  * @returns A reactive object with a `current` Ids property.
2004
- * @category Hook
1982
+ * @category Getter
2005
1983
  * @since v8.1.0
2006
1984
  */
2007
- useMetricIds: (
1985
+ createMetricIds: (
2008
1986
  metricsOrMetricsId?: MaybeGetter<MetricsOrMetricsId<Schemas> | undefined>,
2009
1987
  ) => {
2010
1988
  readonly current: Ids;
2011
1989
  };
2012
1990
 
2013
1991
  /**
2014
- * The useMetric hook returns a reactive object reflecting the value of a named
2015
- * Metric in a Metrics object, and registers a listener so that any changes to
2016
- * that Metric will update `.current`.
1992
+ * The createMetric function returns a reactive object reflecting the value of a
1993
+ * named Metric in a Metrics object, and registers a listener so that any
1994
+ * changes to that Metric will update `.current`.
2017
1995
  * @param metricId The Id of the Metric (or a getter returning it).
2018
1996
  * @param metricsOrMetricsId The Metrics object to use (plain or getter), or its
2019
1997
  * Id.
2020
1998
  * @returns A reactive object with a `current` number | undefined property.
2021
- * @category Hook
1999
+ * @category Getter
2022
2000
  * @since v8.1.0
2023
2001
  */
2024
- useMetric: (
2002
+ createMetric: (
2025
2003
  metricId: MaybeGetter<Id>,
2026
2004
  metricsOrMetricsId?: MetricsOrMetricsId<Schemas>,
2027
2005
  ) => {readonly current: number | undefined};
2028
2006
 
2029
2007
  /**
2030
- * The useIndexes hook returns the default Indexes object from the current
2008
+ * The getIndexes function returns the default Indexes object from the current
2031
2009
  * Provider context (or a named one if an Id is provided).
2032
2010
  * @param id An optional Id of a named Indexes object in the Provider context.
2033
2011
  * @returns The Indexes object, or `undefined` if not found.
2034
- * @category Hook
2012
+ * @category Getter
2035
2013
  * @since v8.1.0
2036
2014
  */
2037
- useIndexes: (id?: Id) => Indexes<Schemas> | undefined;
2015
+ getIndexes: (id?: Id) => Indexes<Schemas> | undefined;
2038
2016
 
2039
2017
  /**
2040
- * The useIndexesOrIndexesById hook is used to get a reference to an Indexes
2041
- * object from a Provider context, or have it passed directly.
2018
+ * The resolveIndexes function is used to get a reference to an Indexes object
2019
+ * from a Provider context, or have it passed directly.
2042
2020
  * @param indexesOrIndexesId The Indexes object, its Id, or a getter returning
2043
2021
  * either.
2044
2022
  * @returns A getter function returning the Indexes object, or `undefined`.
2045
- * @category Hook
2023
+ * @category Getter
2046
2024
  * @since v8.1.0
2047
2025
  */
2048
- useIndexesOrIndexesById: (
2026
+ resolveIndexes: (
2049
2027
  indexesOrIndexesId?: MaybeGetter<IndexesOrIndexesId<Schemas> | undefined>,
2050
2028
  ) => () => Indexes<Schemas> | undefined;
2051
2029
 
2052
2030
  /**
2053
- * The useIndexStoreTableId hook returns the Store and table Id for a given
2031
+ * The getIndexStoreTableId function returns the Store and table Id for a given
2054
2032
  * Indexes object and index Id.
2055
2033
  * @param indexesOrId The Indexes object, its Id, or a getter returning either.
2056
2034
  * @param indexId The Id of the index, or a getter returning it.
2057
2035
  * @returns An object with `store` and `tableId` getter properties.
2058
- * @category Hook
2036
+ * @category Getter
2059
2037
  * @since v8.1.0
2060
2038
  */
2061
- useIndexStoreTableId: (
2039
+ getIndexStoreTableId: (
2062
2040
  indexesOrId: MaybeGetter<IndexesOrIndexesId<Schemas> | undefined>,
2063
2041
  indexId: MaybeGetter<Id>,
2064
2042
  ) => {
@@ -2067,177 +2045,177 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2067
2045
  };
2068
2046
 
2069
2047
  /**
2070
- * The useIndexesIds hook returns a reactive object with the Ids of all Indexes
2071
- * objects registered in the current Provider context.
2048
+ * The createIndexesIds function returns a reactive object with the Ids of all
2049
+ * Indexes objects registered in the current Provider context.
2072
2050
  * @returns A reactive object with a `current` Ids property.
2073
- * @category Hook
2051
+ * @category Getter
2074
2052
  * @since v8.1.0
2075
2053
  */
2076
- useIndexesIds: () => {readonly current: Ids};
2054
+ createIndexesIds: () => {readonly current: Ids};
2077
2055
 
2078
2056
  /**
2079
- * The useIndexIds hook returns a reactive object reflecting the Ids of the
2080
- * Indexes in an Indexes object, and registers a listener so that any changes
2081
- * will update `.current`.
2057
+ * The createIndexIds function returns a reactive object reflecting the Ids of
2058
+ * the Indexes in an Indexes object, and registers a listener so that any
2059
+ * changes will update `.current`.
2082
2060
  * @param indexesOrIndexesId The Indexes object to use, or its Id.
2083
2061
  * @returns A reactive object with a `current` Ids property.
2084
- * @category Hook
2062
+ * @category Getter
2085
2063
  * @since v8.1.0
2086
2064
  */
2087
- useIndexIds: (
2065
+ createIndexIds: (
2088
2066
  indexesOrIndexesId?: MaybeGetter<IndexesOrIndexesId<Schemas> | undefined>,
2089
2067
  ) => {
2090
2068
  readonly current: Ids;
2091
2069
  };
2092
2070
 
2093
2071
  /**
2094
- * The useSliceIds hook returns a reactive object reflecting the Ids of the
2095
- * Slices in an Index, and registers a listener so that any changes will update
2096
- * `.current`.
2072
+ * The createSliceIds function returns a reactive object reflecting the Ids of
2073
+ * the Slices in an Index, and registers a listener so that any changes will
2074
+ * update `.current`.
2097
2075
  * @param indexId The Id of the Index (or a getter returning it).
2098
2076
  * @param indexesOrIndexesId The Indexes object to use (plain or getter), or its
2099
2077
  * Id.
2100
2078
  * @returns A reactive object with a `current` Ids property.
2101
- * @category Hook
2079
+ * @category Getter
2102
2080
  * @since v8.1.0
2103
2081
  */
2104
- useSliceIds: (
2082
+ createSliceIds: (
2105
2083
  indexId: MaybeGetter<Id>,
2106
2084
  indexesOrIndexesId?: IndexesOrIndexesId<Schemas>,
2107
2085
  ) => {readonly current: Ids};
2108
2086
 
2109
2087
  /**
2110
- * The useSliceRowIds hook returns a reactive object reflecting the Ids of the
2111
- * Rows in a Slice, and registers a listener so that any changes will update
2112
- * `.current`.
2088
+ * The createSliceRowIds function returns a reactive object reflecting the Ids
2089
+ * of the Rows in a Slice, and registers a listener so that any changes will
2090
+ * update `.current`.
2113
2091
  * @param indexId The Id of the Index (or a getter returning it).
2114
2092
  * @param sliceId The Id of the Slice (or a getter returning it).
2115
2093
  * @param indexesOrIndexesId The Indexes object to use (plain or getter), or its
2116
2094
  * Id.
2117
2095
  * @returns A reactive object with a `current` Ids property.
2118
- * @category Hook
2096
+ * @category Getter
2119
2097
  * @since v8.1.0
2120
2098
  */
2121
- useSliceRowIds: (
2099
+ createSliceRowIds: (
2122
2100
  indexId: MaybeGetter<Id>,
2123
2101
  sliceId: MaybeGetter<Id>,
2124
2102
  indexesOrIndexesId?: IndexesOrIndexesId<Schemas>,
2125
2103
  ) => {readonly current: Ids};
2126
2104
 
2127
2105
  /**
2128
- * The useQueries hook returns the default Queries object from the current
2106
+ * The getQueries function returns the default Queries object from the current
2129
2107
  * Provider context (or a named one if an Id is provided).
2130
2108
  * @param id An optional Id of a named Queries object in the Provider context.
2131
2109
  * @returns The Queries object, or `undefined` if not found.
2132
- * @category Hook
2110
+ * @category Getter
2133
2111
  * @since v8.1.0
2134
2112
  */
2135
- useQueries: (id?: Id) => Queries<Schemas> | undefined;
2113
+ getQueries: (id?: Id) => Queries<Schemas> | undefined;
2136
2114
 
2137
2115
  /**
2138
- * The useQueriesOrQueriesById hook is used to get a reference to a Queries
2139
- * object from a Provider context, or have it passed directly.
2116
+ * The resolveQueries function is used to get a reference to a Queries object
2117
+ * from a Provider context, or have it passed directly.
2140
2118
  * @param queriesOrQueriesId The Queries object, its Id, or a getter returning
2141
2119
  * either.
2142
2120
  * @returns A getter function returning the Queries object, or `undefined`.
2143
- * @category Hook
2121
+ * @category Getter
2144
2122
  * @since v8.1.0
2145
2123
  */
2146
- useQueriesOrQueriesById: (
2124
+ resolveQueries: (
2147
2125
  queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId<Schemas> | undefined>,
2148
2126
  ) => () => Queries<Schemas> | undefined;
2149
2127
 
2150
2128
  /**
2151
- * The useQueriesIds hook returns a reactive object with the Ids of all Queries
2152
- * objects registered in the current Provider context.
2129
+ * The createQueriesIds function returns a reactive object with the Ids of all
2130
+ * Queries objects registered in the current Provider context.
2153
2131
  * @returns A reactive object with a `current` Ids property.
2154
- * @category Hook
2132
+ * @category Getter
2155
2133
  * @since v8.1.0
2156
2134
  */
2157
- useQueriesIds: () => {readonly current: Ids};
2135
+ createQueriesIds: () => {readonly current: Ids};
2158
2136
 
2159
2137
  /**
2160
- * The useQueryIds hook returns a reactive object reflecting the Ids of the
2161
- * Queries in a Queries object, and registers a listener so that any changes
2138
+ * The createQueryIds function returns a reactive object reflecting the Ids of
2139
+ * the Queries in a Queries object, and registers a listener so that any changes
2162
2140
  * will update `.current`.
2163
2141
  * @param queriesOrQueriesId The Queries object to use, or its Id.
2164
2142
  * @returns A reactive object with a `current` Ids property.
2165
- * @category Hook
2143
+ * @category Getter
2166
2144
  * @since v8.1.0
2167
2145
  */
2168
- useQueryIds: (
2146
+ createQueryIds: (
2169
2147
  queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId<Schemas> | undefined>,
2170
2148
  ) => {
2171
2149
  readonly current: Ids;
2172
2150
  };
2173
2151
 
2174
2152
  /**
2175
- * The useResultTable hook returns a reactive object reflecting a result Table
2176
- * in a Queries object, and registers a listener so that any changes to that
2177
- * result will update `.current`.
2153
+ * The createResultTable function returns a reactive object reflecting a result
2154
+ * Table in a Queries object, and registers a listener so that any changes to
2155
+ * that result will update `.current`.
2178
2156
  * @param queryId The Id of the Query (or a getter returning it).
2179
2157
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2180
2158
  * Id.
2181
2159
  * @returns A reactive object with a `current` Table property.
2182
- * @category Hook
2160
+ * @category Getter
2183
2161
  * @since v8.1.0
2184
2162
  */
2185
- useResultTable: (
2163
+ createResultTable: (
2186
2164
  queryId: MaybeGetter<Id>,
2187
2165
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
2188
2166
  ) => {readonly current: ResultTable};
2189
2167
 
2190
2168
  /**
2191
- * The useResultTableCellIds hook returns a reactive object reflecting the Ids
2192
- * of all Cells used across a result Table, and registers a listener so that any
2193
- * changes will update `.current`.
2169
+ * The createResultTableCellIds function returns a reactive object reflecting
2170
+ * the Ids of all Cells used across a result Table, and registers a listener so
2171
+ * that any changes will update `.current`.
2194
2172
  * @param queryId The Id of the Query (or a getter returning it).
2195
2173
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2196
2174
  * Id.
2197
2175
  * @returns A reactive object with a `current` Ids property.
2198
- * @category Hook
2176
+ * @category Getter
2199
2177
  * @since v8.1.0
2200
2178
  */
2201
- useResultTableCellIds: (
2179
+ createResultTableCellIds: (
2202
2180
  queryId: MaybeGetter<Id>,
2203
2181
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
2204
2182
  ) => {readonly current: Ids};
2205
2183
 
2206
2184
  /**
2207
- * The useResultRowCount hook returns a reactive object reflecting the number of
2208
- * Rows in a result Table, and registers a listener so that any changes will
2209
- * update `.current`.
2185
+ * The createResultRowCount function returns a reactive object reflecting the
2186
+ * number of Rows in a result Table, and registers a listener so that any
2187
+ * changes will update `.current`.
2210
2188
  * @param queryId The Id of the Query (or a getter returning it).
2211
2189
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2212
2190
  * Id.
2213
2191
  * @returns A reactive object with a `current` number property.
2214
- * @category Hook
2192
+ * @category Getter
2215
2193
  * @since v8.1.0
2216
2194
  */
2217
- useResultRowCount: (
2195
+ createResultRowCount: (
2218
2196
  queryId: MaybeGetter<Id>,
2219
2197
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
2220
2198
  ) => {readonly current: number};
2221
2199
 
2222
2200
  /**
2223
- * The useResultRowIds hook returns a reactive object reflecting the Ids of the
2224
- * Rows in a result Table, and registers a listener so that any changes will
2225
- * update `.current`.
2201
+ * The createResultRowIds function returns a reactive object reflecting the Ids
2202
+ * of the Rows in a result Table, and registers a listener so that any changes
2203
+ * will update `.current`.
2226
2204
  * @param queryId The Id of the Query (or a getter returning it).
2227
2205
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2228
2206
  * Id.
2229
2207
  * @returns A reactive object with a `current` Ids property.
2230
- * @category Hook
2208
+ * @category Getter
2231
2209
  * @since v8.1.0
2232
2210
  */
2233
- useResultRowIds: (
2211
+ createResultRowIds: (
2234
2212
  queryId: MaybeGetter<Id>,
2235
2213
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
2236
2214
  ) => {readonly current: Ids};
2237
2215
 
2238
2216
  /**
2239
- * The useResultSortedRowIds hook returns a reactive object reflecting the
2240
- * sorted Row Ids in a result Table, and registers a listener so that any
2217
+ * The createResultSortedRowIds function returns a reactive object reflecting
2218
+ * the sorted Row Ids in a result Table, and registers a listener so that any
2241
2219
  * changes will update `.current`.
2242
2220
  * @param queryId The Id of the Query (or a getter returning it).
2243
2221
  * @param cellId The Id of the Cell to sort by (or a getter returning it).
@@ -2247,10 +2225,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2247
2225
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2248
2226
  * Id.
2249
2227
  * @returns A reactive object with a `current` Ids property.
2250
- * @category Hook
2228
+ * @category Getter
2251
2229
  * @since v8.1.0
2252
2230
  */
2253
- useResultSortedRowIds: (
2231
+ createResultSortedRowIds: (
2254
2232
  queryId: MaybeGetter<Id>,
2255
2233
  cellId?: MaybeGetter<Id | undefined>,
2256
2234
  descending?: MaybeGetter<boolean>,
@@ -2260,44 +2238,44 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2260
2238
  ) => {readonly current: Ids};
2261
2239
 
2262
2240
  /**
2263
- * The useResultRow hook returns a reactive object reflecting a result Row in a
2264
- * result Table, and registers a listener so that any changes will update
2265
- * `.current`.
2241
+ * The createResultRow function returns a reactive object reflecting a result
2242
+ * Row in a result Table, and registers a listener so that any changes will
2243
+ * update `.current`.
2266
2244
  * @param queryId The Id of the Query (or a getter returning it).
2267
2245
  * @param rowId The Id of the Row (or a getter returning it).
2268
2246
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2269
2247
  * Id.
2270
2248
  * @returns A reactive object with a `current` Row property.
2271
- * @category Hook
2249
+ * @category Getter
2272
2250
  * @since v8.1.0
2273
2251
  */
2274
- useResultRow: (
2252
+ createResultRow: (
2275
2253
  queryId: MaybeGetter<Id>,
2276
2254
  rowId: MaybeGetter<Id>,
2277
2255
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
2278
2256
  ) => {readonly current: ResultRow};
2279
2257
 
2280
2258
  /**
2281
- * The useResultCellIds hook returns a reactive object reflecting the Ids of the
2282
- * Cells in a result Row, and registers a listener so that any changes will
2283
- * update `.current`.
2259
+ * The createResultCellIds function returns a reactive object reflecting the Ids
2260
+ * of the Cells in a result Row, and registers a listener so that any changes
2261
+ * will update `.current`.
2284
2262
  * @param queryId The Id of the Query (or a getter returning it).
2285
2263
  * @param rowId The Id of the Row (or a getter returning it).
2286
2264
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2287
2265
  * Id.
2288
2266
  * @returns A reactive object with a `current` Ids property.
2289
- * @category Hook
2267
+ * @category Getter
2290
2268
  * @since v8.1.0
2291
2269
  */
2292
- useResultCellIds: (
2270
+ createResultCellIds: (
2293
2271
  queryId: MaybeGetter<Id>,
2294
2272
  rowId: MaybeGetter<Id>,
2295
2273
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
2296
2274
  ) => {readonly current: Ids};
2297
2275
 
2298
2276
  /**
2299
- * The useResultCell hook returns a reactive object reflecting the value of a
2300
- * Cell in a result Row, and registers a listener so that any changes will
2277
+ * The createResultCell function returns a reactive object reflecting the value
2278
+ * of a Cell in a result Row, and registers a listener so that any changes will
2301
2279
  * update `.current`.
2302
2280
  * @param queryId The Id of the Query (or a getter returning it).
2303
2281
  * @param rowId The Id of the Row (or a getter returning it).
@@ -2305,10 +2283,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2305
2283
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2306
2284
  * Id.
2307
2285
  * @returns A reactive object with a `current` Cell | undefined property.
2308
- * @category Hook
2286
+ * @category Getter
2309
2287
  * @since v8.1.0
2310
2288
  */
2311
- useResultCell: (
2289
+ createResultCell: (
2312
2290
  queryId: MaybeGetter<Id>,
2313
2291
  rowId: MaybeGetter<Id>,
2314
2292
  cellId: MaybeGetter<Id>,
@@ -2316,44 +2294,44 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2316
2294
  ) => {readonly current: ResultCell | undefined};
2317
2295
 
2318
2296
  /**
2319
- * The useRelationships hook returns the default Relationships object from the
2320
- * current Provider context (or a named one if an Id is provided).
2297
+ * The getRelationships function returns the default Relationships object from
2298
+ * the current Provider context (or a named one if an Id is provided).
2321
2299
  * @param id An optional Id of a named Relationships object in the Provider
2322
2300
  * context.
2323
2301
  * @returns The Relationships object, or `undefined` if not found.
2324
- * @category Hook
2302
+ * @category Getter
2325
2303
  * @since v8.1.0
2326
2304
  */
2327
- useRelationships: (id?: Id) => Relationships<Schemas> | undefined;
2305
+ getRelationships: (id?: Id) => Relationships<Schemas> | undefined;
2328
2306
 
2329
2307
  /**
2330
- * The useRelationshipsOrRelationshipsById hook is used to get a reference to a
2308
+ * The resolveRelationships function is used to get a reference to a
2331
2309
  * Relationships object from a Provider context, or have it passed directly.
2332
2310
  * @param relationshipsOrRelationshipsId The Relationships object, its Id, or a
2333
2311
  * getter returning either.
2334
2312
  * @returns A getter function returning the Relationships object, or
2335
2313
  * `undefined`.
2336
- * @category Hook
2314
+ * @category Getter
2337
2315
  * @since v8.1.0
2338
2316
  */
2339
- useRelationshipsOrRelationshipsById: (
2317
+ resolveRelationships: (
2340
2318
  relationshipsOrRelationshipsId?: MaybeGetter<
2341
2319
  RelationshipsOrRelationshipsId<Schemas> | undefined
2342
2320
  >,
2343
2321
  ) => () => Relationships<Schemas> | undefined;
2344
2322
 
2345
2323
  /**
2346
- * The useRelationshipsStoreTableIds hook returns the Store, local table Id, and
2347
- * remote table Id for a given Relationships object and relationship Id.
2324
+ * The getRelationshipsStoreTableIds function returns the Store, local table Id,
2325
+ * and remote table Id for a given Relationships object and relationship Id.
2348
2326
  * @param relationshipsOrId The Relationships object, its Id, or a getter
2349
2327
  * returning either.
2350
2328
  * @param relationshipId The Id of the relationship, or a getter returning it.
2351
2329
  * @returns An object with `store`, `localTableId`, and `remoteTableId` getter
2352
2330
  * properties.
2353
- * @category Hook
2331
+ * @category Getter
2354
2332
  * @since v8.1.0
2355
2333
  */
2356
- useRelationshipsStoreTableIds: (
2334
+ getRelationshipsStoreTableIds: (
2357
2335
  relationshipsOrId: MaybeGetter<
2358
2336
  RelationshipsOrRelationshipsId<Schemas> | undefined
2359
2337
  >,
@@ -2365,221 +2343,221 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2365
2343
  };
2366
2344
 
2367
2345
  /**
2368
- * The useRelationshipsIds hook returns a reactive object with the Ids of all
2369
- * Relationships objects registered in the current Provider context.
2346
+ * The createRelationshipsIds function returns a reactive object with the Ids of
2347
+ * all Relationships objects registered in the current Provider context.
2370
2348
  * @returns A reactive object with a `current` Ids property.
2371
- * @category Hook
2349
+ * @category Getter
2372
2350
  * @since v8.1.0
2373
2351
  */
2374
- useRelationshipsIds: () => {readonly current: Ids};
2352
+ createRelationshipsIds: () => {readonly current: Ids};
2375
2353
 
2376
2354
  /**
2377
- * The useRelationshipIds hook returns a reactive object reflecting the Ids of
2378
- * the Relationships in a Relationships object, and registers a listener so that
2379
- * any changes will update `.current`.
2355
+ * The createRelationshipIds function returns a reactive object reflecting the
2356
+ * Ids of the Relationships in a Relationships object, and registers a listener
2357
+ * so that any changes will update `.current`.
2380
2358
  * @param relationshipsOrRelationshipsId The Relationships object to use, or its
2381
2359
  * Id.
2382
2360
  * @returns A reactive object with a `current` Ids property.
2383
- * @category Hook
2361
+ * @category Getter
2384
2362
  * @since v8.1.0
2385
2363
  */
2386
- useRelationshipIds: (
2364
+ createRelationshipIds: (
2387
2365
  relationshipsOrRelationshipsId?: MaybeGetter<
2388
2366
  RelationshipsOrRelationshipsId<Schemas> | undefined
2389
2367
  >,
2390
2368
  ) => {readonly current: Ids};
2391
2369
 
2392
2370
  /**
2393
- * The useRemoteRowId hook returns a reactive object reflecting the remote Row
2394
- * Id for a given local Row in a Relationship, and registers a listener so that
2395
- * any changes will update `.current`.
2371
+ * The createRemoteRowId function returns a reactive object reflecting the
2372
+ * remote Row Id for a given local Row in a Relationship, and registers a
2373
+ * listener so that any changes will update `.current`.
2396
2374
  * @param relationshipId The Id of the Relationship (or a getter returning it).
2397
2375
  * @param localRowId The Id of the local Row (or a getter returning it).
2398
2376
  * @param relationshipsOrRelationshipsId The Relationships object to use (plain
2399
2377
  * or getter), or its Id.
2400
2378
  * @returns A reactive object with a `current` Id | undefined property.
2401
- * @category Hook
2379
+ * @category Getter
2402
2380
  * @since v8.1.0
2403
2381
  */
2404
- useRemoteRowId: (
2382
+ createRemoteRowId: (
2405
2383
  relationshipId: MaybeGetter<Id>,
2406
2384
  localRowId: MaybeGetter<Id>,
2407
2385
  relationshipsOrRelationshipsId?: RelationshipsOrRelationshipsId<Schemas>,
2408
2386
  ) => {readonly current: Id | undefined};
2409
2387
 
2410
2388
  /**
2411
- * The useLocalRowIds hook returns a reactive object reflecting the local Row
2412
- * Ids for a given remote Row in a Relationship, and registers a listener so
2389
+ * The createLocalRowIds function returns a reactive object reflecting the local
2390
+ * Row Ids for a given remote Row in a Relationship, and registers a listener so
2413
2391
  * that any changes will update `.current`.
2414
2392
  * @param relationshipId The Id of the Relationship (or a getter returning it).
2415
2393
  * @param remoteRowId The Id of the remote Row (or a getter returning it).
2416
2394
  * @param relationshipsOrRelationshipsId The Relationships object to use (plain
2417
2395
  * or getter), or its Id.
2418
2396
  * @returns A reactive object with a `current` Ids property.
2419
- * @category Hook
2397
+ * @category Getter
2420
2398
  * @since v8.1.0
2421
2399
  */
2422
- useLocalRowIds: (
2400
+ createLocalRowIds: (
2423
2401
  relationshipId: MaybeGetter<Id>,
2424
2402
  remoteRowId: MaybeGetter<Id>,
2425
2403
  relationshipsOrRelationshipsId?: RelationshipsOrRelationshipsId<Schemas>,
2426
2404
  ) => {readonly current: Ids};
2427
2405
 
2428
2406
  /**
2429
- * The useLinkedRowIds hook returns a reactive object reflecting the linked Row
2430
- * Ids in a Relationship, and registers a listener so that any changes will
2431
- * update `.current`.
2407
+ * The createLinkedRowIds function returns a reactive object reflecting the
2408
+ * linked Row Ids in a Relationship, and registers a listener so that any
2409
+ * changes will update `.current`.
2432
2410
  * @param relationshipId The Id of the Relationship (or a getter returning it).
2433
2411
  * @param firstRowId The Id of the first Row (or a getter returning it).
2434
2412
  * @param relationshipsOrRelationshipsId The Relationships object to use (plain
2435
2413
  * or getter), or its Id.
2436
2414
  * @returns A reactive object with a `current` Ids property.
2437
- * @category Hook
2415
+ * @category Getter
2438
2416
  * @since v8.1.0
2439
2417
  */
2440
- useLinkedRowIds: (
2418
+ createLinkedRowIds: (
2441
2419
  relationshipId: MaybeGetter<Id>,
2442
2420
  firstRowId: MaybeGetter<Id>,
2443
2421
  relationshipsOrRelationshipsId?: RelationshipsOrRelationshipsId<Schemas>,
2444
2422
  ) => {readonly current: Ids};
2445
2423
 
2446
2424
  /**
2447
- * The useCheckpoints hook returns the default Checkpoints object from the
2425
+ * The getCheckpoints function returns the default Checkpoints object from the
2448
2426
  * current Provider context (or a named one if an Id is provided).
2449
2427
  * @param id An optional Id of a named Checkpoints object in the Provider
2450
2428
  * context.
2451
2429
  * @returns The Checkpoints object, or `undefined` if not found.
2452
- * @category Hook
2430
+ * @category Getter
2453
2431
  * @since v8.1.0
2454
2432
  */
2455
- useCheckpoints: (id?: Id) => Checkpoints<Schemas> | undefined;
2433
+ getCheckpoints: (id?: Id) => Checkpoints<Schemas> | undefined;
2456
2434
 
2457
2435
  /**
2458
- * The useCheckpointsOrCheckpointsById hook is used to get a reference to a
2459
- * Checkpoints object from a Provider context, or have it passed directly.
2460
- * @param checkpointsOrCheckpointsId The Checkpoints object, its Id, or a
2461
- * getter returning either.
2436
+ * The resolveCheckpoints function is used to get a reference to a Checkpoints
2437
+ * object from a Provider context, or have it passed directly.
2438
+ * @param checkpointsOrCheckpointsId The Checkpoints object, its Id, or a getter
2439
+ * returning either.
2462
2440
  * @returns A getter function returning the Checkpoints object, or `undefined`.
2463
- * @category Hook
2441
+ * @category Getter
2464
2442
  * @since v8.1.0
2465
2443
  */
2466
- useCheckpointsOrCheckpointsById: (
2444
+ resolveCheckpoints: (
2467
2445
  checkpointsOrCheckpointsId?: MaybeGetter<
2468
2446
  CheckpointsOrCheckpointsId<Schemas> | undefined
2469
2447
  >,
2470
2448
  ) => () => Checkpoints<Schemas> | undefined;
2471
2449
 
2472
2450
  /**
2473
- * The useCheckpointsIds hook returns a reactive object with the Ids of all
2474
- * Checkpoints objects registered in the current Provider context.
2451
+ * The createCheckpointsIds function returns a reactive object with the Ids of
2452
+ * all Checkpoints objects registered in the current Provider context.
2475
2453
  * @returns A reactive object with a `current` Ids property.
2476
- * @category Hook
2454
+ * @category Getter
2477
2455
  * @since v8.1.0
2478
2456
  */
2479
- useCheckpointsIds: () => {readonly current: Ids};
2457
+ createCheckpointsIds: () => {readonly current: Ids};
2480
2458
 
2481
2459
  /**
2482
- * The useCheckpointIds hook returns a reactive object reflecting the
2460
+ * The createCheckpointIds function returns a reactive object reflecting the
2483
2461
  * CheckpointIds (backward, current, forward) in a Checkpoints object, and
2484
2462
  * registers a listener so that any changes will update `.current`.
2485
2463
  * @param checkpointsOrCheckpointsId The Checkpoints object to use (plain or
2486
2464
  * getter), or its Id.
2487
2465
  * @returns A reactive object with a `current` CheckpointIds property.
2488
- * @category Hook
2466
+ * @category Getter
2489
2467
  * @since v8.1.0
2490
2468
  */
2491
- useCheckpointIds: (
2469
+ createCheckpointIds: (
2492
2470
  checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId<Schemas>,
2493
2471
  ) => {readonly current: CheckpointIds};
2494
2472
 
2495
2473
  /**
2496
- * The useCheckpoint hook returns a reactive object reflecting the label of a
2497
- * checkpoint, and registers a listener so that any changes will update
2498
- * `.current`.
2474
+ * The createCheckpoint function returns a reactive object reflecting the label
2475
+ * of a checkpoint, and registers a listener so that any changes will
2476
+ * update `.current`.
2499
2477
  * @param checkpointId The Id of the checkpoint (or a getter returning it).
2500
2478
  * @param checkpointsOrCheckpointsId The Checkpoints object to use (plain or
2501
2479
  * getter), or its Id.
2502
2480
  * @returns A reactive object with a `current` string | undefined property.
2503
- * @category Hook
2481
+ * @category Getter
2504
2482
  * @since v8.1.0
2505
2483
  */
2506
- useCheckpoint: (
2484
+ createCheckpoint: (
2507
2485
  checkpointId: MaybeGetter<Id>,
2508
2486
  checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId<Schemas>,
2509
2487
  ) => {readonly current: string | undefined};
2510
2488
 
2511
2489
  /**
2512
- * The useGoBackwardCallback hook returns a callback function that, when called,
2513
- * moves the Checkpoints object backward to the previous checkpoint.
2490
+ * The createGoBackwardCallback function returns a callback function that, when
2491
+ * called, moves the Checkpoints object backward to the previous checkpoint.
2514
2492
  * @param checkpointsOrCheckpointsId The Checkpoints object to use, or its Id.
2515
2493
  * @returns A callback function.
2516
- * @category Hook
2494
+ * @category Callback
2517
2495
  * @since v8.1.0
2518
2496
  */
2519
- useGoBackwardCallback: (
2497
+ createGoBackwardCallback: (
2520
2498
  checkpointsOrCheckpointsId?: MaybeGetter<
2521
2499
  CheckpointsOrCheckpointsId<Schemas> | undefined
2522
2500
  >,
2523
2501
  ) => () => void;
2524
2502
 
2525
2503
  /**
2526
- * The useGoForwardCallback hook returns a callback function that, when called,
2527
- * moves the Checkpoints object forward to the next checkpoint.
2504
+ * The createGoForwardCallback function returns a callback function that, when
2505
+ * called, moves the Checkpoints object forward to the next checkpoint.
2528
2506
  * @param checkpointsOrCheckpointsId The Checkpoints object to use, or its Id.
2529
2507
  * @returns A callback function.
2530
- * @category Hook
2508
+ * @category Callback
2531
2509
  * @since v8.1.0
2532
2510
  */
2533
- useGoForwardCallback: (
2511
+ createGoForwardCallback: (
2534
2512
  checkpointsOrCheckpointsId?: MaybeGetter<
2535
2513
  CheckpointsOrCheckpointsId<Schemas> | undefined
2536
2514
  >,
2537
2515
  ) => () => void;
2538
2516
 
2539
2517
  /**
2540
- * The usePersister hook returns the default Persister from the current Provider
2541
- * context (or a named one if an Id is provided).
2518
+ * The getPersister function returns the default Persister from the current
2519
+ * Provider context (or a named one if an Id is provided).
2542
2520
  * @param id An optional Id of a named Persister in the Provider context.
2543
2521
  * @returns The Persister, or `undefined` if not found.
2544
- * @category Hook
2522
+ * @category Getter
2545
2523
  * @since v8.1.0
2546
2524
  */
2547
- usePersister: (id?: Id) => AnyPersister<Schemas> | undefined;
2525
+ getPersister: (id?: Id) => AnyPersister<Schemas> | undefined;
2548
2526
 
2549
2527
  /**
2550
- * The usePersisterOrPersisterById hook is used to get a reference to a
2551
- * Persister object from a Provider context, or have it passed directly.
2528
+ * The resolvePersister function is used to get a reference to a Persister
2529
+ * object from a Provider context, or have it passed directly.
2552
2530
  * @param persisterOrPersisterId The Persister object, its Id, or a getter
2553
2531
  * returning either.
2554
2532
  * @returns A getter function returning the Persister object, or `undefined`.
2555
- * @category Hook
2533
+ * @category Getter
2556
2534
  * @since v8.1.0
2557
2535
  */
2558
- usePersisterOrPersisterById: (
2536
+ resolvePersister: (
2559
2537
  persisterOrPersisterId?: MaybeGetter<
2560
2538
  PersisterOrPersisterId<Schemas> | undefined
2561
2539
  >,
2562
2540
  ) => () => AnyPersister<Schemas> | undefined;
2563
2541
 
2564
2542
  /**
2565
- * The usePersisterIds hook returns a reactive object with the Ids of all
2543
+ * The createPersisterIds function returns a reactive object with the Ids of all
2566
2544
  * Persisters registered in the current Provider context.
2567
2545
  * @returns A reactive object with a `current` Ids property.
2568
- * @category Hook
2546
+ * @category Getter
2569
2547
  * @since v8.1.0
2570
2548
  */
2571
- usePersisterIds: () => {readonly current: Ids};
2549
+ createPersisterIds: () => {readonly current: Ids};
2572
2550
 
2573
2551
  /**
2574
- * The usePersisterStatus hook returns a reactive object reflecting the status
2575
- * of a Persister, and registers a listener so that any changes will update
2576
- * `.current`.
2552
+ * The createPersisterStatus function returns a reactive object reflecting the
2553
+ * status of a Persister, and registers a listener so that any changes will
2554
+ * update `.current`.
2577
2555
  * @param persisterOrPersisterId The Persister to use, or its Id.
2578
2556
  * @returns A reactive object with a `current` Status property.
2579
- * @category Hook
2557
+ * @category Getter
2580
2558
  * @since v8.1.0
2581
2559
  */
2582
- usePersisterStatus: (
2560
+ createPersisterStatus: (
2583
2561
  persisterOrPersisterId?: MaybeGetter<
2584
2562
  PersisterOrPersisterId<Schemas> | undefined
2585
2563
  >,
@@ -2588,121 +2566,116 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2588
2566
  };
2589
2567
 
2590
2568
  /**
2591
- * The useSynchronizer hook returns the default Synchronizer from the current
2592
- * Provider context (or a named one if an Id is provided).
2569
+ * The getSynchronizer function returns the default Synchronizer from the
2570
+ * current Provider context (or a named one if an Id is provided).
2593
2571
  * @param id An optional Id of a named Synchronizer in the Provider context.
2594
2572
  * @returns The Synchronizer, or `undefined` if not found.
2595
- * @category Hook
2573
+ * @category Getter
2596
2574
  * @since v8.1.0
2597
2575
  */
2598
- useSynchronizer: (id?: Id) => Synchronizer<Schemas> | undefined;
2576
+ getSynchronizer: (id?: Id) => Synchronizer<Schemas> | undefined;
2599
2577
 
2600
2578
  /**
2601
- * The useSynchronizerOrSynchronizerById hook is used to get a reference to a
2602
- * Synchronizer object from a Provider context, or have it passed directly.
2579
+ * The resolveSynchronizer function is used to get a reference to a Synchronizer
2580
+ * object from a Provider context, or have it passed directly.
2603
2581
  * @param synchronizerOrSynchronizerId The Synchronizer object, its Id, or a
2604
2582
  * getter returning either.
2605
2583
  * @returns A getter function returning the Synchronizer object, or `undefined`.
2606
- * @category Hook
2584
+ * @category Getter
2607
2585
  * @since v8.1.0
2608
2586
  */
2609
- useSynchronizerOrSynchronizerById: (
2587
+ resolveSynchronizer: (
2610
2588
  synchronizerOrSynchronizerId?: MaybeGetter<
2611
2589
  SynchronizerOrSynchronizerId<Schemas> | undefined
2612
2590
  >,
2613
2591
  ) => () => Synchronizer<Schemas> | undefined;
2614
2592
 
2615
2593
  /**
2616
- * The useSynchronizerIds hook returns a reactive object with the Ids of all
2617
- * Synchronizers registered in the current Provider context.
2594
+ * The createSynchronizerIds function returns a reactive object with the Ids of
2595
+ * all Synchronizers registered in the current Provider context.
2618
2596
  * @returns A reactive object with a `current` Ids property.
2619
- * @category Hook
2597
+ * @category Getter
2620
2598
  * @since v8.1.0
2621
2599
  */
2622
- useSynchronizerIds: () => {readonly current: Ids};
2600
+ createSynchronizerIds: () => {readonly current: Ids};
2623
2601
 
2624
2602
  /**
2625
- * The useSynchronizerStatus hook returns a reactive object reflecting the
2626
- * status of a Synchronizer, and registers a listener so that any changes will
2627
- * update `.current`.
2603
+ * The createSynchronizerStatus function returns a reactive object reflecting
2604
+ * the status of a Synchronizer, and registers a listener so that any changes
2605
+ * will update `.current`.
2628
2606
  * @param synchronizerOrSynchronizerId The Synchronizer to use, or its Id.
2629
2607
  * @returns A reactive object with a `current` Status property.
2630
- * @category Hook
2608
+ * @category Getter
2631
2609
  * @since v8.1.0
2632
2610
  */
2633
- useSynchronizerStatus: (
2611
+ createSynchronizerStatus: (
2634
2612
  synchronizerOrSynchronizerId?: MaybeGetter<
2635
2613
  SynchronizerOrSynchronizerId<Schemas> | undefined
2636
2614
  >,
2637
2615
  ) => {readonly current: Status};
2638
2616
 
2639
2617
  /**
2640
- * The useHasTablesListener hook registers a listener that is
2641
- * called whenever any Tables are added to or removed from the
2642
- * Store. The listener is tied to the component's `$effect`
2643
- * lifecycle and is removed when the component unmounts.
2644
- * @param listener The function to call when table presence
2645
- * changes.
2646
- * @param mutator An optional boolean indicating the listener
2647
- * mutates Store data.
2618
+ * The onHasTables function registers a listener that is called whenever any
2619
+ * Tables are added to or removed from the Store. The listener is tied to the
2620
+ * component's `$effect` lifecycle and is removed when the component unmounts.
2621
+ * @param listener The function to call when table presence changes.
2622
+ * @param mutator An optional boolean indicating the listener mutates Store
2623
+ * data.
2648
2624
  * @param storeOrStoreId The Store to use, or its Id.
2649
- * @category Hook
2625
+ * @category Listener
2650
2626
  * @since v8.1.0
2651
2627
  */
2652
- useHasTablesListener: (
2628
+ onHasTables: (
2653
2629
  listener: HasTablesListener<Schemas>,
2654
2630
  mutator?: boolean,
2655
2631
  storeOrStoreId?: StoreOrStoreId<Schemas>,
2656
2632
  ) => void;
2657
2633
 
2658
2634
  /**
2659
- * The useTablesListener hook registers a listener that is
2660
- * called whenever tabular data in the Store changes.
2635
+ * The onTables function registers a listener that is called whenever tabular
2636
+ * data in the Store changes.
2661
2637
  * @param listener The function to call when Tables change.
2662
- * @param mutator An optional boolean indicating the listener
2663
- * mutates Store data.
2638
+ * @param mutator An optional boolean indicating the listener mutates Store
2639
+ * data.
2664
2640
  * @param storeOrStoreId The Store to use, or its Id.
2665
- * @category Hook
2641
+ * @category Listener
2666
2642
  * @since v8.1.0
2667
2643
  */
2668
- useTablesListener: (
2644
+ onTables: (
2669
2645
  listener: TablesListener<Schemas>,
2670
2646
  mutator?: boolean,
2671
2647
  storeOrStoreId?: StoreOrStoreId<Schemas>,
2672
2648
  ) => void;
2673
2649
 
2674
2650
  /**
2675
- * The useTableIdsListener hook registers a listener that is
2676
- * called whenever the set of Table Ids in the Store changes.
2651
+ * The onTableIds function registers a listener that is called whenever the set
2652
+ * of Table Ids in the Store changes.
2677
2653
  * @param listener The function to call when Table Ids change.
2678
- * @param mutator An optional boolean indicating the listener
2679
- * mutates Store data.
2654
+ * @param mutator An optional boolean indicating the listener mutates Store
2655
+ * data.
2680
2656
  * @param storeOrStoreId The Store to use, or its Id.
2681
- * @category Hook
2657
+ * @category Listener
2682
2658
  * @since v8.1.0
2683
2659
  */
2684
- useTableIdsListener: (
2660
+ onTableIds: (
2685
2661
  listener: TableIdsListener<Schemas>,
2686
2662
  mutator?: boolean,
2687
2663
  storeOrStoreId?: StoreOrStoreId<Schemas>,
2688
2664
  ) => void;
2689
2665
 
2690
2666
  /**
2691
- * The useHasTableListener hook registers a listener that is
2692
- * called whenever a specified Table is added to or removed
2693
- * from the Store.
2694
- * @param tableId The Id of the Table to listen to, or `null`
2695
- * to listen to any Table.
2667
+ * The onHasTable function registers a listener that is called whenever a
2668
+ * specified Table is added to or removed from the Store.
2669
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
2670
+ * Table.
2696
2671
  * @param listener The function to call when the Table changes.
2697
- * @param mutator An optional boolean indicating the listener
2698
- * mutates Store data.
2672
+ * @param mutator An optional boolean indicating the listener mutates Store
2673
+ * data.
2699
2674
  * @param storeOrStoreId The Store to use, or its Id.
2700
- * @category Hook
2675
+ * @category Listener
2701
2676
  * @since v8.1.0
2702
2677
  */
2703
- useHasTableListener: <
2704
- TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2705
- >(
2678
+ onHasTable: <TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null>(
2706
2679
  tableId: MaybeGetter<TableIdOrNull>,
2707
2680
  listener: HasTableListener<Schemas, TableIdOrNull>,
2708
2681
  mutator?: boolean,
@@ -2710,20 +2683,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2710
2683
  ) => void;
2711
2684
 
2712
2685
  /**
2713
- * The useTableListener hook registers a listener that is
2714
- * called whenever data in a specified Table changes.
2715
- * @param tableId The Id of the Table to listen to, or `null`
2716
- * to listen to any Table.
2686
+ * The onTable function registers a listener that is called whenever data in a
2687
+ * specified Table changes.
2688
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
2689
+ * Table.
2717
2690
  * @param listener The function to call when the Table changes.
2718
- * @param mutator An optional boolean indicating the listener
2719
- * mutates Store data.
2691
+ * @param mutator An optional boolean indicating the listener mutates Store
2692
+ * data.
2720
2693
  * @param storeOrStoreId The Store to use, or its Id.
2721
- * @category Hook
2694
+ * @category Listener
2722
2695
  * @since v8.1.0
2723
2696
  */
2724
- useTableListener: <
2725
- TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2726
- >(
2697
+ onTable: <TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null>(
2727
2698
  tableId: MaybeGetter<TableIdOrNull>,
2728
2699
  listener: TableListener<Schemas, TableIdOrNull>,
2729
2700
  mutator?: boolean,
@@ -2731,20 +2702,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2731
2702
  ) => void;
2732
2703
 
2733
2704
  /**
2734
- * The useTableCellIdsListener hook registers a listener that
2735
- * is called whenever the Cell Ids used across a Table change.
2736
- * @param tableId The Id of the Table to listen to, or `null`
2737
- * to listen to any Table.
2705
+ * The onTableCellIds function registers a listener that is called whenever the
2706
+ * Cell Ids used across a Table change.
2707
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
2708
+ * Table.
2738
2709
  * @param listener The function to call when Cell Ids change.
2739
- * @param mutator An optional boolean indicating the listener
2740
- * mutates Store data.
2710
+ * @param mutator An optional boolean indicating the listener mutates Store
2711
+ * data.
2741
2712
  * @param storeOrStoreId The Store to use, or its Id.
2742
- * @category Hook
2713
+ * @category Listener
2743
2714
  * @since v8.1.0
2744
2715
  */
2745
- useTableCellIdsListener: <
2746
- TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2747
- >(
2716
+ onTableCellIds: <TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null>(
2748
2717
  tableId: MaybeGetter<TableIdOrNull>,
2749
2718
  listener: TableCellIdsListener<Schemas, TableIdOrNull>,
2750
2719
  mutator?: boolean,
@@ -2752,22 +2721,20 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2752
2721
  ) => void;
2753
2722
 
2754
2723
  /**
2755
- * The useHasTableCellListener hook registers a listener that
2756
- * is called whenever a specified Cell Id is added to or
2757
- * removed from across a Table.
2758
- * @param tableId The Id of the Table to listen to, or `null`
2759
- * to listen to any Table.
2760
- * @param cellId The Id of the Cell to listen to, or `null`
2761
- * to listen to any Cell Id.
2762
- * @param listener The function to call when the Cell Id
2763
- * changes.
2764
- * @param mutator An optional boolean indicating the listener
2765
- * mutates Store data.
2724
+ * The onHasTableCell function registers a listener that is called whenever a
2725
+ * specified Cell Id is added to or removed from across a Table.
2726
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
2727
+ * Table.
2728
+ * @param cellId The Id of the Cell to listen to, or `null` to listen to any
2729
+ * Cell Id.
2730
+ * @param listener The function to call when the Cell Id changes.
2731
+ * @param mutator An optional boolean indicating the listener mutates Store
2732
+ * data.
2766
2733
  * @param storeOrStoreId The Store to use, or its Id.
2767
- * @category Hook
2734
+ * @category Listener
2768
2735
  * @since v8.1.0
2769
2736
  */
2770
- useHasTableCellListener: <
2737
+ onHasTableCell: <
2771
2738
  TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2772
2739
  CellIdOrNull extends
2773
2740
  | (TableIdOrNull extends TableIdFromSchema<Schemas[0]>
@@ -2783,21 +2750,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2783
2750
  ) => void;
2784
2751
 
2785
2752
  /**
2786
- * The useRowCountListener hook registers a listener that is
2787
- * called whenever the count of Rows in a Table changes.
2788
- * @param tableId The Id of the Table to listen to, or `null`
2789
- * to listen to any Table.
2790
- * @param listener The function to call when the Row count
2791
- * changes.
2792
- * @param mutator An optional boolean indicating the listener
2793
- * mutates Store data.
2753
+ * The onRowCount function registers a listener that is called whenever the
2754
+ * count of Rows in a Table changes.
2755
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
2756
+ * Table.
2757
+ * @param listener The function to call when the Row count changes.
2758
+ * @param mutator An optional boolean indicating the listener mutates Store
2759
+ * data.
2794
2760
  * @param storeOrStoreId The Store to use, or its Id.
2795
- * @category Hook
2761
+ * @category Listener
2796
2762
  * @since v8.1.0
2797
2763
  */
2798
- useRowCountListener: <
2799
- TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2800
- >(
2764
+ onRowCount: <TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null>(
2801
2765
  tableId: MaybeGetter<TableIdOrNull>,
2802
2766
  listener: RowCountListener<Schemas, TableIdOrNull>,
2803
2767
  mutator?: boolean,
@@ -2805,20 +2769,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2805
2769
  ) => void;
2806
2770
 
2807
2771
  /**
2808
- * The useRowIdsListener hook registers a listener that is
2809
- * called whenever the Row Ids in a Table change.
2810
- * @param tableId The Id of the Table to listen to, or `null`
2811
- * to listen to any Table.
2772
+ * The onRowIds function registers a listener that is called whenever the Row
2773
+ * Ids in a Table change.
2774
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
2775
+ * Table.
2812
2776
  * @param listener The function to call when Row Ids change.
2813
- * @param mutator An optional boolean indicating the listener
2814
- * mutates Store data.
2777
+ * @param mutator An optional boolean indicating the listener mutates Store
2778
+ * data.
2815
2779
  * @param storeOrStoreId The Store to use, or its Id.
2816
- * @category Hook
2780
+ * @category Listener
2817
2781
  * @since v8.1.0
2818
2782
  */
2819
- useRowIdsListener: <
2820
- TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2821
- >(
2783
+ onRowIds: <TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null>(
2822
2784
  tableId: MaybeGetter<TableIdOrNull>,
2823
2785
  listener: RowIdsListener<Schemas, TableIdOrNull>,
2824
2786
  mutator?: boolean,
@@ -2826,24 +2788,22 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2826
2788
  ) => void;
2827
2789
 
2828
2790
  /**
2829
- * The useSortedRowIdsListener hook registers a listener that
2830
- * is called whenever the sorted Row Ids in a Table change.
2791
+ * The onSortedRowIds function registers a listener that is called whenever the
2792
+ * sorted Row Ids in a Table change.
2831
2793
  * @param tableId The Id of the Table to listen to.
2832
- * @param cellId The Id of the Cell to sort by, or `undefined`
2833
- * for default order.
2794
+ * @param cellId The Id of the Cell to sort by, or `undefined` for default
2795
+ * order.
2834
2796
  * @param descending Whether to sort descending.
2835
2797
  * @param offset The index of the first Row to include.
2836
- * @param limit The maximum number of Rows to include, or
2837
- * `undefined` for all.
2838
- * @param listener The function to call when sorted Row Ids
2839
- * change.
2840
- * @param mutator An optional boolean indicating the listener
2841
- * mutates Store data.
2798
+ * @param limit The maximum number of Rows to include, or `undefined` for all.
2799
+ * @param listener The function to call when sorted Row Ids change.
2800
+ * @param mutator An optional boolean indicating the listener mutates Store
2801
+ * data.
2842
2802
  * @param storeOrStoreId The Store to use, or its Id.
2843
- * @category Hook
2803
+ * @category Listener
2844
2804
  * @since v8.1.0
2845
2805
  */
2846
- useSortedRowIdsListener: <
2806
+ onSortedRowIds: <
2847
2807
  TableId extends TableIdFromSchema<Schemas[0]>,
2848
2808
  CellIdOrUndefined extends CellIdFromSchema<Schemas[0], TableId> | undefined,
2849
2809
  >(
@@ -2858,21 +2818,19 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2858
2818
  ) => void;
2859
2819
 
2860
2820
  /**
2861
- * The useHasRowListener hook registers a listener that is
2862
- * called whenever a specified Row is added to or removed from
2863
- * a Table.
2864
- * @param tableId The Id of the Table to listen to, or `null`
2865
- * to listen to any Table.
2866
- * @param rowId The Id of the Row to listen to, or `null` to
2867
- * listen to any Row.
2821
+ * The onHasRow function registers a listener that is called whenever a
2822
+ * specified Row is added to or removed from a Table.
2823
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
2824
+ * Table.
2825
+ * @param rowId The Id of the Row to listen to, or `null` to listen to any Row.
2868
2826
  * @param listener The function to call when the Row changes.
2869
- * @param mutator An optional boolean indicating the listener
2870
- * mutates Store data.
2827
+ * @param mutator An optional boolean indicating the listener mutates Store
2828
+ * data.
2871
2829
  * @param storeOrStoreId The Store to use, or its Id.
2872
- * @category Hook
2830
+ * @category Listener
2873
2831
  * @since v8.1.0
2874
2832
  */
2875
- useHasRowListener: <
2833
+ onHasRow: <
2876
2834
  TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2877
2835
  RowIdOrNull extends IdOrNull,
2878
2836
  >(
@@ -2884,20 +2842,19 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2884
2842
  ) => void;
2885
2843
 
2886
2844
  /**
2887
- * The useRowListener hook registers a listener that is called
2888
- * whenever data in a specified Row changes.
2889
- * @param tableId The Id of the Table to listen to, or `null`
2890
- * to listen to any Table.
2891
- * @param rowId The Id of the Row to listen to, or `null` to
2892
- * listen to any Row.
2845
+ * The onRow function registers a listener that is called whenever data in a
2846
+ * specified Row changes.
2847
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
2848
+ * Table.
2849
+ * @param rowId The Id of the Row to listen to, or `null` to listen to any Row.
2893
2850
  * @param listener The function to call when the Row changes.
2894
- * @param mutator An optional boolean indicating the listener
2895
- * mutates Store data.
2851
+ * @param mutator An optional boolean indicating the listener mutates Store
2852
+ * data.
2896
2853
  * @param storeOrStoreId The Store to use, or its Id.
2897
- * @category Hook
2854
+ * @category Listener
2898
2855
  * @since v8.1.0
2899
2856
  */
2900
- useRowListener: <
2857
+ onRow: <
2901
2858
  TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2902
2859
  RowIdOrNull extends IdOrNull,
2903
2860
  >(
@@ -2909,20 +2866,19 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2909
2866
  ) => void;
2910
2867
 
2911
2868
  /**
2912
- * The useCellIdsListener hook registers a listener that is
2913
- * called whenever the Cell Ids in a Row change.
2914
- * @param tableId The Id of the Table to listen to, or `null`
2915
- * to listen to any Table.
2916
- * @param rowId The Id of the Row to listen to, or `null` to
2917
- * listen to any Row.
2869
+ * The onCellIds function registers a listener that is called whenever the Cell
2870
+ * Ids in a Row change.
2871
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
2872
+ * Table.
2873
+ * @param rowId The Id of the Row to listen to, or `null` to listen to any Row.
2918
2874
  * @param listener The function to call when Cell Ids change.
2919
- * @param mutator An optional boolean indicating the listener
2920
- * mutates Store data.
2875
+ * @param mutator An optional boolean indicating the listener mutates Store
2876
+ * data.
2921
2877
  * @param storeOrStoreId The Store to use, or its Id.
2922
- * @category Hook
2878
+ * @category Listener
2923
2879
  * @since v8.1.0
2924
2880
  */
2925
- useCellIdsListener: <
2881
+ onCellIds: <
2926
2882
  TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2927
2883
  RowIdOrNull extends IdOrNull,
2928
2884
  >(
@@ -2934,23 +2890,21 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2934
2890
  ) => void;
2935
2891
 
2936
2892
  /**
2937
- * The useHasCellListener hook registers a listener that is
2938
- * called whenever a specified Cell is added to or removed from
2939
- * a Row.
2940
- * @param tableId The Id of the Table to listen to, or `null`
2941
- * to listen to any Table.
2942
- * @param rowId The Id of the Row to listen to, or `null` to
2943
- * listen to any Row.
2944
- * @param cellId The Id of the Cell to listen to, or `null` to
2945
- * listen to any Cell.
2893
+ * The onHasCell function registers a listener that is called whenever a
2894
+ * specified Cell is added to or removed from a Row.
2895
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
2896
+ * Table.
2897
+ * @param rowId The Id of the Row to listen to, or `null` to listen to any Row.
2898
+ * @param cellId The Id of the Cell to listen to, or `null` to listen to any
2899
+ * Cell.
2946
2900
  * @param listener The function to call when the Cell changes.
2947
- * @param mutator An optional boolean indicating the listener
2948
- * mutates Store data.
2901
+ * @param mutator An optional boolean indicating the listener mutates Store
2902
+ * data.
2949
2903
  * @param storeOrStoreId The Store to use, or its Id.
2950
- * @category Hook
2904
+ * @category Listener
2951
2905
  * @since v8.1.0
2952
2906
  */
2953
- useHasCellListener: <
2907
+ onHasCell: <
2954
2908
  TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2955
2909
  RowIdOrNull extends IdOrNull,
2956
2910
  CellIdOrNull extends
@@ -2973,22 +2927,21 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2973
2927
  ) => void;
2974
2928
 
2975
2929
  /**
2976
- * The useCellListener hook registers a listener that is called
2977
- * whenever the value of a specified Cell changes.
2978
- * @param tableId The Id of the Table to listen to, or `null`
2979
- * to listen to any Table.
2980
- * @param rowId The Id of the Row to listen to, or `null` to
2981
- * listen to any Row.
2982
- * @param cellId The Id of the Cell to listen to, or `null` to
2983
- * listen to any Cell.
2930
+ * The onCell function registers a listener that is called whenever the value of
2931
+ * a specified Cell changes.
2932
+ * @param tableId The Id of the Table to listen to, or `null` to listen to any
2933
+ * Table.
2934
+ * @param rowId The Id of the Row to listen to, or `null` to listen to any Row.
2935
+ * @param cellId The Id of the Cell to listen to, or `null` to listen to any
2936
+ * Cell.
2984
2937
  * @param listener The function to call when the Cell changes.
2985
- * @param mutator An optional boolean indicating the listener
2986
- * mutates Store data.
2938
+ * @param mutator An optional boolean indicating the listener mutates Store
2939
+ * data.
2987
2940
  * @param storeOrStoreId The Store to use, or its Id.
2988
- * @category Hook
2941
+ * @category Listener
2989
2942
  * @since v8.1.0
2990
2943
  */
2991
- useCellListener: <
2944
+ onCell: <
2992
2945
  TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2993
2946
  RowIdOrNull extends IdOrNull,
2994
2947
  CellIdOrNull extends
@@ -3006,71 +2959,66 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3006
2959
  ) => void;
3007
2960
 
3008
2961
  /**
3009
- * The useHasValuesListener hook registers a listener that is
3010
- * called whenever any Values are added to or removed from the
3011
- * Store.
3012
- * @param listener The function to call when value presence
3013
- * changes.
3014
- * @param mutator An optional boolean indicating the listener
3015
- * mutates Store data.
2962
+ * The onHasValues function registers a listener that is called whenever any
2963
+ * Values are added to or removed from the Store.
2964
+ * @param listener The function to call when value presence changes.
2965
+ * @param mutator An optional boolean indicating the listener mutates Store
2966
+ * data.
3016
2967
  * @param storeOrStoreId The Store to use, or its Id.
3017
- * @category Hook
2968
+ * @category Listener
3018
2969
  * @since v8.1.0
3019
2970
  */
3020
- useHasValuesListener: (
2971
+ onHasValues: (
3021
2972
  listener: HasValuesListener<Schemas>,
3022
2973
  mutator?: boolean,
3023
2974
  storeOrStoreId?: StoreOrStoreId<Schemas>,
3024
2975
  ) => void;
3025
2976
 
3026
2977
  /**
3027
- * The useValuesListener hook registers a listener that is
3028
- * called whenever any Values in the Store change.
2978
+ * The onValues function registers a listener that is called whenever any Values
2979
+ * in the Store change.
3029
2980
  * @param listener The function to call when Values change.
3030
- * @param mutator An optional boolean indicating the listener
3031
- * mutates Store data.
2981
+ * @param mutator An optional boolean indicating the listener mutates Store
2982
+ * data.
3032
2983
  * @param storeOrStoreId The Store to use, or its Id.
3033
- * @category Hook
2984
+ * @category Listener
3034
2985
  * @since v8.1.0
3035
2986
  */
3036
- useValuesListener: (
2987
+ onValues: (
3037
2988
  listener: ValuesListener<Schemas>,
3038
2989
  mutator?: boolean,
3039
2990
  storeOrStoreId?: StoreOrStoreId<Schemas>,
3040
2991
  ) => void;
3041
2992
 
3042
2993
  /**
3043
- * The useValueIdsListener hook registers a listener that is
3044
- * called whenever the Value Ids in the Store change.
2994
+ * The onValueIds function registers a listener that is called whenever the
2995
+ * Value Ids in the Store change.
3045
2996
  * @param listener The function to call when Value Ids change.
3046
- * @param mutator An optional boolean indicating the listener
3047
- * mutates Store data.
2997
+ * @param mutator An optional boolean indicating the listener mutates Store
2998
+ * data.
3048
2999
  * @param storeOrStoreId The Store to use, or its Id.
3049
- * @category Hook
3000
+ * @category Listener
3050
3001
  * @since v8.1.0
3051
3002
  */
3052
- useValueIdsListener: (
3003
+ onValueIds: (
3053
3004
  listener: ValueIdsListener<Schemas>,
3054
3005
  mutator?: boolean,
3055
3006
  storeOrStoreId?: StoreOrStoreId<Schemas>,
3056
3007
  ) => void;
3057
3008
 
3058
3009
  /**
3059
- * The useHasValueListener hook registers a listener that is
3060
- * called whenever a specified Value is added to or removed
3061
- * from the Store.
3062
- * @param valueId The Id of the Value to listen to, or `null`
3063
- * to listen to any Value.
3010
+ * The onHasValue function registers a listener that is called whenever a
3011
+ * specified Value is added to or removed from the Store.
3012
+ * @param valueId The Id of the Value to listen to, or `null` to listen to any
3013
+ * Value.
3064
3014
  * @param listener The function to call when the Value changes.
3065
- * @param mutator An optional boolean indicating the listener
3066
- * mutates Store data.
3015
+ * @param mutator An optional boolean indicating the listener mutates Store
3016
+ * data.
3067
3017
  * @param storeOrStoreId The Store to use, or its Id.
3068
- * @category Hook
3018
+ * @category Listener
3069
3019
  * @since v8.1.0
3070
3020
  */
3071
- useHasValueListener: <
3072
- ValueIdOrNull extends ValueIdFromSchema<Schemas[1]> | null,
3073
- >(
3021
+ onHasValue: <ValueIdOrNull extends ValueIdFromSchema<Schemas[1]> | null>(
3074
3022
  valueId: MaybeGetter<ValueIdOrNull>,
3075
3023
  listener: HasValueListener<Schemas, ValueIdOrNull>,
3076
3024
  mutator?: boolean,
@@ -3078,20 +3026,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3078
3026
  ) => void;
3079
3027
 
3080
3028
  /**
3081
- * The useValueListener hook registers a listener that is
3082
- * called whenever the value of a specified Value changes.
3083
- * @param valueId The Id of the Value to listen to, or `null`
3084
- * to listen to any Value.
3029
+ * The onValue function registers a listener that is called whenever the value
3030
+ * of a specified Value changes.
3031
+ * @param valueId The Id of the Value to listen to, or `null` to listen to any
3032
+ * Value.
3085
3033
  * @param listener The function to call when the Value changes.
3086
- * @param mutator An optional boolean indicating the listener
3087
- * mutates Store data.
3034
+ * @param mutator An optional boolean indicating the listener mutates Store
3035
+ * data.
3088
3036
  * @param storeOrStoreId The Store to use, or its Id.
3089
- * @category Hook
3037
+ * @category Listener
3090
3038
  * @since v8.1.0
3091
3039
  */
3092
- useValueListener: <
3093
- ValueIdOrNull extends ValueIdFromSchema<Schemas[1]> | null,
3094
- >(
3040
+ onValue: <ValueIdOrNull extends ValueIdFromSchema<Schemas[1]> | null>(
3095
3041
  valueId: MaybeGetter<ValueIdOrNull>,
3096
3042
  listener: ValueListener<Schemas, ValueIdOrNull>,
3097
3043
  mutator?: boolean,
@@ -3099,94 +3045,89 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3099
3045
  ) => void;
3100
3046
 
3101
3047
  /**
3102
- * The useStartTransactionListener hook registers a listener
3103
- * that is called at the start of every Store transaction.
3048
+ * The onStartTransaction function registers a listener that is called at the
3049
+ * start of every Store transaction.
3104
3050
  * @param listener The function to call at transaction start.
3105
3051
  * @param storeOrStoreId The Store to use, or its Id.
3106
- * @category Hook
3052
+ * @category Listener
3107
3053
  * @since v8.1.0
3108
3054
  */
3109
- useStartTransactionListener: (
3055
+ onStartTransaction: (
3110
3056
  listener: TransactionListener<Schemas>,
3111
3057
  storeOrStoreId?: StoreOrStoreId<Schemas>,
3112
3058
  ) => void;
3113
3059
 
3114
3060
  /**
3115
- * The useWillFinishTransactionListener hook registers a
3116
- * listener called just before a Store transaction completes.
3061
+ * The onWillFinishTransaction function registers a listener called just before
3062
+ * a Store transaction completes.
3117
3063
  * @param listener The function to call before transaction end.
3118
3064
  * @param storeOrStoreId The Store to use, or its Id.
3119
- * @category Hook
3065
+ * @category Listener
3120
3066
  * @since v8.1.0
3121
3067
  */
3122
- useWillFinishTransactionListener: (
3068
+ onWillFinishTransaction: (
3123
3069
  listener: TransactionListener<Schemas>,
3124
3070
  storeOrStoreId?: StoreOrStoreId<Schemas>,
3125
3071
  ) => void;
3126
3072
 
3127
3073
  /**
3128
- * The useDidFinishTransactionListener hook registers a
3129
- * listener called just after a Store transaction completes.
3074
+ * The onDidFinishTransaction function registers a listener called just after a
3075
+ * Store transaction completes.
3130
3076
  * @param listener The function to call after transaction end.
3131
3077
  * @param storeOrStoreId The Store to use, or its Id.
3132
- * @category Hook
3078
+ * @category Listener
3133
3079
  * @since v8.1.0
3134
3080
  */
3135
- useDidFinishTransactionListener: (
3081
+ onDidFinishTransaction: (
3136
3082
  listener: TransactionListener<Schemas>,
3137
3083
  storeOrStoreId?: StoreOrStoreId<Schemas>,
3138
3084
  ) => void;
3139
3085
 
3140
3086
  /**
3141
- * The useMetricListener hook registers a listener that is
3142
- * called whenever a specified Metric value changes.
3143
- * @param metricId The Id of the Metric to listen to, or
3144
- * `null` to listen to any Metric.
3145
- * @param listener The function to call when the Metric
3146
- * changes.
3147
- * @param metricsOrMetricsId The Metrics object to use, or
3148
- * its Id.
3149
- * @category Hook
3087
+ * The onMetric function registers a listener that is called whenever a
3088
+ * specified Metric value changes.
3089
+ * @param metricId The Id of the Metric to listen to, or `null` to listen to any
3090
+ * Metric.
3091
+ * @param listener The function to call when the Metric changes.
3092
+ * @param metricsOrMetricsId The Metrics object to use, or its Id.
3093
+ * @category Listener
3150
3094
  * @since v8.1.0
3151
3095
  */
3152
- useMetricListener: (
3096
+ onMetric: (
3153
3097
  metricId: MaybeGetter<IdOrNull>,
3154
3098
  listener: MetricListener<Schemas>,
3155
3099
  metricsOrMetricsId?: MetricsOrMetricsId<Schemas>,
3156
3100
  ) => void;
3157
3101
 
3158
3102
  /**
3159
- * The useSliceIdsListener hook registers a listener that is
3160
- * called whenever the Slice Ids in an Index change.
3161
- * @param indexId The Id of the Index to listen to, or `null`
3162
- * to listen to any Index.
3103
+ * The onSliceIds function registers a listener that is called whenever the
3104
+ * Slice Ids in an Index change.
3105
+ * @param indexId The Id of the Index to listen to, or `null` to listen to any
3106
+ * Index.
3163
3107
  * @param listener The function to call when Slice Ids change.
3164
- * @param indexesOrIndexesId The Indexes object to use, or its
3165
- * Id.
3166
- * @category Hook
3108
+ * @param indexesOrIndexesId The Indexes object to use, or its Id.
3109
+ * @category Listener
3167
3110
  * @since v8.1.0
3168
3111
  */
3169
- useSliceIdsListener: (
3112
+ onSliceIds: (
3170
3113
  indexId: MaybeGetter<IdOrNull>,
3171
3114
  listener: SliceIdsListener<Schemas>,
3172
3115
  indexesOrIndexesId?: IndexesOrIndexesId<Schemas>,
3173
3116
  ) => void;
3174
3117
 
3175
3118
  /**
3176
- * The useSliceRowIdsListener hook registers a listener that
3177
- * is called whenever the Row Ids in a Slice change.
3178
- * @param indexId The Id of the Index to listen to, or `null`
3179
- * to listen to any Index.
3180
- * @param sliceId The Id of the Slice to listen to, or `null`
3181
- * to listen to any Slice.
3182
- * @param listener The function to call when Slice Row Ids
3183
- * change.
3184
- * @param indexesOrIndexesId The Indexes object to use, or its
3185
- * Id.
3186
- * @category Hook
3119
+ * The onSliceRowIds function registers a listener that is called whenever the
3120
+ * Row Ids in a Slice change.
3121
+ * @param indexId The Id of the Index to listen to, or `null` to listen to any
3122
+ * Index.
3123
+ * @param sliceId The Id of the Slice to listen to, or `null` to listen to any
3124
+ * Slice.
3125
+ * @param listener The function to call when Slice Row Ids change.
3126
+ * @param indexesOrIndexesId The Indexes object to use, or its Id.
3127
+ * @category Listener
3187
3128
  * @since v8.1.0
3188
3129
  */
3189
- useSliceRowIdsListener: (
3130
+ onSliceRowIds: (
3190
3131
  indexId: MaybeGetter<IdOrNull>,
3191
3132
  sliceId: MaybeGetter<IdOrNull>,
3192
3133
  listener: SliceRowIdsListener<Schemas>,
@@ -3194,21 +3135,19 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3194
3135
  ) => void;
3195
3136
 
3196
3137
  /**
3197
- * The useRemoteRowIdListener hook registers a listener that
3198
- * is called whenever the remote Row Id for a local Row
3199
- * changes.
3200
- * @param relationshipId The Id of the Relationship, or `null`
3201
- * to listen to any Relationship.
3202
- * @param localRowId The Id of the local Row, or `null` to
3203
- * listen to any local Row.
3204
- * @param listener The function to call when the remote Row Id
3205
- * changes.
3206
- * @param relationshipsOrRelationshipsId The Relationships
3207
- * object to use, or its Id.
3208
- * @category Hook
3138
+ * The onRemoteRowId function registers a listener that is called whenever the
3139
+ * remote Row Id for a local Row changes.
3140
+ * @param relationshipId The Id of the Relationship, or `null` to listen to any
3141
+ * Relationship.
3142
+ * @param localRowId The Id of the local Row, or `null` to listen to any local
3143
+ * Row.
3144
+ * @param listener The function to call when the remote Row Id changes.
3145
+ * @param relationshipsOrRelationshipsId The Relationships object to use, or its
3146
+ * Id.
3147
+ * @category Listener
3209
3148
  * @since v8.1.0
3210
3149
  */
3211
- useRemoteRowIdListener: (
3150
+ onRemoteRowId: (
3212
3151
  relationshipId: MaybeGetter<IdOrNull>,
3213
3152
  localRowId: MaybeGetter<IdOrNull>,
3214
3153
  listener: RemoteRowIdListener<Schemas>,
@@ -3216,21 +3155,19 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3216
3155
  ) => void;
3217
3156
 
3218
3157
  /**
3219
- * The useLocalRowIdsListener hook registers a listener that
3220
- * is called whenever the local Row Ids for a remote Row
3221
- * change.
3222
- * @param relationshipId The Id of the Relationship, or `null`
3223
- * to listen to any Relationship.
3224
- * @param remoteRowId The Id of the remote Row, or `null` to
3225
- * listen to any remote Row.
3226
- * @param listener The function to call when local Row Ids
3227
- * change.
3228
- * @param relationshipsOrRelationshipsId The Relationships
3229
- * object to use, or its Id.
3230
- * @category Hook
3158
+ * The onLocalRowIds function registers a listener that is called whenever the
3159
+ * local Row Ids for a remote Row change.
3160
+ * @param relationshipId The Id of the Relationship, or `null` to listen to any
3161
+ * Relationship.
3162
+ * @param remoteRowId The Id of the remote Row, or `null` to listen to any
3163
+ * remote Row.
3164
+ * @param listener The function to call when local Row Ids change.
3165
+ * @param relationshipsOrRelationshipsId The Relationships object to use, or its
3166
+ * Id.
3167
+ * @category Listener
3231
3168
  * @since v8.1.0
3232
3169
  */
3233
- useLocalRowIdsListener: (
3170
+ onLocalRowIds: (
3234
3171
  relationshipId: MaybeGetter<IdOrNull>,
3235
3172
  remoteRowId: MaybeGetter<IdOrNull>,
3236
3173
  listener: LocalRowIdsListener<Schemas>,
@@ -3238,19 +3175,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3238
3175
  ) => void;
3239
3176
 
3240
3177
  /**
3241
- * The useLinkedRowIdsListener hook registers a listener that
3242
- * is called whenever the linked Row Ids for a first Row
3243
- * change.
3178
+ * The onLinkedRowIds function registers a listener that is called whenever the
3179
+ * linked Row Ids for a first Row change.
3244
3180
  * @param relationshipId The Id of the Relationship.
3245
3181
  * @param firstRowId The Id of the first Row.
3246
- * @param listener The function to call when linked Row Ids
3247
- * change.
3248
- * @param relationshipsOrRelationshipsId The Relationships
3249
- * object to use, or its Id.
3250
- * @category Hook
3182
+ * @param listener The function to call when linked Row Ids change.
3183
+ * @param relationshipsOrRelationshipsId The Relationships object to use, or its
3184
+ * Id.
3185
+ * @category Listener
3251
3186
  * @since v8.1.0
3252
3187
  */
3253
- useLinkedRowIdsListener: (
3188
+ onLinkedRowIds: (
3254
3189
  relationshipId: MaybeGetter<Id>,
3255
3190
  firstRowId: MaybeGetter<Id>,
3256
3191
  listener: LinkedRowIdsListener<Schemas>,
@@ -3258,94 +3193,84 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3258
3193
  ) => void;
3259
3194
 
3260
3195
  /**
3261
- * The useResultTableListener hook registers a listener that
3262
- * is called whenever the result Table of a query changes.
3263
- * @param queryId The Id of the query to listen to, or `null`
3264
- * to listen to any query.
3265
- * @param listener The function to call when the result Table
3266
- * changes.
3267
- * @param queriesOrQueriesId The Queries object to use, or its
3268
- * Id.
3269
- * @category Hook
3196
+ * The onResultTable function registers a listener that is called whenever the
3197
+ * result Table of a query changes.
3198
+ * @param queryId The Id of the query to listen to, or `null` to listen to any
3199
+ * query.
3200
+ * @param listener The function to call when the result Table changes.
3201
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
3202
+ * @category Listener
3270
3203
  * @since v8.1.0
3271
3204
  */
3272
- useResultTableListener: (
3205
+ onResultTable: (
3273
3206
  queryId: MaybeGetter<IdOrNull>,
3274
3207
  listener: ResultTableListener<Schemas>,
3275
3208
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
3276
3209
  ) => void;
3277
3210
 
3278
3211
  /**
3279
- * The useResultTableCellIdsListener hook registers a listener
3280
- * that is called whenever the Cell Ids across a result Table
3281
- * change.
3282
- * @param queryId The Id of the query to listen to, or `null`
3283
- * to listen to any query.
3212
+ * The onResultTableCellIds function registers a listener that is called
3213
+ * whenever the Cell Ids across a result Table change.
3214
+ * @param queryId The Id of the query to listen to, or `null` to listen to any
3215
+ * query.
3284
3216
  * @param listener The function to call when Cell Ids change.
3285
- * @param queriesOrQueriesId The Queries object to use, or its
3286
- * Id.
3287
- * @category Hook
3217
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
3218
+ * @category Listener
3288
3219
  * @since v8.1.0
3289
3220
  */
3290
- useResultTableCellIdsListener: (
3221
+ onResultTableCellIds: (
3291
3222
  queryId: MaybeGetter<IdOrNull>,
3292
3223
  listener: ResultTableCellIdsListener<Schemas>,
3293
3224
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
3294
3225
  ) => void;
3295
3226
 
3296
3227
  /**
3297
- * The useResultRowCountListener hook registers a listener that
3298
- * is called whenever the count of result Rows changes.
3299
- * @param queryId The Id of the query to listen to, or `null`
3300
- * to listen to any query.
3228
+ * The onResultRowCount function registers a listener that is called whenever
3229
+ * the count of result Rows changes.
3230
+ * @param queryId The Id of the query to listen to, or `null` to listen to any
3231
+ * query.
3301
3232
  * @param listener The function to call when the count changes.
3302
- * @param queriesOrQueriesId The Queries object to use, or its
3303
- * Id.
3304
- * @category Hook
3233
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
3234
+ * @category Listener
3305
3235
  * @since v8.1.0
3306
3236
  */
3307
- useResultRowCountListener: (
3237
+ onResultRowCount: (
3308
3238
  queryId: MaybeGetter<IdOrNull>,
3309
3239
  listener: ResultRowCountListener<Schemas>,
3310
3240
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
3311
3241
  ) => void;
3312
3242
 
3313
3243
  /**
3314
- * The useResultRowIdsListener hook registers a listener that
3315
- * is called whenever the result Row Ids of a query change.
3316
- * @param queryId The Id of the query to listen to, or `null`
3317
- * to listen to any query.
3318
- * @param listener The function to call when result Row Ids
3319
- * change.
3320
- * @param queriesOrQueriesId The Queries object to use, or its
3321
- * Id.
3322
- * @category Hook
3244
+ * The onResultRowIds function registers a listener that is called whenever the
3245
+ * result Row Ids of a query change.
3246
+ * @param queryId The Id of the query to listen to, or `null` to listen to any
3247
+ * query.
3248
+ * @param listener The function to call when result Row Ids change.
3249
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
3250
+ * @category Listener
3323
3251
  * @since v8.1.0
3324
3252
  */
3325
- useResultRowIdsListener: (
3253
+ onResultRowIds: (
3326
3254
  queryId: MaybeGetter<IdOrNull>,
3327
3255
  listener: ResultRowIdsListener<Schemas>,
3328
3256
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
3329
3257
  ) => void;
3330
3258
 
3331
3259
  /**
3332
- * The useResultSortedRowIdsListener hook registers a listener
3333
- * that is called whenever the sorted result Row Ids change.
3260
+ * The onResultSortedRowIds function registers a listener that is called
3261
+ * whenever the sorted result Row Ids change.
3334
3262
  * @param queryId The Id of the query to listen to.
3335
- * @param cellId The Id of the Cell to sort by, or `undefined`
3336
- * for default order.
3263
+ * @param cellId The Id of the Cell to sort by, or `undefined` for default
3264
+ * order.
3337
3265
  * @param descending Whether to sort descending.
3338
3266
  * @param offset The index of the first Row to include.
3339
- * @param limit The maximum number of Rows to include, or
3340
- * `undefined` for all.
3341
- * @param listener The function to call when sorted Row Ids
3342
- * change.
3343
- * @param queriesOrQueriesId The Queries object to use, or its
3344
- * Id.
3345
- * @category Hook
3267
+ * @param limit The maximum number of Rows to include, or `undefined` for all.
3268
+ * @param listener The function to call when sorted Row Ids change.
3269
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
3270
+ * @category Listener
3346
3271
  * @since v8.1.0
3347
3272
  */
3348
- useResultSortedRowIdsListener: (
3273
+ onResultSortedRowIds: (
3349
3274
  queryId: MaybeGetter<Id>,
3350
3275
  cellId: MaybeGetter<Id | undefined>,
3351
3276
  descending: MaybeGetter<boolean>,
@@ -3356,20 +3281,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3356
3281
  ) => void;
3357
3282
 
3358
3283
  /**
3359
- * The useResultRowListener hook registers a listener that is
3360
- * called whenever a result Row changes.
3361
- * @param queryId The Id of the query to listen to, or `null`
3362
- * to listen to any query.
3363
- * @param rowId The Id of the result Row to listen to, or
3364
- * `null` to listen to any result Row.
3365
- * @param listener The function to call when the result Row
3366
- * changes.
3367
- * @param queriesOrQueriesId The Queries object to use, or its
3368
- * Id.
3369
- * @category Hook
3284
+ * The onResultRow function registers a listener that is called whenever a
3285
+ * result Row changes.
3286
+ * @param queryId The Id of the query to listen to, or `null` to listen to any
3287
+ * query.
3288
+ * @param rowId The Id of the result Row to listen to, or `null` to listen to
3289
+ * any result Row.
3290
+ * @param listener The function to call when the result Row changes.
3291
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
3292
+ * @category Listener
3370
3293
  * @since v8.1.0
3371
3294
  */
3372
- useResultRowListener: (
3295
+ onResultRow: (
3373
3296
  queryId: MaybeGetter<IdOrNull>,
3374
3297
  rowId: MaybeGetter<IdOrNull>,
3375
3298
  listener: ResultRowListener<Schemas>,
@@ -3377,19 +3300,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3377
3300
  ) => void;
3378
3301
 
3379
3302
  /**
3380
- * The useResultCellIdsListener hook registers a listener that
3381
- * is called whenever the Cell Ids in a result Row change.
3382
- * @param queryId The Id of the query to listen to, or `null`
3383
- * to listen to any query.
3384
- * @param rowId The Id of the result Row to listen to, or
3385
- * `null` to listen to any result Row.
3303
+ * The onResultCellIds function registers a listener that is called whenever the
3304
+ * Cell Ids in a result Row change.
3305
+ * @param queryId The Id of the query to listen to, or `null` to listen to any
3306
+ * query.
3307
+ * @param rowId The Id of the result Row to listen to, or `null` to listen to
3308
+ * any result Row.
3386
3309
  * @param listener The function to call when Cell Ids change.
3387
- * @param queriesOrQueriesId The Queries object to use, or its
3388
- * Id.
3389
- * @category Hook
3310
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
3311
+ * @category Listener
3390
3312
  * @since v8.1.0
3391
3313
  */
3392
- useResultCellIdsListener: (
3314
+ onResultCellIds: (
3393
3315
  queryId: MaybeGetter<IdOrNull>,
3394
3316
  rowId: MaybeGetter<IdOrNull>,
3395
3317
  listener: ResultCellIdsListener<Schemas>,
@@ -3397,22 +3319,20 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3397
3319
  ) => void;
3398
3320
 
3399
3321
  /**
3400
- * The useResultCellListener hook registers a listener that is
3401
- * called whenever the value of a result Cell changes.
3402
- * @param queryId The Id of the query to listen to, or `null`
3403
- * to listen to any query.
3404
- * @param rowId The Id of the result Row to listen to, or
3405
- * `null` to listen to any result Row.
3406
- * @param cellId The Id of the result Cell to listen to, or
3407
- * `null` to listen to any result Cell.
3408
- * @param listener The function to call when the result Cell
3409
- * changes.
3410
- * @param queriesOrQueriesId The Queries object to use, or its
3411
- * Id.
3412
- * @category Hook
3322
+ * The onResultCell function registers a listener that is called whenever the
3323
+ * value of a result Cell changes.
3324
+ * @param queryId The Id of the query to listen to, or `null` to listen to any
3325
+ * query.
3326
+ * @param rowId The Id of the result Row to listen to, or `null` to listen to
3327
+ * any result Row.
3328
+ * @param cellId The Id of the result Cell to listen to, or `null` to listen to
3329
+ * any result Cell.
3330
+ * @param listener The function to call when the result Cell changes.
3331
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
3332
+ * @category Listener
3413
3333
  * @since v8.1.0
3414
3334
  */
3415
- useResultCellListener: (
3335
+ onResultCell: (
3416
3336
  queryId: MaybeGetter<IdOrNull>,
3417
3337
  rowId: MaybeGetter<IdOrNull>,
3418
3338
  cellId: MaybeGetter<IdOrNull>,
@@ -3421,39 +3341,34 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3421
3341
  ) => void;
3422
3342
 
3423
3343
  /**
3424
- * The useParamValuesListener hook registers a listener that
3425
- * is called whenever the parameter values for a query change.
3426
- * @param queryId The Id of the query to listen to, or `null`
3427
- * to listen to any query.
3428
- * @param listener The function to call when parameter values
3429
- * change.
3430
- * @param queriesOrQueriesId The Queries object to use, or its
3431
- * Id.
3432
- * @category Hook
3344
+ * The onParamValues function registers a listener that is called whenever the
3345
+ * parameter values for a query change.
3346
+ * @param queryId The Id of the query to listen to, or `null` to listen to any
3347
+ * query.
3348
+ * @param listener The function to call when parameter values change.
3349
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
3350
+ * @category Listener
3433
3351
  * @since v8.1.0
3434
3352
  */
3435
- useParamValuesListener: (
3353
+ onParamValues: (
3436
3354
  queryId: MaybeGetter<IdOrNull>,
3437
3355
  listener: ParamValuesListener<Schemas>,
3438
3356
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
3439
3357
  ) => void;
3440
3358
 
3441
3359
  /**
3442
- * The useParamValueListener hook registers a listener that is
3443
- * called whenever a specific parameter value for a query
3444
- * changes.
3445
- * @param queryId The Id of the query to listen to, or `null`
3446
- * to listen to any query.
3447
- * @param paramId The Id of the parameter to listen to, or
3448
- * `null` to listen to any parameter.
3449
- * @param listener The function to call when the parameter
3450
- * value changes.
3451
- * @param queriesOrQueriesId The Queries object to use, or its
3452
- * Id.
3453
- * @category Hook
3360
+ * The onParamValue function registers a listener that is called whenever a
3361
+ * specific parameter value for a query changes.
3362
+ * @param queryId The Id of the query to listen to, or `null` to listen to any
3363
+ * query.
3364
+ * @param paramId The Id of the parameter to listen to, or `null` to listen to
3365
+ * any parameter.
3366
+ * @param listener The function to call when the parameter value changes.
3367
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
3368
+ * @category Listener
3454
3369
  * @since v8.1.0
3455
3370
  */
3456
- useParamValueListener: (
3371
+ onParamValue: (
3457
3372
  queryId: MaybeGetter<IdOrNull>,
3458
3373
  paramId: MaybeGetter<IdOrNull>,
3459
3374
  listener: ParamValueListener<Schemas>,
@@ -3461,49 +3376,43 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3461
3376
  ) => void;
3462
3377
 
3463
3378
  /**
3464
- * The useCheckpointIdsListener hook registers a listener that
3465
- * is called whenever the Checkpoint Ids change.
3466
- * @param listener The function to call when Checkpoint Ids
3467
- * change.
3468
- * @param checkpointsOrCheckpointsId The Checkpoints object to
3469
- * use, or its Id.
3470
- * @category Hook
3379
+ * The onCheckpointIds function registers a listener that is called whenever the
3380
+ * Checkpoint Ids change.
3381
+ * @param listener The function to call when Checkpoint Ids change.
3382
+ * @param checkpointsOrCheckpointsId The Checkpoints object to use, or its Id.
3383
+ * @category Listener
3471
3384
  * @since v8.1.0
3472
3385
  */
3473
- useCheckpointIdsListener: (
3386
+ onCheckpointIds: (
3474
3387
  listener: CheckpointIdsListener<Schemas>,
3475
3388
  checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId<Schemas>,
3476
3389
  ) => void;
3477
3390
 
3478
3391
  /**
3479
- * The useCheckpointListener hook registers a listener that is
3480
- * called whenever the label of a specified Checkpoint changes.
3481
- * @param checkpointId The Id of the Checkpoint to listen to,
3482
- * or `null` to listen to any Checkpoint.
3483
- * @param listener The function to call when the Checkpoint
3484
- * label changes.
3485
- * @param checkpointsOrCheckpointsId The Checkpoints object to
3486
- * use, or its Id.
3487
- * @category Hook
3392
+ * The onCheckpoint function registers a listener that is called whenever the
3393
+ * label of a specified Checkpoint changes.
3394
+ * @param checkpointId The Id of the Checkpoint to listen to, or `null` to
3395
+ * listen to any Checkpoint.
3396
+ * @param listener The function to call when the Checkpoint label changes.
3397
+ * @param checkpointsOrCheckpointsId The Checkpoints object to use, or its Id.
3398
+ * @category Listener
3488
3399
  * @since v8.1.0
3489
3400
  */
3490
- useCheckpointListener: (
3401
+ onCheckpoint: (
3491
3402
  checkpointId: MaybeGetter<IdOrNull>,
3492
3403
  listener: CheckpointListener<Schemas>,
3493
3404
  checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId<Schemas>,
3494
3405
  ) => void;
3495
3406
 
3496
3407
  /**
3497
- * The usePersisterStatusListener hook registers a listener
3498
- * that is called whenever the status of a Persister changes.
3499
- * @param listener The function to call when the status
3500
- * changes.
3501
- * @param persisterOrPersisterId The Persister to use, or its
3502
- * Id.
3503
- * @category Hook
3408
+ * The onPersisterStatus function registers a listener that is called whenever
3409
+ * the status of a Persister changes.
3410
+ * @param listener The function to call when the status changes.
3411
+ * @param persisterOrPersisterId The Persister to use, or its Id.
3412
+ * @category Listener
3504
3413
  * @since v8.1.0
3505
3414
  */
3506
- usePersisterStatusListener: (
3415
+ onPersisterStatus: (
3507
3416
  listener: StatusListener<Schemas>,
3508
3417
  persisterOrPersisterId?: MaybeGetter<
3509
3418
  PersisterOrPersisterId<Schemas> | undefined
@@ -3511,17 +3420,14 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3511
3420
  ) => void;
3512
3421
 
3513
3422
  /**
3514
- * The useSynchronizerStatusListener hook registers a listener
3515
- * that is called whenever the status of a Synchronizer
3516
- * changes.
3517
- * @param listener The function to call when the status
3518
- * changes.
3519
- * @param synchronizerOrSynchronizerId The Synchronizer to use,
3520
- * or its Id.
3521
- * @category Hook
3423
+ * The onSynchronizerStatus function registers a listener that is called
3424
+ * whenever the status of a Synchronizer changes.
3425
+ * @param listener The function to call when the status changes.
3426
+ * @param synchronizerOrSynchronizerId The Synchronizer to use, or its Id.
3427
+ * @category Listener
3522
3428
  * @since v8.1.0
3523
3429
  */
3524
- useSynchronizerStatusListener: (
3430
+ onSynchronizerStatus: (
3525
3431
  listener: StatusListener<Schemas>,
3526
3432
  synchronizerOrSynchronizerId?: MaybeGetter<
3527
3433
  SynchronizerOrSynchronizerId<Schemas> | undefined
@@ -3538,8 +3444,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3538
3444
  * provideStore(storeId: Id, store: Store): void;
3539
3445
  * ```
3540
3446
  *
3541
- * This function must be called inside a Svelte component's `<script>` block
3542
- * that is a descendant of a Provider component.
3447
+ * The provideStore function must be called inside a Svelte component's
3448
+ * `<script>` block that is a descendant of a Provider component.
3543
3449
  * @param storeId The Id to register the Store under.
3544
3450
  * @param store The Store to register.
3545
3451
  * @category Provider