tinybase 8.1.0-beta.3 → 8.1.0-beta.5

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.
@@ -100,17 +100,17 @@ 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
  */
109
109
  MaybeGetter: <T>(t: T) => T | (() => T);
110
110
 
111
111
  /**
112
- * The StoreOrStoreId type is used when you need to refer to a Store in a Svelte
113
- * hook or component.
112
+ * The StoreOrStoreId type is used when you need to refer to a Store in a
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
  *
@@ -149,7 +149,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
149
149
  * In this case you will want to refer to a Metrics object by its Id in that
150
150
  * context.
151
151
  *
152
- * Many hooks and components in this ui-svelte module take this type as a
152
+ * Many functions and components in this ui-svelte module take this type as a
153
153
  * parameter or a prop, allowing you to pass in either the Metrics object or its
154
154
  * Id.
155
155
  * @category Identity
@@ -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
  *
@@ -175,7 +175,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
175
175
  * In this case you will want to refer to an Indexes object by its Id in that
176
176
  * context.
177
177
  *
178
- * Many hooks and components in this ui-svelte module take this type as a
178
+ * Many functions and components in this ui-svelte module take this type as a
179
179
  * parameter or a prop, allowing you to pass in either the Indexes object or its
180
180
  * Id.
181
181
  * @category Identity
@@ -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
  *
@@ -227,7 +227,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
227
227
  * In this case you will want to refer to a Queries object by its Id in that
228
228
  * context.
229
229
  *
230
- * Many hooks and components in this ui-svelte module take this type as a
230
+ * Many functions and components in this ui-svelte module take this type as a
231
231
  * parameter or a prop, allowing you to pass in either the Queries object or its
232
232
  * Id.
233
233
  * @category Identity
@@ -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,7 +304,7 @@ 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
307
+ * Many functions and components in this ui-svelte module take this type as a
308
308
  * parameter or a prop, allowing you to pass in either the Synchronizer or its
309
309
  * Id.
310
310
  * @category Identity
@@ -314,8 +314,9 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
314
314
 
315
315
  /**
316
316
  * ProviderProps props are used with the Provider component, so that Store,
317
- * Metrics, Indexes, Relationships, Queries, and Checkpoints objects can be
318
- * passed into the context of a Svelte 5 application and used throughout.
317
+ * Metrics, Indexes, Relationships, Queries, Checkpoints, Persisters, and
318
+ * Synchronizers can be passed into the context of a Svelte 5 application and
319
+ * used throughout.
319
320
  *
320
321
  * One of each type of object can be provided as a default within the context.
321
322
  * Additionally, multiple of each type of object can be provided in an Id-keyed
@@ -436,47 +437,44 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
436
437
  * @since v8.1.0
437
438
  */
438
439
  readonly synchronizersById?: {readonly [id: Id]: Synchronizer<Schemas>};
439
- /**
440
- * The `children` prop of a ProviderProps object — the app subtree that will
441
- * have access to the provided context.
442
- * @category Prop
443
- * @since v8.1.0
444
- */
445
440
  readonly children: Snippet;
446
441
  };
447
442
 
448
443
  /**
449
- * The CellViewProps type describes the props of the CellView component.
444
+ * CellViewProps props are used for components that refer to a single Cell in a
445
+ * Row, such as the CellView component.
450
446
  * @category Props
451
447
  * @since v8.1.0
452
448
  */
453
449
  CellViewProps: {
454
450
  /**
455
- * The `tableId` prop of a CellViewProps object.
451
+ * The Id of the Table in the Store.
456
452
  * @category Props
457
453
  * @since v8.1.0
458
454
  */
459
455
  readonly tableId: TableIdFromSchema<Schemas[0]>;
460
456
  /**
461
- * The `rowId` prop of a CellViewProps object.
457
+ * The Id of the Row in the Table.
462
458
  * @category Props
463
459
  * @since v8.1.0
464
460
  */
465
461
  readonly rowId: Id;
466
462
  /**
467
- * The `cellId` prop of a CellViewProps object.
463
+ * The Id of the Cell in the Row to be rendered.
468
464
  * @category Props
469
465
  * @since v8.1.0
470
466
  */
471
467
  readonly cellId: AllCellIdFromSchema<Schemas[0]>;
472
468
  /**
473
- * The `store` prop of a CellViewProps object.
469
+ * The Store to be accessed: omit for the default context Store, provide an
470
+ * Id for a named context Store, or provide an explicit reference.
474
471
  * @category Props
475
472
  * @since v8.1.0
476
473
  */
477
474
  readonly store?: StoreOrStoreId<Schemas>;
478
475
  /**
479
- * The `debugIds` prop of a CellViewProps object.
476
+ * Whether the component should also render the Id of the Cell to assist with
477
+ * debugging.
480
478
  * @category Props
481
479
  * @since v8.1.0
482
480
  */
@@ -484,25 +482,28 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
484
482
  };
485
483
 
486
484
  /**
487
- * The ValueViewProps type describes the props of the ValueView component.
485
+ * ValueViewProps props are used for components that refer to a single Value in
486
+ * a Store, such as the ValueView component.
488
487
  * @category Props
489
488
  * @since v8.1.0
490
489
  */
491
490
  ValueViewProps: {
492
491
  /**
493
- * The `valueId` prop of a ValueViewProps object.
492
+ * The Id of the Value in the Store to be rendered.
494
493
  * @category Props
495
494
  * @since v8.1.0
496
495
  */
497
496
  readonly valueId: ValueIdFromSchema<Schemas[1]>;
498
497
  /**
499
- * The `store` prop of a ValueViewProps object.
498
+ * The Store to be accessed: omit for the default context Store, provide an
499
+ * Id for a named context Store, or provide an explicit reference.
500
500
  * @category Props
501
501
  * @since v8.1.0
502
502
  */
503
503
  readonly store?: StoreOrStoreId<Schemas>;
504
504
  /**
505
- * The `debugIds` prop of a ValueViewProps object.
505
+ * Whether the component should also render the Id of the Value to assist
506
+ * with debugging.
506
507
  * @category Props
507
508
  * @since v8.1.0
508
509
  */
@@ -510,25 +511,29 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
510
511
  };
511
512
 
512
513
  /**
513
- * The MetricViewProps type describes the props of the MetricView component.
514
+ * MetricViewProps props are used for components that refer to a single Metric
515
+ * in a Metrics object, such as the MetricView component.
514
516
  * @category Props
515
517
  * @since v8.1.0
516
518
  */
517
519
  MetricViewProps: {
518
520
  /**
519
- * The `metricId` prop of a MetricViewProps object.
521
+ * The Id of the Metric in the Metrics object to be rendered.
520
522
  * @category Props
521
523
  * @since v8.1.0
522
524
  */
523
525
  readonly metricId: Id;
524
526
  /**
525
- * The `metrics` prop of a MetricViewProps object.
527
+ * The Metrics object to be accessed: omit for the default context Metrics
528
+ * object, provide an Id for a named context Metrics object, or provide an
529
+ * explicit reference.
526
530
  * @category Props
527
531
  * @since v8.1.0
528
532
  */
529
533
  readonly metrics?: MetricsOrMetricsId<Schemas>;
530
534
  /**
531
- * The `debugIds` prop of a MetricViewProps object.
535
+ * Whether the component should also render the Id of the Metric to assist
536
+ * with debugging.
532
537
  * @category Props
533
538
  * @since v8.1.0
534
539
  */
@@ -536,26 +541,29 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
536
541
  };
537
542
 
538
543
  /**
539
- * The CheckpointViewProps type describes the props of the CheckpointView
540
- * component.
544
+ * CheckpointViewProps props are used for components that refer to a single
545
+ * checkpoint in a Checkpoints object, such as the CheckpointView component.
541
546
  * @category Props
542
547
  * @since v8.1.0
543
548
  */
544
549
  CheckpointViewProps: {
545
550
  /**
546
- * The `checkpointId` prop of a CheckpointViewProps object.
551
+ * The Id of the checkpoint in the Checkpoints object.
547
552
  * @category Props
548
553
  * @since v8.1.0
549
554
  */
550
555
  readonly checkpointId: Id;
551
556
  /**
552
- * The `checkpoints` prop of a CheckpointViewProps object.
557
+ * The Checkpoints object to be accessed: omit for the default context
558
+ * Checkpoints object, provide an Id for a named context Checkpoints object,
559
+ * or provide an explicit reference.
553
560
  * @category Props
554
561
  * @since v8.1.0
555
562
  */
556
563
  readonly checkpoints?: CheckpointsOrCheckpointsId<Schemas>;
557
564
  /**
558
- * The `debugIds` prop of a CheckpointViewProps object.
565
+ * Whether the component should also render the Id of the checkpoint to
566
+ * assist with debugging.
559
567
  * @category Props
560
568
  * @since v8.1.0
561
569
  */
@@ -563,49 +571,54 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
563
571
  };
564
572
 
565
573
  /**
566
- * The RowViewProps type describes the props of the RowView component.
574
+ * RowViewProps props are used for components that refer to a single Row in a
575
+ * Table, such as the RowView component.
567
576
  * @category Props
568
577
  * @since v8.1.0
569
578
  */
570
579
  RowViewProps: {
571
580
  /**
572
- * The `tableId` prop of a RowViewProps object.
581
+ * The Id of the Table in the Store.
573
582
  * @category Props
574
583
  * @since v8.1.0
575
584
  */
576
585
  readonly tableId: TableIdFromSchema<Schemas[0]>;
577
586
  /**
578
- * The `rowId` prop of a RowViewProps object.
587
+ * The Id of the Row in the Table to be rendered.
579
588
  * @category Props
580
589
  * @since v8.1.0
581
590
  */
582
591
  readonly rowId: Id;
583
592
  /**
584
- * The `store` prop of a RowViewProps object.
593
+ * The Store to be accessed: omit for the default context Store, provide an
594
+ * Id for a named context Store, or provide an explicit reference.
585
595
  * @category Props
586
596
  * @since v8.1.0
587
597
  */
588
598
  readonly store?: StoreOrStoreId<Schemas>;
589
599
  /**
590
- * The `customCellIds` prop of a RowViewProps object.
600
+ * An optional list of Cell Ids to use for rendering a prescribed set of the
601
+ * Row's Cells in a given order.
591
602
  * @category Props
592
603
  * @since v8.1.0
593
604
  */
594
605
  readonly customCellIds?: Ids;
595
606
  /**
596
- * The `separator` prop of a RowViewProps object.
607
+ * A component or string to separate each rendered Cell.
597
608
  * @category Props
598
609
  * @since v8.1.0
599
610
  */
600
611
  readonly separator?: Snippet<[]>;
601
612
  /**
602
- * The `debugIds` prop of a RowViewProps object.
613
+ * Whether the component should also render the Id of the Row, and its
614
+ * descendent objects, to assist with debugging.
603
615
  * @category Props
604
616
  * @since v8.1.0
605
617
  */
606
618
  readonly debugIds?: boolean;
607
619
  /**
608
- * The `cell` snippet prop of a RowViewProps object.
620
+ * A snippet for rendering each Cell in the Row, to override the default
621
+ * CellView component.
609
622
  * @category Props
610
623
  * @since v8.1.0
611
624
  */
@@ -613,43 +626,48 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
613
626
  };
614
627
 
615
628
  /**
616
- * The TableViewProps type describes the props of the TableView component.
629
+ * TableViewProps props are used for components that refer to a single Table in
630
+ * a Store, such as the TableView component.
617
631
  * @category Props
618
632
  * @since v8.1.0
619
633
  */
620
634
  TableViewProps: {
621
635
  /**
622
- * The `tableId` prop of a TableViewProps object.
636
+ * The Id of the Table in the Store to be rendered.
623
637
  * @category Props
624
638
  * @since v8.1.0
625
639
  */
626
640
  readonly tableId: TableIdFromSchema<Schemas[0]>;
627
641
  /**
628
- * The `store` prop of a TableViewProps object.
642
+ * The Store to be accessed: omit for the default context Store, provide an
643
+ * Id for a named context Store, or provide an explicit reference.
629
644
  * @category Props
630
645
  * @since v8.1.0
631
646
  */
632
647
  readonly store?: StoreOrStoreId<Schemas>;
633
648
  /**
634
- * The `customCellIds` prop of a TableViewProps object.
649
+ * An optional list of Cell Ids to use for rendering a prescribed set of the
650
+ * Table's Cells in a given order for each Row.
635
651
  * @category Props
636
652
  * @since v8.1.0
637
653
  */
638
654
  readonly customCellIds?: Ids;
639
655
  /**
640
- * The `separator` prop of a TableViewProps object.
656
+ * A component or string to separate each rendered Row.
641
657
  * @category Props
642
658
  * @since v8.1.0
643
659
  */
644
660
  readonly separator?: Snippet<[]>;
645
661
  /**
646
- * The `debugIds` prop of a TableViewProps object.
662
+ * Whether the component should also render the Id of the Table, and its
663
+ * descendent objects, to assist with debugging.
647
664
  * @category Props
648
665
  * @since v8.1.0
649
666
  */
650
667
  readonly debugIds?: boolean;
651
668
  /**
652
- * The `row` snippet prop of a TableViewProps object.
669
+ * A snippet for rendering each Row in the Table, to override the default
670
+ * RowView component.
653
671
  * @category Props
654
672
  * @since v8.1.0
655
673
  */
@@ -657,68 +675,73 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
657
675
  };
658
676
 
659
677
  /**
660
- * The SortedTableViewProps type describes the props of the SortedTableView
661
- * component.
678
+ * SortedTableViewProps props are used for components that refer to a single
679
+ * sorted Table in a Store, such as the SortedTableView component.
662
680
  * @category Props
663
681
  * @since v8.1.0
664
682
  */
665
683
  SortedTableViewProps: {
666
684
  /**
667
- * The `tableId` prop of a SortedTableViewProps object.
685
+ * The Id of the Table in the Store to be rendered.
668
686
  * @category Props
669
687
  * @since v8.1.0
670
688
  */
671
689
  readonly tableId: TableIdFromSchema<Schemas[0]>;
672
690
  /**
673
- * The `cellId` prop of a SortedTableViewProps object.
691
+ * The Id of the Cell whose values are used for sorting. If omitted, the view
692
+ * will sort the Row Id itself.
674
693
  * @category Props
675
694
  * @since v8.1.0
676
695
  */
677
696
  readonly cellId?: AllCellIdFromSchema<Schemas[0]>;
678
697
  /**
679
- * The `descending` prop of a SortedTableViewProps object.
698
+ * Whether the sorting should be in descending order.
680
699
  * @category Props
681
700
  * @since v8.1.0
682
701
  */
683
702
  readonly descending?: boolean;
684
703
  /**
685
- * The `offset` prop of a SortedTableViewProps object.
704
+ * The number of Row Ids to skip for pagination purposes.
686
705
  * @category Props
687
706
  * @since v8.1.0
688
707
  */
689
708
  readonly offset?: number;
690
709
  /**
691
- * The `limit` prop of a SortedTableViewProps object.
710
+ * The maximum number of Row Ids to return.
692
711
  * @category Props
693
712
  * @since v8.1.0
694
713
  */
695
714
  readonly limit?: number;
696
715
  /**
697
- * The `store` prop of a SortedTableViewProps object.
716
+ * The Store to be accessed: omit for the default context Store, provide an
717
+ * Id for a named context Store, or provide an explicit reference.
698
718
  * @category Props
699
719
  * @since v8.1.0
700
720
  */
701
721
  readonly store?: StoreOrStoreId<Schemas>;
702
722
  /**
703
- * The `customCellIds` prop of a SortedTableViewProps object.
723
+ * An optional list of Cell Ids to use for rendering a prescribed set of the
724
+ * sorted Table's Cells in a given order.
704
725
  * @category Props
705
726
  * @since v8.1.0
706
727
  */
707
728
  readonly customCellIds?: Ids;
708
729
  /**
709
- * The `separator` prop of a SortedTableViewProps object.
730
+ * A component or string to separate each rendered Row.
710
731
  * @category Props
711
732
  * @since v8.1.0
712
733
  */
713
734
  readonly separator?: Snippet<[]>;
714
735
  /**
715
- * The `debugIds` prop of a SortedTableViewProps object.
736
+ * Whether the component should also render the Id of the Table, and its
737
+ * descendent objects, to assist with debugging.
716
738
  * @category Props
717
739
  * @since v8.1.0
718
740
  */
719
741
  readonly debugIds?: boolean;
720
742
  /**
721
- * The `row` snippet prop of a SortedTableViewProps object.
743
+ * A snippet for rendering each Row in the sorted Table, to override the
744
+ * default RowView component.
722
745
  * @category Props
723
746
  * @since v8.1.0
724
747
  */
@@ -726,31 +749,35 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
726
749
  };
727
750
 
728
751
  /**
729
- * The TablesViewProps type describes the props of the TablesView component.
752
+ * TablesViewProps props are used for components that refer to all the Tables
753
+ * in a Store, such as the TablesView component.
730
754
  * @category Props
731
755
  * @since v8.1.0
732
756
  */
733
757
  TablesViewProps: {
734
758
  /**
735
- * The `store` prop of a TablesViewProps object.
759
+ * The Store to be accessed: omit for the default context Store, provide an
760
+ * Id for a named context Store, or provide an explicit reference.
736
761
  * @category Props
737
762
  * @since v8.1.0
738
763
  */
739
764
  readonly store?: StoreOrStoreId<Schemas>;
740
765
  /**
741
- * The `separator` prop of a TablesViewProps object.
766
+ * A component or string to separate each rendered Table.
742
767
  * @category Props
743
768
  * @since v8.1.0
744
769
  */
745
770
  readonly separator?: Snippet<[]>;
746
771
  /**
747
- * The `debugIds` prop of a TablesViewProps object.
772
+ * Whether the component should also render the Ids of each Table, and its
773
+ * descendent objects, to assist with debugging.
748
774
  * @category Props
749
775
  * @since v8.1.0
750
776
  */
751
777
  readonly debugIds?: boolean;
752
778
  /**
753
- * The `table` snippet prop of a TablesViewProps object.
779
+ * A snippet for rendering each Table in the Store, to override the default
780
+ * TableView component.
754
781
  * @category Props
755
782
  * @since v8.1.0
756
783
  */
@@ -758,31 +785,35 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
758
785
  };
759
786
 
760
787
  /**
761
- * The ValuesViewProps type describes the props of the ValuesView component.
788
+ * ValuesViewProps props are used for components that refer to all the Values
789
+ * in a Store, such as the ValuesView component.
762
790
  * @category Props
763
791
  * @since v8.1.0
764
792
  */
765
793
  ValuesViewProps: {
766
794
  /**
767
- * The `store` prop of a ValuesViewProps object.
795
+ * The Store to be accessed: omit for the default context Store, provide an
796
+ * Id for a named context Store, or provide an explicit reference.
768
797
  * @category Props
769
798
  * @since v8.1.0
770
799
  */
771
800
  readonly store?: StoreOrStoreId<Schemas>;
772
801
  /**
773
- * The `separator` prop of a ValuesViewProps object.
802
+ * A component or string to separate each rendered Value.
774
803
  * @category Props
775
804
  * @since v8.1.0
776
805
  */
777
806
  readonly separator?: Snippet<[]>;
778
807
  /**
779
- * The `debugIds` prop of a ValuesViewProps object.
808
+ * Whether the component should also render the Ids of each Value to assist
809
+ * with debugging.
780
810
  * @category Props
781
811
  * @since v8.1.0
782
812
  */
783
813
  readonly debugIds?: boolean;
784
814
  /**
785
- * The `value` snippet prop of a ValuesViewProps object.
815
+ * A snippet for rendering each Value in the Store, to override the default
816
+ * ValueView component.
786
817
  * @category Props
787
818
  * @since v8.1.0
788
819
  */
@@ -790,37 +821,41 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
790
821
  };
791
822
 
792
823
  /**
793
- * The IndexViewProps type describes the props of the IndexView component.
824
+ * IndexViewProps props are used for components that refer to a single Index in
825
+ * an Indexes object, such as the IndexView component.
794
826
  * @category Props
795
827
  * @since v8.1.0
796
828
  */
797
829
  IndexViewProps: {
798
830
  /**
799
- * The `indexId` prop of an IndexViewProps object.
831
+ * The Id of the Index in the Indexes object to be rendered.
800
832
  * @category Props
801
833
  * @since v8.1.0
802
834
  */
803
835
  readonly indexId: Id;
804
836
  /**
805
- * The `indexes` prop of an IndexViewProps object.
837
+ * The Indexes object to be accessed: omit for the default context Indexes
838
+ * object, provide an Id for a named context Indexes object, or provide an
839
+ * explicit reference.
806
840
  * @category Props
807
841
  * @since v8.1.0
808
842
  */
809
843
  readonly indexes?: IndexesOrIndexesId<Schemas>;
810
844
  /**
811
- * The `separator` prop of an IndexViewProps object.
845
+ * A component or string to separate each rendered Slice.
812
846
  * @category Props
813
847
  * @since v8.1.0
814
848
  */
815
849
  readonly separator?: Snippet<[]>;
816
850
  /**
817
- * The `debugIds` prop of an IndexViewProps object.
851
+ * Whether the component should also render the Id of the Index, and its
852
+ * descendent objects, to assist with debugging.
818
853
  * @category Props
819
854
  * @since v8.1.0
820
855
  */
821
856
  readonly debugIds?: boolean;
822
857
  /**
823
- * The `slice` snippet prop of an IndexViewProps object.
858
+ * A snippet for rendering each Slice in the Index.
824
859
  * @category Props
825
860
  * @since v8.1.0
826
861
  */
@@ -828,43 +863,48 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
828
863
  };
829
864
 
830
865
  /**
831
- * The SliceViewProps type describes the props of the SliceView component.
866
+ * SliceViewProps props are used for components that refer to a single Slice in
867
+ * an Index object, such as the SliceView component.
832
868
  * @category Props
833
869
  * @since v8.1.0
834
870
  */
835
871
  SliceViewProps: {
836
872
  /**
837
- * The `indexId` prop of a SliceViewProps object.
873
+ * The Id of the Index in the Indexes object.
838
874
  * @category Props
839
875
  * @since v8.1.0
840
876
  */
841
877
  readonly indexId: Id;
842
878
  /**
843
- * The `sliceId` prop of a SliceViewProps object.
879
+ * The Id of the Slice in the Index to be rendered.
844
880
  * @category Props
845
881
  * @since v8.1.0
846
882
  */
847
883
  readonly sliceId: Id;
848
884
  /**
849
- * The `indexes` prop of a SliceViewProps object.
885
+ * The Indexes object to be accessed: omit for the default context Indexes
886
+ * object, provide an Id for a named context Indexes object, or provide an
887
+ * explicit reference.
850
888
  * @category Props
851
889
  * @since v8.1.0
852
890
  */
853
891
  readonly indexes?: IndexesOrIndexesId<Schemas>;
854
892
  /**
855
- * The `separator` prop of a SliceViewProps object.
893
+ * A component or string to separate each rendered Row.
856
894
  * @category Props
857
895
  * @since v8.1.0
858
896
  */
859
897
  readonly separator?: Snippet<[]>;
860
898
  /**
861
- * The `debugIds` prop of a SliceViewProps object.
899
+ * Whether the component should also render the Id of the Slice, and its
900
+ * descendent objects, to assist with debugging.
862
901
  * @category Props
863
902
  * @since v8.1.0
864
903
  */
865
904
  readonly debugIds?: boolean;
866
905
  /**
867
- * The `row` snippet prop of a SliceViewProps object.
906
+ * A snippet for rendering each Row in the Slice, to override the default
907
+ * RowView component.
868
908
  * @category Props
869
909
  * @since v8.1.0
870
910
  */
@@ -872,38 +912,43 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
872
912
  };
873
913
 
874
914
  /**
875
- * The RemoteRowViewProps type describes the props of the RemoteRowView
876
- * component.
915
+ * RemoteRowViewProps props are used for components that refer to a single
916
+ * Relationship in a Relationships object, and where you want to render a
917
+ * remote Row based on a local Row, such as in the RemoteRowView component.
877
918
  * @category Props
878
919
  * @since v8.1.0
879
920
  */
880
921
  RemoteRowViewProps: {
881
922
  /**
882
- * The `relationshipId` prop of a RemoteRowViewProps object.
923
+ * The Id of the Relationship in the Relationships object.
883
924
  * @category Props
884
925
  * @since v8.1.0
885
926
  */
886
927
  readonly relationshipId: Id;
887
928
  /**
888
- * The `localRowId` prop of a RemoteRowViewProps object.
929
+ * The Id of the local Row for which to render the remote Row.
889
930
  * @category Props
890
931
  * @since v8.1.0
891
932
  */
892
933
  readonly localRowId: Id;
893
934
  /**
894
- * The `relationships` prop of a RemoteRowViewProps object.
935
+ * The Relationships object to be accessed: omit for the default context
936
+ * Relationships object, provide an Id for a named context Relationships
937
+ * object, or provide an explicit reference.
895
938
  * @category Props
896
939
  * @since v8.1.0
897
940
  */
898
941
  readonly relationships?: RelationshipsOrRelationshipsId<Schemas>;
899
942
  /**
900
- * The `debugIds` prop of a RemoteRowViewProps object.
943
+ * Whether the component should also render the Id of the Row in the
944
+ * Relationship, and its descendent objects, to assist with debugging.
901
945
  * @category Props
902
946
  * @since v8.1.0
903
947
  */
904
948
  readonly debugIds?: boolean;
905
949
  /**
906
- * The `row` snippet prop of a RemoteRowViewProps object.
950
+ * A snippet for rendering each (remote, local, or linked) Row in the
951
+ * Relationship.
907
952
  * @category Props
908
953
  * @since v8.1.0
909
954
  */
@@ -911,44 +956,49 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
911
956
  };
912
957
 
913
958
  /**
914
- * The LocalRowsViewProps type describes the props of the LocalRowsView
915
- * component.
959
+ * LocalRowsViewProps props are used for components that refer to a single
960
+ * Relationship in a Relationships object, and where you want to render local
961
+ * Rows based on a remote Row, such as the LocalRowsView component.
916
962
  * @category Props
917
963
  * @since v8.1.0
918
964
  */
919
965
  LocalRowsViewProps: {
920
966
  /**
921
- * The `relationshipId` prop of a LocalRowsViewProps object.
967
+ * The Id of the Relationship in the Relationships object.
922
968
  * @category Props
923
969
  * @since v8.1.0
924
970
  */
925
971
  readonly relationshipId: Id;
926
972
  /**
927
- * The `remoteRowId` prop of a LocalRowsViewProps object.
973
+ * The Id of the remote Row for which to render the local Rows.
928
974
  * @category Props
929
975
  * @since v8.1.0
930
976
  */
931
977
  readonly remoteRowId: Id;
932
978
  /**
933
- * The `relationships` prop of a LocalRowsViewProps object.
979
+ * The Relationships object to be accessed: omit for the default context
980
+ * Relationships object, provide an Id for a named context Relationships
981
+ * object, or provide an explicit reference.
934
982
  * @category Props
935
983
  * @since v8.1.0
936
984
  */
937
985
  readonly relationships?: RelationshipsOrRelationshipsId<Schemas>;
938
986
  /**
939
- * The `separator` prop of a LocalRowsViewProps object.
987
+ * A component or string to separate each rendered Row.
940
988
  * @category Props
941
989
  * @since v8.1.0
942
990
  */
943
991
  readonly separator?: Snippet<[]>;
944
992
  /**
945
- * The `debugIds` prop of a LocalRowsViewProps object.
993
+ * Whether the component should also render the Id of the Row in the
994
+ * Relationship, and its descendent objects, to assist with debugging.
946
995
  * @category Props
947
996
  * @since v8.1.0
948
997
  */
949
998
  readonly debugIds?: boolean;
950
999
  /**
951
- * The `row` snippet prop of a LocalRowsViewProps object.
1000
+ * A snippet for rendering each (remote, local, or linked) Row in the
1001
+ * Relationship.
952
1002
  * @category Props
953
1003
  * @since v8.1.0
954
1004
  */
@@ -956,44 +1006,50 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
956
1006
  };
957
1007
 
958
1008
  /**
959
- * The LinkedRowsViewProps type describes the props of the LinkedRowsView
1009
+ * LinkedRowsViewProps props are used for components that refer to a single
1010
+ * Relationship in a Relationships object, and where you want to render a
1011
+ * linked list of Rows starting from a first Row, such as the LinkedRowsView
960
1012
  * component.
961
1013
  * @category Props
962
1014
  * @since v8.1.0
963
1015
  */
964
1016
  LinkedRowsViewProps: {
965
1017
  /**
966
- * The `relationshipId` prop of a LinkedRowsViewProps object.
1018
+ * The Id of the Relationship in the Relationships object.
967
1019
  * @category Props
968
1020
  * @since v8.1.0
969
1021
  */
970
1022
  readonly relationshipId: Id;
971
1023
  /**
972
- * The `firstRowId` prop of a LinkedRowsViewProps object.
1024
+ * The Id of the first Row in the linked list Relationship.
973
1025
  * @category Props
974
1026
  * @since v8.1.0
975
1027
  */
976
1028
  readonly firstRowId: Id;
977
1029
  /**
978
- * The `relationships` prop of a LinkedRowsViewProps object.
1030
+ * The Relationships object to be accessed: omit for the default context
1031
+ * Relationships object, provide an Id for a named context Relationships
1032
+ * object, or provide an explicit reference.
979
1033
  * @category Props
980
1034
  * @since v8.1.0
981
1035
  */
982
1036
  readonly relationships?: RelationshipsOrRelationshipsId<Schemas>;
983
1037
  /**
984
- * The `separator` prop of a LinkedRowsViewProps object.
1038
+ * A component or string to separate each rendered Row.
985
1039
  * @category Props
986
1040
  * @since v8.1.0
987
1041
  */
988
1042
  readonly separator?: Snippet<[]>;
989
1043
  /**
990
- * The `debugIds` prop of a LinkedRowsViewProps object.
1044
+ * Whether the component should also render the Id of the Row in the
1045
+ * Relationship, and its descendent objects, to assist with debugging.
991
1046
  * @category Props
992
1047
  * @since v8.1.0
993
1048
  */
994
1049
  readonly debugIds?: boolean;
995
1050
  /**
996
- * The `row` snippet prop of a LinkedRowsViewProps object.
1051
+ * A snippet for rendering each (remote, local, or linked) Row in the
1052
+ * Relationship.
997
1053
  * @category Props
998
1054
  * @since v8.1.0
999
1055
  */
@@ -1001,38 +1057,42 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1001
1057
  };
1002
1058
 
1003
1059
  /**
1004
- * The ResultCellViewProps type describes the props of the ResultCellView
1005
- * component.
1060
+ * ResultCellViewProps props are used for components that refer to a single
1061
+ * Cell in a Row of a query ResultTable, such as the ResultCellView component.
1006
1062
  * @category Props
1007
1063
  * @since v8.1.0
1008
1064
  */
1009
1065
  ResultCellViewProps: {
1010
1066
  /**
1011
- * The `queryId` prop of a ResultCellViewProps object.
1067
+ * The Id of the query in the Queries object for which the ResultTable will be
1068
+ * rendered.
1012
1069
  * @category Props
1013
1070
  * @since v8.1.0
1014
1071
  */
1015
1072
  readonly queryId: Id;
1016
1073
  /**
1017
- * The `rowId` prop of a ResultCellViewProps object.
1074
+ * The Id of the Row in the ResultTable.
1018
1075
  * @category Props
1019
1076
  * @since v8.1.0
1020
1077
  */
1021
1078
  readonly rowId: Id;
1022
1079
  /**
1023
- * The `cellId` prop of a ResultCellViewProps object.
1080
+ * The Id of the Cell in the Row to be rendered.
1024
1081
  * @category Props
1025
1082
  * @since v8.1.0
1026
1083
  */
1027
1084
  readonly cellId: Id;
1028
1085
  /**
1029
- * The `queries` prop of a ResultCellViewProps object.
1086
+ * The Queries object to be accessed: omit for the default context Queries
1087
+ * object, provide an Id for a named context Queries object, or provide an
1088
+ * explicit reference.
1030
1089
  * @category Props
1031
1090
  * @since v8.1.0
1032
1091
  */
1033
1092
  readonly queries?: QueriesOrQueriesId<Schemas>;
1034
1093
  /**
1035
- * The `debugIds` prop of a ResultCellViewProps object.
1094
+ * Whether the component should also render the Id of the Cell to assist with
1095
+ * debugging.
1036
1096
  * @category Props
1037
1097
  * @since v8.1.0
1038
1098
  */
@@ -1040,44 +1100,49 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1040
1100
  };
1041
1101
 
1042
1102
  /**
1043
- * The ResultRowViewProps type describes the props of the ResultRowView
1044
- * component.
1103
+ * ResultRowViewProps props are used for components that refer to a single Row
1104
+ * in a query ResultTable, such as the ResultRowView component.
1045
1105
  * @category Props
1046
1106
  * @since v8.1.0
1047
1107
  */
1048
1108
  ResultRowViewProps: {
1049
1109
  /**
1050
- * The `queryId` prop of a ResultRowViewProps object.
1110
+ * The Id of the query in the Queries object for which the ResultTable will be
1111
+ * rendered.
1051
1112
  * @category Props
1052
1113
  * @since v8.1.0
1053
1114
  */
1054
1115
  readonly queryId: Id;
1055
1116
  /**
1056
- * The `rowId` prop of a ResultRowViewProps object.
1117
+ * The Id of the Row in the ResultTable to be rendered.
1057
1118
  * @category Props
1058
1119
  * @since v8.1.0
1059
1120
  */
1060
1121
  readonly rowId: Id;
1061
1122
  /**
1062
- * The `queries` prop of a ResultRowViewProps object.
1123
+ * The Queries object to be accessed: omit for the default context Queries
1124
+ * object, provide an Id for a named context Queries object, or provide an
1125
+ * explicit reference.
1063
1126
  * @category Props
1064
1127
  * @since v8.1.0
1065
1128
  */
1066
1129
  readonly queries?: QueriesOrQueriesId<Schemas>;
1067
1130
  /**
1068
- * The `separator` prop of a ResultRowViewProps object.
1131
+ * A component or string to separate each rendered Cell.
1069
1132
  * @category Props
1070
1133
  * @since v8.1.0
1071
1134
  */
1072
1135
  readonly separator?: Snippet<[]>;
1073
1136
  /**
1074
- * The `debugIds` prop of a ResultRowViewProps object.
1137
+ * Whether the component should also render the Id of the Row, and its
1138
+ * descendent objects, to assist with debugging.
1075
1139
  * @category Props
1076
1140
  * @since v8.1.0
1077
1141
  */
1078
1142
  readonly debugIds?: boolean;
1079
1143
  /**
1080
- * The `cell` snippet prop of a ResultRowViewProps object.
1144
+ * A snippet for rendering each Cell in the Row, to override the default
1145
+ * ResultCellView component.
1081
1146
  * @category Props
1082
1147
  * @since v8.1.0
1083
1148
  */
@@ -1085,38 +1150,43 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1085
1150
  };
1086
1151
 
1087
1152
  /**
1088
- * The ResultTableViewProps type describes the props of the ResultTableView
1089
- * component.
1153
+ * ResultTableViewProps props are used for components that refer to a single
1154
+ * query ResultTable, such as the ResultTableView component.
1090
1155
  * @category Props
1091
1156
  * @since v8.1.0
1092
1157
  */
1093
1158
  ResultTableViewProps: {
1094
1159
  /**
1095
- * The `queryId` prop of a ResultTableViewProps object.
1160
+ * The Id of the query in the Queries object for which the ResultTable will be
1161
+ * rendered.
1096
1162
  * @category Props
1097
1163
  * @since v8.1.0
1098
1164
  */
1099
1165
  readonly queryId: Id;
1100
1166
  /**
1101
- * The `queries` prop of a ResultTableViewProps object.
1167
+ * The Queries object to be accessed: omit for the default context Queries
1168
+ * object, provide an Id for a named context Queries object, or provide an
1169
+ * explicit reference.
1102
1170
  * @category Props
1103
1171
  * @since v8.1.0
1104
1172
  */
1105
1173
  readonly queries?: QueriesOrQueriesId<Schemas>;
1106
1174
  /**
1107
- * The `separator` prop of a ResultTableViewProps object.
1175
+ * A component or string to separate each rendered Row.
1108
1176
  * @category Props
1109
1177
  * @since v8.1.0
1110
1178
  */
1111
1179
  readonly separator?: Snippet<[]>;
1112
1180
  /**
1113
- * The `debugIds` prop of a ResultTableViewProps object.
1181
+ * Whether the component should also render the Id of the query, and its
1182
+ * descendent objects, to assist with debugging.
1114
1183
  * @category Props
1115
1184
  * @since v8.1.0
1116
1185
  */
1117
1186
  readonly debugIds?: boolean;
1118
1187
  /**
1119
- * The `row` snippet prop of a ResultTableViewProps object.
1188
+ * A snippet for rendering each Row in the Table, to override the default
1189
+ * ResultRowView component.
1120
1190
  * @category Props
1121
1191
  * @since v8.1.0
1122
1192
  */
@@ -1124,62 +1194,69 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1124
1194
  };
1125
1195
 
1126
1196
  /**
1127
- * The ResultSortedTableViewProps type describes the props of the
1128
- * ResultSortedTableView component.
1197
+ * ResultSortedTableViewProps props are used for components that refer to a
1198
+ * single sorted query ResultTable, such as the ResultSortedTableView
1199
+ * component.
1129
1200
  * @category Props
1130
1201
  * @since v8.1.0
1131
1202
  */
1132
1203
  ResultSortedTableViewProps: {
1133
1204
  /**
1134
- * The `queryId` prop of a ResultSortedTableViewProps object.
1205
+ * The Id of the query in the Queries object for which the sorted ResultTable
1206
+ * will be rendered.
1135
1207
  * @category Props
1136
1208
  * @since v8.1.0
1137
1209
  */
1138
1210
  readonly queryId: Id;
1139
1211
  /**
1140
- * The `cellId` prop of a ResultSortedTableViewProps object.
1212
+ * The Id of the Cell whose values are used for sorting. If omitted, the view
1213
+ * will sort the Row Id itself.
1141
1214
  * @category Props
1142
1215
  * @since v8.1.0
1143
1216
  */
1144
1217
  readonly cellId?: Id;
1145
1218
  /**
1146
- * The `descending` prop of a ResultSortedTableViewProps object.
1219
+ * Whether the sorting should be in descending order.
1147
1220
  * @category Props
1148
1221
  * @since v8.1.0
1149
1222
  */
1150
1223
  readonly descending?: boolean;
1151
1224
  /**
1152
- * The `offset` prop of a ResultSortedTableViewProps object.
1225
+ * The number of Row Ids to skip for pagination purposes.
1153
1226
  * @category Props
1154
1227
  * @since v8.1.0
1155
1228
  */
1156
1229
  readonly offset?: number;
1157
1230
  /**
1158
- * The `limit` prop of a ResultSortedTableViewProps object.
1231
+ * The maximum number of Row Ids to return.
1159
1232
  * @category Props
1160
1233
  * @since v8.1.0
1161
1234
  */
1162
1235
  readonly limit?: number;
1163
1236
  /**
1164
- * The `queries` prop of a ResultSortedTableViewProps object.
1237
+ * The Queries object to be accessed: omit for the default context Queries
1238
+ * object, provide an Id for a named context Queries object, or provide an
1239
+ * explicit reference.
1165
1240
  * @category Props
1166
1241
  * @since v8.1.0
1167
1242
  */
1168
1243
  readonly queries?: QueriesOrQueriesId<Schemas>;
1169
1244
  /**
1170
- * The `separator` prop of a ResultSortedTableViewProps object.
1245
+ * A component or string to separate each rendered Row.
1171
1246
  * @category Props
1172
1247
  * @since v8.1.0
1173
1248
  */
1174
1249
  readonly separator?: Snippet<[]>;
1175
1250
  /**
1176
- * The `debugIds` prop of a ResultSortedTableViewProps object.
1251
+ * Whether the component should also render the Id of the query, and its
1252
+ * descendent objects, to assist with debugging.
1177
1253
  * @category Props
1178
1254
  * @since v8.1.0
1179
1255
  */
1180
1256
  readonly debugIds?: boolean;
1181
1257
  /**
1182
- * The `row` snippet prop of a ResultSortedTableViewProps object.
1258
+ * A snippet for rendering each Row in the Table, to override the default
1259
+ * ResultRowView component.
1183
1260
  * @category Props
1184
1261
  * @since v8.1.0
1185
1262
  */
@@ -1187,32 +1264,36 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1187
1264
  };
1188
1265
 
1189
1266
  /**
1190
- * The BackwardCheckpointsViewProps type describes the props of the
1267
+ * BackwardCheckpointsViewProps props are used for components that refer to a
1268
+ * list of previous checkpoints in a Checkpoints object, such as the
1191
1269
  * BackwardCheckpointsView component.
1192
1270
  * @category Props
1193
1271
  * @since v8.1.0
1194
1272
  */
1195
1273
  BackwardCheckpointsViewProps: {
1196
1274
  /**
1197
- * The `checkpoints` prop of a BackwardCheckpointsViewProps object.
1275
+ * The Checkpoints object to be accessed: omit for the default context
1276
+ * Checkpoints object, provide an Id for a named context Checkpoints object,
1277
+ * or provide an explicit reference.
1198
1278
  * @category Props
1199
1279
  * @since v8.1.0
1200
1280
  */
1201
1281
  readonly checkpoints?: CheckpointsOrCheckpointsId<Schemas>;
1202
1282
  /**
1203
- * The `separator` prop of a BackwardCheckpointsViewProps object.
1283
+ * A component or string to separate each rendered checkpoint.
1204
1284
  * @category Props
1205
1285
  * @since v8.1.0
1206
1286
  */
1207
1287
  readonly separator?: Snippet<[]>;
1208
1288
  /**
1209
- * The `debugIds` prop of a BackwardCheckpointsViewProps object.
1289
+ * Whether the component should also render the Ids of the checkpoints to
1290
+ * assist with debugging.
1210
1291
  * @category Props
1211
1292
  * @since v8.1.0
1212
1293
  */
1213
1294
  readonly debugIds?: boolean;
1214
1295
  /**
1215
- * The `checkpoint` snippet prop of a BackwardCheckpointsViewProps object.
1296
+ * A snippet for rendering each checkpoint in the Checkpoints object.
1216
1297
  * @category Props
1217
1298
  * @since v8.1.0
1218
1299
  */
@@ -1220,32 +1301,36 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1220
1301
  };
1221
1302
 
1222
1303
  /**
1223
- * The ForwardCheckpointsViewProps type describes the props of the
1304
+ * ForwardCheckpointsViewProps props are used for components that refer to a
1305
+ * list of future checkpoints in a Checkpoints object, such as the
1224
1306
  * ForwardCheckpointsView component.
1225
1307
  * @category Props
1226
1308
  * @since v8.1.0
1227
1309
  */
1228
1310
  ForwardCheckpointsViewProps: {
1229
1311
  /**
1230
- * The `checkpoints` prop of a ForwardCheckpointsViewProps object.
1312
+ * The Checkpoints object to be accessed: omit for the default context
1313
+ * Checkpoints object, provide an Id for a named context Checkpoints object,
1314
+ * or provide an explicit reference.
1231
1315
  * @category Props
1232
1316
  * @since v8.1.0
1233
1317
  */
1234
1318
  readonly checkpoints?: CheckpointsOrCheckpointsId<Schemas>;
1235
1319
  /**
1236
- * The `separator` prop of a ForwardCheckpointsViewProps object.
1320
+ * A component or string to separate each rendered checkpoint.
1237
1321
  * @category Props
1238
1322
  * @since v8.1.0
1239
1323
  */
1240
1324
  readonly separator?: Snippet<[]>;
1241
1325
  /**
1242
- * The `debugIds` prop of a ForwardCheckpointsViewProps object.
1326
+ * Whether the component should also render the Ids of the checkpoints to
1327
+ * assist with debugging.
1243
1328
  * @category Props
1244
1329
  * @since v8.1.0
1245
1330
  */
1246
1331
  readonly debugIds?: boolean;
1247
1332
  /**
1248
- * The `checkpoint` snippet prop of a ForwardCheckpointsViewProps object.
1333
+ * A snippet for rendering each checkpoint in the Checkpoints object.
1249
1334
  * @category Props
1250
1335
  * @since v8.1.0
1251
1336
  */
@@ -1253,26 +1338,30 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1253
1338
  };
1254
1339
 
1255
1340
  /**
1256
- * The CurrentCheckpointViewProps type describes the props of the
1341
+ * CurrentCheckpointViewProps props are used for components that refer to the
1342
+ * current checkpoint in a Checkpoints object, such as the
1257
1343
  * CurrentCheckpointView component.
1258
1344
  * @category Props
1259
1345
  * @since v8.1.0
1260
1346
  */
1261
1347
  CurrentCheckpointViewProps: {
1262
1348
  /**
1263
- * The `checkpoints` prop of a CurrentCheckpointViewProps object.
1349
+ * The Checkpoints object to be accessed: omit for the default context
1350
+ * Checkpoints object, provide an Id for a named context Checkpoints object,
1351
+ * or provide an explicit reference.
1264
1352
  * @category Props
1265
1353
  * @since v8.1.0
1266
1354
  */
1267
1355
  readonly checkpoints?: CheckpointsOrCheckpointsId<Schemas>;
1268
1356
  /**
1269
- * The `debugIds` prop of a CurrentCheckpointViewProps object.
1357
+ * Whether the component should also render the Id of the current checkpoint
1358
+ * to assist with debugging.
1270
1359
  * @category Props
1271
1360
  * @since v8.1.0
1272
1361
  */
1273
1362
  readonly debugIds?: boolean;
1274
1363
  /**
1275
- * The `checkpoint` snippet prop of a CurrentCheckpointViewProps object.
1364
+ * A snippet for rendering the current checkpoint in the Checkpoints object.
1276
1365
  * @category Props
1277
1366
  * @since v8.1.0
1278
1367
  */
@@ -1544,144 +1633,144 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1544
1633
  >;
1545
1634
 
1546
1635
  /**
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`.
1636
+ * The hasTables function returns a reactive object indicating whether any
1637
+ * Tables exist in the Store, and registers a listener so that any changes to
1638
+ * that result will update `current`.
1550
1639
  * @param storeOrStoreId The Store to use, or its Id in a Provider context.
1551
1640
  * @returns A reactive object with a `current` boolean property.
1552
- * @category Hook
1641
+ * @category Getter
1553
1642
  * @since v8.1.0
1554
1643
  */
1555
- useHasTables: (
1644
+ hasTables: (
1556
1645
  storeOrStoreId?: MaybeGetter<StoreOrStoreId<Schemas> | undefined>,
1557
1646
  ) => {
1558
1647
  readonly current: boolean;
1559
1648
  };
1560
1649
 
1561
1650
  /**
1562
- * The useTables hook returns a reactive object reflecting the Tables in the
1651
+ * The getTables function returns a reactive object reflecting the Tables in the
1563
1652
  * Store, and registers a listener so that any changes to those Tables will
1564
- * update `.current`.
1653
+ * update `current`.
1565
1654
  * @param storeOrStoreId The Store to use, or its Id in a Provider context.
1566
1655
  * @returns A reactive object with a `current` Tables property.
1567
- * @category Hook
1656
+ * @category Getter
1568
1657
  * @since v8.1.0
1569
1658
  */
1570
- useTables: (
1659
+ getTables: (
1571
1660
  storeOrStoreId?: MaybeGetter<StoreOrStoreId<Schemas> | undefined>,
1572
1661
  ) => {
1573
1662
  readonly current: Tables<Schemas[0]>;
1574
1663
  };
1575
1664
 
1576
1665
  /**
1577
- * The useTableIds hook returns a reactive object reflecting the Ids of the
1666
+ * The getTableIds function returns a reactive object reflecting the Ids of the
1578
1667
  * Tables in a Store, and registers a listener so that any changes to those Ids
1579
- * will update `.current`.
1668
+ * will update `current`.
1580
1669
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1581
1670
  * @returns A reactive object with a `current` Ids property.
1582
- * @category Hook
1671
+ * @category Getter
1583
1672
  * @since v8.1.0
1584
1673
  */
1585
- useTableIds: (storeOrStoreId?: StoreOrStoreId<Schemas>) => {
1674
+ getTableIds: (storeOrStoreId?: StoreOrStoreId<Schemas>) => {
1586
1675
  readonly current: TableIdFromSchema<Schemas[0]>[];
1587
1676
  };
1588
1677
 
1589
1678
  /**
1590
- * The useHasTable hook returns a reactive object indicating whether a Table
1679
+ * The hasTable function returns a reactive object indicating whether a Table
1591
1680
  * exists in the Store, and registers a listener so that any changes to that
1592
- * result will update `.current`.
1681
+ * result will update `current`.
1593
1682
  * @param tableId The Id of the Table (or a getter returning it).
1594
1683
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1595
1684
  * @returns A reactive object with a `current` boolean property.
1596
- * @category Hook
1685
+ * @category Getter
1597
1686
  * @since v8.1.0
1598
1687
  */
1599
- useHasTable: <TableId extends TableIdFromSchema<Schemas[0]>>(
1688
+ hasTable: <TableId extends TableIdFromSchema<Schemas[0]>>(
1600
1689
  tableId: MaybeGetter<TableId>,
1601
1690
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1602
1691
  ) => {readonly current: boolean};
1603
1692
 
1604
1693
  /**
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`.
1694
+ * The getTable function returns a reactive object reflecting a Table in a
1695
+ * Store, and registers a listener so that any changes to that Table will update
1696
+ * `current`.
1608
1697
  * @param tableId The Id of the Table (or a getter returning it).
1609
1698
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1610
1699
  * @returns A reactive object with a `current` Table property.
1611
- * @category Hook
1700
+ * @category Getter
1612
1701
  * @since v8.1.0
1613
1702
  */
1614
- useTable: <TableId extends TableIdFromSchema<Schemas[0]>>(
1703
+ getTable: <TableId extends TableIdFromSchema<Schemas[0]>>(
1615
1704
  tableId: MaybeGetter<TableId>,
1616
1705
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1617
1706
  ) => {readonly current: Table<Schemas[0], TableId>};
1618
1707
 
1619
1708
  /**
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`.
1709
+ * The getTableCellIds function returns a reactive object reflecting the Ids of
1710
+ * all Cells used across a Table, and registers a listener so that any changes
1711
+ * to those Ids will update `current`.
1623
1712
  * @param tableId The Id of the Table (or a getter returning it).
1624
1713
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1625
1714
  * @returns A reactive object with a `current` Ids property.
1626
- * @category Hook
1715
+ * @category Getter
1627
1716
  * @since v8.1.0
1628
1717
  */
1629
- useTableCellIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
1718
+ getTableCellIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
1630
1719
  tableId: MaybeGetter<TableId>,
1631
1720
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1632
1721
  ) => {readonly current: CellIdFromSchema<Schemas[0], TableId>[]};
1633
1722
 
1634
1723
  /**
1635
- * The useHasTableCell hook returns a reactive object indicating whether a
1724
+ * The hasTableCell function returns a reactive object indicating whether a
1636
1725
  * particular Cell is used anywhere in a Table, and registers a listener so that
1637
- * any changes to that result will update `.current`.
1726
+ * any changes to that result will update `current`.
1638
1727
  * @param tableId The Id of the Table (or a getter returning it).
1639
1728
  * @param cellId The Id of the Cell (or a getter returning it).
1640
1729
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1641
1730
  * @returns A reactive object with a `current` boolean property.
1642
- * @category Hook
1731
+ * @category Getter
1643
1732
  * @since v8.1.0
1644
1733
  */
1645
- useHasTableCell: <TableId extends TableIdFromSchema<Schemas[0]>>(
1734
+ hasTableCell: <TableId extends TableIdFromSchema<Schemas[0]>>(
1646
1735
  tableId: MaybeGetter<TableId>,
1647
1736
  cellId: MaybeGetter<CellIdFromSchema<Schemas[0], TableId>>,
1648
1737
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1649
1738
  ) => {readonly current: boolean};
1650
1739
 
1651
1740
  /**
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`.
1741
+ * The getRowCount function returns a reactive object reflecting the number of
1742
+ * Rows in a Table, and registers a listener so that any changes will update
1743
+ * `current`.
1655
1744
  * @param tableId The Id of the Table (or a getter returning it).
1656
1745
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1657
1746
  * @returns A reactive object with a `current` number property.
1658
- * @category Hook
1747
+ * @category Getter
1659
1748
  * @since v8.1.0
1660
1749
  */
1661
- useRowCount: (
1750
+ getRowCount: (
1662
1751
  tableId: MaybeGetter<TableIdFromSchema<Schemas[0]>>,
1663
1752
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1664
1753
  ) => {readonly current: number};
1665
1754
 
1666
1755
  /**
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`.
1756
+ * The getRowIds function returns a reactive object reflecting the Ids of the
1757
+ * Rows in a Table, and registers a listener so that any changes will update
1758
+ * `current`.
1670
1759
  * @param tableId The Id of the Table (or a getter returning it).
1671
1760
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1672
1761
  * @returns A reactive object with a `current` Ids property.
1673
- * @category Hook
1762
+ * @category Getter
1674
1763
  * @since v8.1.0
1675
1764
  */
1676
- useRowIds: (
1765
+ getRowIds: (
1677
1766
  tableId: MaybeGetter<TableIdFromSchema<Schemas[0]>>,
1678
1767
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1679
1768
  ) => {readonly current: Ids};
1680
1769
 
1681
1770
  /**
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`.
1771
+ * The getSortedRowIds function returns a reactive object reflecting the sorted
1772
+ * Row Ids in a Table, and registers a listener so that any changes will update
1773
+ * `current`.
1685
1774
  * @param tableId The Id of the Table (or a getter returning it).
1686
1775
  * @param cellId The Id of the Cell to sort by (or a getter returning it).
1687
1776
  * @param descending Whether to sort descending (or a getter returning it).
@@ -1689,10 +1778,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1689
1778
  * @param limit The maximum number of Rows to return (or a getter returning it).
1690
1779
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1691
1780
  * @returns A reactive object with a `current` Ids property.
1692
- * @category Hook
1781
+ * @category Getter
1693
1782
  * @since v8.1.0
1694
1783
  */
1695
- useSortedRowIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
1784
+ getSortedRowIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
1696
1785
  tableId: MaybeGetter<TableId>,
1697
1786
  cellId?: MaybeGetter<CellIdFromSchema<Schemas[0], TableId> | undefined>,
1698
1787
  descending?: MaybeGetter<boolean>,
@@ -1702,68 +1791,69 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1702
1791
  ) => {readonly current: Ids};
1703
1792
 
1704
1793
  /**
1705
- * The useHasRow hook returns a reactive object indicating whether a Row exists
1794
+ * The hasRow function returns a reactive object indicating whether a Row exists
1706
1795
  * in a Table, and registers a listener so that any changes to that result will
1707
- * update `.current`.
1796
+ * update `current`.
1708
1797
  * @param tableId The Id of the Table (or a getter returning it).
1709
1798
  * @param rowId The Id of the Row (or a getter returning it).
1710
1799
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1711
1800
  * @returns A reactive object with a `current` boolean property.
1712
- * @category Hook
1801
+ * @category Getter
1713
1802
  * @since v8.1.0
1714
1803
  */
1715
- useHasRow: (
1804
+ hasRow: (
1716
1805
  tableId: MaybeGetter<TableIdFromSchema<Schemas[0]>>,
1717
1806
  rowId: MaybeGetter<Id>,
1718
1807
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1719
1808
  ) => {readonly current: boolean};
1720
1809
 
1721
1810
  /**
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`.
1811
+ * The getRow function returns a reactive object reflecting a Row in a Table,
1812
+ * and registers a listener so that any changes to that Row will update
1813
+ * `current`.
1724
1814
  * @param tableId The Id of the Table (or a getter returning it).
1725
1815
  * @param rowId The Id of the Row (or a getter returning it).
1726
1816
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1727
1817
  * @returns A reactive object with a `current` Row property.
1728
- * @category Hook
1818
+ * @category Getter
1729
1819
  * @since v8.1.0
1730
1820
  */
1731
- useRow: <TableId extends TableIdFromSchema<Schemas[0]>>(
1821
+ getRow: <TableId extends TableIdFromSchema<Schemas[0]>>(
1732
1822
  tableId: MaybeGetter<TableId>,
1733
1823
  rowId: MaybeGetter<Id>,
1734
1824
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1735
1825
  ) => {readonly current: Row<Schemas[0], TableId>};
1736
1826
 
1737
1827
  /**
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`.
1828
+ * The getCellIds function returns a reactive object reflecting the Ids of the
1829
+ * Cells in a Row, and registers a listener so that any changes will update
1830
+ * `current`.
1741
1831
  * @param tableId The Id of the Table (or a getter returning it).
1742
1832
  * @param rowId The Id of the Row (or a getter returning it).
1743
1833
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1744
1834
  * @returns A reactive object with a `current` Ids property.
1745
- * @category Hook
1835
+ * @category Getter
1746
1836
  * @since v8.1.0
1747
1837
  */
1748
- useCellIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
1838
+ getCellIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
1749
1839
  tableId: MaybeGetter<TableId>,
1750
1840
  rowId: MaybeGetter<Id>,
1751
1841
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1752
1842
  ) => {readonly current: CellIdFromSchema<Schemas[0], TableId>[]};
1753
1843
 
1754
1844
  /**
1755
- * The useHasCell hook returns a reactive object indicating whether a Cell
1845
+ * The hasCell function returns a reactive object indicating whether a Cell
1756
1846
  * exists in a Row in a Table, and registers a listener so that any changes to
1757
- * that result will update `.current`.
1847
+ * that result will update `current`.
1758
1848
  * @param tableId The Id of the Table (or a getter returning it).
1759
1849
  * @param rowId The Id of the Row (or a getter returning it).
1760
1850
  * @param cellId The Id of the Cell (or a getter returning it).
1761
1851
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1762
1852
  * @returns A reactive object with a `current` boolean property.
1763
- * @category Hook
1853
+ * @category Getter
1764
1854
  * @since v8.1.0
1765
1855
  */
1766
- useHasCell: <
1856
+ hasCell: <
1767
1857
  TableId extends TableIdFromSchema<Schemas[0]>,
1768
1858
  CellId extends CellIdFromSchema<Schemas[0], TableId>,
1769
1859
  >(
@@ -1774,61 +1864,41 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1774
1864
  ) => {readonly current: boolean};
1775
1865
 
1776
1866
  /**
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.
1867
+ * The getCell function returns a reactive object reflecting the value of a Cell
1868
+ * in a Row in a Table, and registers a listener so that any changes to that
1869
+ * Cell will update `current`.
1787
1870
  *
1788
1871
  * This has schema-based typing. The following is a simplified representation:
1789
1872
  *
1790
1873
  * ```ts override
1791
- * useCell(
1874
+ * getCell(
1792
1875
  * tableId: MaybeGetter<Id>,
1793
1876
  * rowId: MaybeGetter<Id>,
1794
1877
  * cellId: MaybeGetter<Id>,
1795
1878
  * storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1796
- * ): {readonly current: CellOrUndefined};
1879
+ * ): {get current(): CellOrUndefined; set current(v: Cell)};
1797
1880
  * ```
1798
1881
  *
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.
1882
+ * Since Cells are mutable leaf values in a Store, the returned object's
1883
+ * `current` property can also be assigned to write back to the Store.
1823
1884
  * @param tableId The Id of the Table (or a getter returning it).
1824
1885
  * @param rowId The Id of the Row (or a getter returning it).
1825
1886
  * @param cellId The Id of the Cell (or a getter returning it).
1826
1887
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1827
1888
  * @returns A reactive object with gettable and settable `current`.
1828
- * @category Hook
1889
+ * @example
1890
+ * This example uses the getCell function to display a Cell value reactively.
1891
+ *
1892
+ * ```ts
1893
+ * // In a .svelte file:
1894
+ * // const store = createStore().setCell('pets', 'cat', 'name', 'Fido');
1895
+ * // const name = getCell('pets', 'cat', 'name', store);
1896
+ * // $: console.log(name.current); // 'Fido'
1897
+ * ```
1898
+ * @category Getter
1829
1899
  * @since v8.1.0
1830
1900
  */
1831
- useBindableCell: <
1901
+ getCell: <
1832
1902
  TableId extends TableIdFromSchema<Schemas[0]>,
1833
1903
  CellId extends CellIdFromSchema<Schemas[0], TableId>,
1834
1904
  >(
@@ -1842,89 +1912,85 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1842
1912
  };
1843
1913
 
1844
1914
  /**
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`.
1915
+ * The hasValues function returns a reactive object indicating whether any
1916
+ * Values exist in the Store, and registers a listener so that any changes to
1917
+ * that result will update `current`.
1848
1918
  * @param storeOrStoreId The Store to use, or its Id in a Provider context.
1849
1919
  * @returns A reactive object with a `current` boolean property.
1850
- * @category Hook
1920
+ * @category Getter
1851
1921
  * @since v8.1.0
1852
1922
  */
1853
- useHasValues: (
1923
+ hasValues: (
1854
1924
  storeOrStoreId?: MaybeGetter<StoreOrStoreId<Schemas> | undefined>,
1855
1925
  ) => {
1856
1926
  readonly current: boolean;
1857
1927
  };
1858
1928
 
1859
1929
  /**
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`.
1930
+ * The getValues function returns a reactive object reflecting the Values in the
1931
+ * Store, and registers a listener so that any changes will update `current`.
1862
1932
  * @param storeOrStoreId The Store to use, or its Id in a Provider context.
1863
1933
  * @returns A reactive object with a `current` Values property.
1864
- * @category Hook
1934
+ * @category Getter
1865
1935
  * @since v8.1.0
1866
1936
  */
1867
- useValues: (
1937
+ getValues: (
1868
1938
  storeOrStoreId?: MaybeGetter<StoreOrStoreId<Schemas> | undefined>,
1869
1939
  ) => {
1870
1940
  readonly current: Values<Schemas[1]>;
1871
1941
  };
1872
1942
 
1873
1943
  /**
1874
- * The useValueIds hook returns a reactive object reflecting the Ids of the
1944
+ * The getValueIds function returns a reactive object reflecting the Ids of the
1875
1945
  * Values in a Store, and registers a listener so that any changes will update
1876
- * `.current`.
1946
+ * `current`.
1877
1947
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1878
1948
  * @returns A reactive object with a `current` Ids property.
1879
- * @category Hook
1949
+ * @category Getter
1880
1950
  * @since v8.1.0
1881
1951
  */
1882
- useValueIds: (storeOrStoreId?: StoreOrStoreId<Schemas>) => {
1952
+ getValueIds: (storeOrStoreId?: StoreOrStoreId<Schemas>) => {
1883
1953
  readonly current: ValueIdFromSchema<Schemas[1]>[];
1884
1954
  };
1885
1955
 
1886
1956
  /**
1887
- * The useHasValue hook returns a reactive object indicating whether a Value
1957
+ * The hasValue function returns a reactive object indicating whether a Value
1888
1958
  * exists in the Store, and registers a listener so that any changes to that
1889
- * result will update `.current`.
1959
+ * result will update `current`.
1890
1960
  * @param valueId The Id of the Value (or a getter returning it).
1891
1961
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1892
1962
  * @returns A reactive object with a `current` boolean property.
1893
- * @category Hook
1963
+ * @category Getter
1894
1964
  * @since v8.1.0
1895
1965
  */
1896
- useHasValue: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
1966
+ hasValue: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
1897
1967
  valueId: MaybeGetter<ValueId>,
1898
1968
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1899
1969
  ) => {readonly current: boolean};
1900
1970
 
1901
1971
  /**
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.
1972
+ * The getValue function returns a reactive object reflecting the value of a
1973
+ * Value in a Store, and registers a listener so that any changes to that Value
1974
+ * will update `current`.
1975
+ *
1976
+ * This has schema-based typing. The following is a simplified representation:
1977
+ *
1978
+ * ```ts override
1979
+ * getValue(
1980
+ * valueId: MaybeGetter<Id>,
1981
+ * storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1982
+ * ): {get current(): ValueOrUndefined; set current(v: Value)};
1983
+ * ```
1984
+ *
1985
+ * Since Values are mutable leaf values in a Store, the returned object's
1986
+ * `current` property can also be assigned to write back to the Store.
1921
1987
  * @param valueId The Id of the Value (or a getter returning it).
1922
1988
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1923
1989
  * @returns A reactive object with gettable and settable `current`.
1924
- * @category Hook
1990
+ * @category Getter
1925
1991
  * @since v8.1.0
1926
1992
  */
1927
- useBindableValue: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
1993
+ getValue: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
1928
1994
  valueId: MaybeGetter<ValueId>,
1929
1995
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1930
1996
  ) => {
@@ -1933,132 +1999,132 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1933
1999
  };
1934
2000
 
1935
2001
  /**
1936
- * The useStore hook returns the default Store from the current Provider context
1937
- * (or a named Store if an Id is provided).
2002
+ * The getStore function returns the default Store from the current Provider
2003
+ * context (or a named Store if an Id is provided).
1938
2004
  * @param id An optional Id of a named Store in the Provider context.
1939
2005
  * @returns The Store, or `undefined` if not found.
1940
- * @category Hook
2006
+ * @category Getter
1941
2007
  * @since v8.1.0
1942
2008
  */
1943
- useStore: (id?: Id) => Store<Schemas> | undefined;
2009
+ getStore: (id?: Id) => Store<Schemas> | undefined;
1944
2010
 
1945
2011
  /**
1946
- * The useStoreOrStoreById hook is used to get a reference to a Store object
1947
- * from a Provider context, or have it passed directly.
2012
+ * The resolveStore function is used to get a reference to a Store object from a
2013
+ * Provider context, or have it passed directly.
1948
2014
  * @param storeOrStoreId The Store, its Id, or a getter returning either.
1949
2015
  * @returns A getter function returning the Store, or `undefined`.
1950
- * @category Hook
2016
+ * @category Getter
1951
2017
  * @since v8.1.0
1952
2018
  */
1953
- useStoreOrStoreById: (
2019
+ resolveStore: (
1954
2020
  storeOrStoreId?: MaybeGetter<StoreOrStoreId<Schemas> | undefined>,
1955
2021
  ) => () => Store<Schemas> | undefined;
1956
2022
 
1957
2023
  /**
1958
- * The useStoreIds hook returns a reactive object with the Ids of all Stores
2024
+ * The getStoreIds function returns a reactive object with the Ids of all Stores
1959
2025
  * registered in the current Provider context.
1960
2026
  * @returns A reactive object with a `current` Ids property.
1961
- * @category Hook
2027
+ * @category Getter
1962
2028
  * @since v8.1.0
1963
2029
  */
1964
- useStoreIds: () => {readonly current: Ids};
2030
+ getStoreIds: () => {readonly current: Ids};
1965
2031
 
1966
2032
  /**
1967
- * The useMetrics hook returns the default Metrics object from the current
2033
+ * The getMetrics function returns the default Metrics object from the current
1968
2034
  * Provider context (or a named one if an Id is provided).
1969
2035
  * @param id An optional Id of a named Metrics object in the Provider context.
1970
2036
  * @returns The Metrics object, or `undefined` if not found.
1971
- * @category Hook
2037
+ * @category Getter
1972
2038
  * @since v8.1.0
1973
2039
  */
1974
- useMetrics: (id?: Id) => Metrics<Schemas> | undefined;
2040
+ getMetrics: (id?: Id) => Metrics<Schemas> | undefined;
1975
2041
 
1976
2042
  /**
1977
- * The useMetricsOrMetricsById hook is used to get a reference to a Metrics
1978
- * object from a Provider context, or have it passed directly.
2043
+ * The resolveMetrics function is used to get a reference to a Metrics object
2044
+ * from a Provider context, or have it passed directly.
1979
2045
  * @param metricsOrMetricsId The Metrics object, its Id, or a getter returning
1980
2046
  * either.
1981
2047
  * @returns A getter function returning the Metrics object, or `undefined`.
1982
- * @category Hook
2048
+ * @category Getter
1983
2049
  * @since v8.1.0
1984
2050
  */
1985
- useMetricsOrMetricsById: (
2051
+ resolveMetrics: (
1986
2052
  metricsOrMetricsId?: MaybeGetter<MetricsOrMetricsId<Schemas> | undefined>,
1987
2053
  ) => () => Metrics<Schemas> | undefined;
1988
2054
 
1989
2055
  /**
1990
- * The useMetricsIds hook returns a reactive object with the Ids of all Metrics
1991
- * objects registered in the current Provider context.
2056
+ * The getMetricsIds function returns a reactive object with the Ids of all
2057
+ * Metrics objects registered in the current Provider context.
1992
2058
  * @returns A reactive object with a `current` Ids property.
1993
- * @category Hook
2059
+ * @category Getter
1994
2060
  * @since v8.1.0
1995
2061
  */
1996
- useMetricsIds: () => {readonly current: Ids};
2062
+ getMetricsIds: () => {readonly current: Ids};
1997
2063
 
1998
2064
  /**
1999
- * The useMetricIds hook returns a reactive object reflecting the Ids of the
2065
+ * The getMetricIds function returns a reactive object reflecting the Ids of the
2000
2066
  * Metrics in a Metrics object, and registers a listener so that any changes
2001
- * will update `.current`.
2067
+ * will update `current`.
2002
2068
  * @param metricsOrMetricsId The Metrics object to use, or its Id.
2003
2069
  * @returns A reactive object with a `current` Ids property.
2004
- * @category Hook
2070
+ * @category Getter
2005
2071
  * @since v8.1.0
2006
2072
  */
2007
- useMetricIds: (
2073
+ getMetricIds: (
2008
2074
  metricsOrMetricsId?: MaybeGetter<MetricsOrMetricsId<Schemas> | undefined>,
2009
2075
  ) => {
2010
2076
  readonly current: Ids;
2011
2077
  };
2012
2078
 
2013
2079
  /**
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`.
2080
+ * The getMetric function returns a reactive object reflecting the value of a
2081
+ * named Metric in a Metrics object, and registers a listener so that any
2082
+ * changes to that Metric will update `current`.
2017
2083
  * @param metricId The Id of the Metric (or a getter returning it).
2018
2084
  * @param metricsOrMetricsId The Metrics object to use (plain or getter), or its
2019
2085
  * Id.
2020
2086
  * @returns A reactive object with a `current` number | undefined property.
2021
- * @category Hook
2087
+ * @category Getter
2022
2088
  * @since v8.1.0
2023
2089
  */
2024
- useMetric: (
2090
+ getMetric: (
2025
2091
  metricId: MaybeGetter<Id>,
2026
2092
  metricsOrMetricsId?: MetricsOrMetricsId<Schemas>,
2027
2093
  ) => {readonly current: number | undefined};
2028
2094
 
2029
2095
  /**
2030
- * The useIndexes hook returns the default Indexes object from the current
2096
+ * The getIndexes function returns the default Indexes object from the current
2031
2097
  * Provider context (or a named one if an Id is provided).
2032
2098
  * @param id An optional Id of a named Indexes object in the Provider context.
2033
2099
  * @returns The Indexes object, or `undefined` if not found.
2034
- * @category Hook
2100
+ * @category Getter
2035
2101
  * @since v8.1.0
2036
2102
  */
2037
- useIndexes: (id?: Id) => Indexes<Schemas> | undefined;
2103
+ getIndexes: (id?: Id) => Indexes<Schemas> | undefined;
2038
2104
 
2039
2105
  /**
2040
- * The useIndexesOrIndexesById hook is used to get a reference to an Indexes
2041
- * object from a Provider context, or have it passed directly.
2106
+ * The resolveIndexes function is used to get a reference to an Indexes object
2107
+ * from a Provider context, or have it passed directly.
2042
2108
  * @param indexesOrIndexesId The Indexes object, its Id, or a getter returning
2043
2109
  * either.
2044
2110
  * @returns A getter function returning the Indexes object, or `undefined`.
2045
- * @category Hook
2111
+ * @category Getter
2046
2112
  * @since v8.1.0
2047
2113
  */
2048
- useIndexesOrIndexesById: (
2114
+ resolveIndexes: (
2049
2115
  indexesOrIndexesId?: MaybeGetter<IndexesOrIndexesId<Schemas> | undefined>,
2050
2116
  ) => () => Indexes<Schemas> | undefined;
2051
2117
 
2052
2118
  /**
2053
- * The useIndexStoreTableId hook returns the Store and table Id for a given
2119
+ * The getIndexStoreTableId function returns the Store and table Id for a given
2054
2120
  * Indexes object and index Id.
2055
2121
  * @param indexesOrId The Indexes object, its Id, or a getter returning either.
2056
2122
  * @param indexId The Id of the index, or a getter returning it.
2057
2123
  * @returns An object with `store` and `tableId` getter properties.
2058
- * @category Hook
2124
+ * @category Getter
2059
2125
  * @since v8.1.0
2060
2126
  */
2061
- useIndexStoreTableId: (
2127
+ getIndexStoreTableId: (
2062
2128
  indexesOrId: MaybeGetter<IndexesOrIndexesId<Schemas> | undefined>,
2063
2129
  indexId: MaybeGetter<Id>,
2064
2130
  ) => {
@@ -2067,178 +2133,178 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2067
2133
  };
2068
2134
 
2069
2135
  /**
2070
- * The useIndexesIds hook returns a reactive object with the Ids of all Indexes
2071
- * objects registered in the current Provider context.
2136
+ * The getIndexesIds function returns a reactive object with the Ids of all
2137
+ * Indexes objects registered in the current Provider context.
2072
2138
  * @returns A reactive object with a `current` Ids property.
2073
- * @category Hook
2139
+ * @category Getter
2074
2140
  * @since v8.1.0
2075
2141
  */
2076
- useIndexesIds: () => {readonly current: Ids};
2142
+ getIndexesIds: () => {readonly current: Ids};
2077
2143
 
2078
2144
  /**
2079
- * The useIndexIds hook returns a reactive object reflecting the Ids of the
2145
+ * The getIndexIds function returns a reactive object reflecting the Ids of the
2080
2146
  * Indexes in an Indexes object, and registers a listener so that any changes
2081
- * will update `.current`.
2147
+ * will update `current`.
2082
2148
  * @param indexesOrIndexesId The Indexes object to use, or its Id.
2083
2149
  * @returns A reactive object with a `current` Ids property.
2084
- * @category Hook
2150
+ * @category Getter
2085
2151
  * @since v8.1.0
2086
2152
  */
2087
- useIndexIds: (
2153
+ getIndexIds: (
2088
2154
  indexesOrIndexesId?: MaybeGetter<IndexesOrIndexesId<Schemas> | undefined>,
2089
2155
  ) => {
2090
2156
  readonly current: Ids;
2091
2157
  };
2092
2158
 
2093
2159
  /**
2094
- * The useSliceIds hook returns a reactive object reflecting the Ids of the
2160
+ * The getSliceIds function returns a reactive object reflecting the Ids of the
2095
2161
  * Slices in an Index, and registers a listener so that any changes will update
2096
- * `.current`.
2162
+ * `current`.
2097
2163
  * @param indexId The Id of the Index (or a getter returning it).
2098
2164
  * @param indexesOrIndexesId The Indexes object to use (plain or getter), or its
2099
2165
  * Id.
2100
2166
  * @returns A reactive object with a `current` Ids property.
2101
- * @category Hook
2167
+ * @category Getter
2102
2168
  * @since v8.1.0
2103
2169
  */
2104
- useSliceIds: (
2170
+ getSliceIds: (
2105
2171
  indexId: MaybeGetter<Id>,
2106
2172
  indexesOrIndexesId?: IndexesOrIndexesId<Schemas>,
2107
2173
  ) => {readonly current: Ids};
2108
2174
 
2109
2175
  /**
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`.
2176
+ * The getSliceRowIds function returns a reactive object reflecting the Ids of
2177
+ * the Rows in a Slice, and registers a listener so that any changes will update
2178
+ * `current`.
2113
2179
  * @param indexId The Id of the Index (or a getter returning it).
2114
2180
  * @param sliceId The Id of the Slice (or a getter returning it).
2115
2181
  * @param indexesOrIndexesId The Indexes object to use (plain or getter), or its
2116
2182
  * Id.
2117
2183
  * @returns A reactive object with a `current` Ids property.
2118
- * @category Hook
2184
+ * @category Getter
2119
2185
  * @since v8.1.0
2120
2186
  */
2121
- useSliceRowIds: (
2187
+ getSliceRowIds: (
2122
2188
  indexId: MaybeGetter<Id>,
2123
2189
  sliceId: MaybeGetter<Id>,
2124
2190
  indexesOrIndexesId?: IndexesOrIndexesId<Schemas>,
2125
2191
  ) => {readonly current: Ids};
2126
2192
 
2127
2193
  /**
2128
- * The useQueries hook returns the default Queries object from the current
2194
+ * The getQueries function returns the default Queries object from the current
2129
2195
  * Provider context (or a named one if an Id is provided).
2130
2196
  * @param id An optional Id of a named Queries object in the Provider context.
2131
2197
  * @returns The Queries object, or `undefined` if not found.
2132
- * @category Hook
2198
+ * @category Getter
2133
2199
  * @since v8.1.0
2134
2200
  */
2135
- useQueries: (id?: Id) => Queries<Schemas> | undefined;
2201
+ getQueries: (id?: Id) => Queries<Schemas> | undefined;
2136
2202
 
2137
2203
  /**
2138
- * The useQueriesOrQueriesById hook is used to get a reference to a Queries
2139
- * object from a Provider context, or have it passed directly.
2204
+ * The resolveQueries function is used to get a reference to a Queries object
2205
+ * from a Provider context, or have it passed directly.
2140
2206
  * @param queriesOrQueriesId The Queries object, its Id, or a getter returning
2141
2207
  * either.
2142
2208
  * @returns A getter function returning the Queries object, or `undefined`.
2143
- * @category Hook
2209
+ * @category Getter
2144
2210
  * @since v8.1.0
2145
2211
  */
2146
- useQueriesOrQueriesById: (
2212
+ resolveQueries: (
2147
2213
  queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId<Schemas> | undefined>,
2148
2214
  ) => () => Queries<Schemas> | undefined;
2149
2215
 
2150
2216
  /**
2151
- * The useQueriesIds hook returns a reactive object with the Ids of all Queries
2152
- * objects registered in the current Provider context.
2217
+ * The getQueriesIds function returns a reactive object with the Ids of all
2218
+ * Queries objects registered in the current Provider context.
2153
2219
  * @returns A reactive object with a `current` Ids property.
2154
- * @category Hook
2220
+ * @category Getter
2155
2221
  * @since v8.1.0
2156
2222
  */
2157
- useQueriesIds: () => {readonly current: Ids};
2223
+ getQueriesIds: () => {readonly current: Ids};
2158
2224
 
2159
2225
  /**
2160
- * The useQueryIds hook returns a reactive object reflecting the Ids of the
2226
+ * The getQueryIds function returns a reactive object reflecting the Ids of the
2161
2227
  * Queries in a Queries object, and registers a listener so that any changes
2162
- * will update `.current`.
2228
+ * will update `current`.
2163
2229
  * @param queriesOrQueriesId The Queries object to use, or its Id.
2164
2230
  * @returns A reactive object with a `current` Ids property.
2165
- * @category Hook
2231
+ * @category Getter
2166
2232
  * @since v8.1.0
2167
2233
  */
2168
- useQueryIds: (
2234
+ getQueryIds: (
2169
2235
  queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId<Schemas> | undefined>,
2170
2236
  ) => {
2171
2237
  readonly current: Ids;
2172
2238
  };
2173
2239
 
2174
2240
  /**
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`.
2241
+ * The getResultTable function returns a reactive object reflecting a result
2242
+ * Table in a Queries object, and registers a listener so that any changes to
2243
+ * that result will update `current`.
2178
2244
  * @param queryId The Id of the Query (or a getter returning it).
2179
2245
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2180
2246
  * Id.
2181
2247
  * @returns A reactive object with a `current` Table property.
2182
- * @category Hook
2248
+ * @category Getter
2183
2249
  * @since v8.1.0
2184
2250
  */
2185
- useResultTable: (
2251
+ getResultTable: (
2186
2252
  queryId: MaybeGetter<Id>,
2187
2253
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
2188
2254
  ) => {readonly current: ResultTable};
2189
2255
 
2190
2256
  /**
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`.
2257
+ * The getResultTableCellIds function returns a reactive object reflecting the
2258
+ * Ids of all Cells used across a result Table, and registers a listener so that
2259
+ * any changes will update `current`.
2194
2260
  * @param queryId The Id of the Query (or a getter returning it).
2195
2261
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2196
2262
  * Id.
2197
2263
  * @returns A reactive object with a `current` Ids property.
2198
- * @category Hook
2264
+ * @category Getter
2199
2265
  * @since v8.1.0
2200
2266
  */
2201
- useResultTableCellIds: (
2267
+ getResultTableCellIds: (
2202
2268
  queryId: MaybeGetter<Id>,
2203
2269
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
2204
2270
  ) => {readonly current: Ids};
2205
2271
 
2206
2272
  /**
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`.
2273
+ * The getResultRowCount function returns a reactive object reflecting the
2274
+ * number of Rows in a result Table, and registers a listener so that any
2275
+ * changes will update `current`.
2210
2276
  * @param queryId The Id of the Query (or a getter returning it).
2211
2277
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2212
2278
  * Id.
2213
2279
  * @returns A reactive object with a `current` number property.
2214
- * @category Hook
2280
+ * @category Getter
2215
2281
  * @since v8.1.0
2216
2282
  */
2217
- useResultRowCount: (
2283
+ getResultRowCount: (
2218
2284
  queryId: MaybeGetter<Id>,
2219
2285
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
2220
2286
  ) => {readonly current: number};
2221
2287
 
2222
2288
  /**
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`.
2289
+ * The getResultRowIds function returns a reactive object reflecting the Ids of
2290
+ * the Rows in a result Table, and registers a listener so that any changes will
2291
+ * update `current`.
2226
2292
  * @param queryId The Id of the Query (or a getter returning it).
2227
2293
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2228
2294
  * Id.
2229
2295
  * @returns A reactive object with a `current` Ids property.
2230
- * @category Hook
2296
+ * @category Getter
2231
2297
  * @since v8.1.0
2232
2298
  */
2233
- useResultRowIds: (
2299
+ getResultRowIds: (
2234
2300
  queryId: MaybeGetter<Id>,
2235
2301
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
2236
2302
  ) => {readonly current: Ids};
2237
2303
 
2238
2304
  /**
2239
- * The useResultSortedRowIds hook returns a reactive object reflecting the
2305
+ * The getResultSortedRowIds function returns a reactive object reflecting the
2240
2306
  * sorted Row Ids in a result Table, and registers a listener so that any
2241
- * changes will update `.current`.
2307
+ * changes will update `current`.
2242
2308
  * @param queryId The Id of the Query (or a getter returning it).
2243
2309
  * @param cellId The Id of the Cell to sort by (or a getter returning it).
2244
2310
  * @param descending Whether to sort descending (or a getter returning it).
@@ -2247,10 +2313,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2247
2313
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2248
2314
  * Id.
2249
2315
  * @returns A reactive object with a `current` Ids property.
2250
- * @category Hook
2316
+ * @category Getter
2251
2317
  * @since v8.1.0
2252
2318
  */
2253
- useResultSortedRowIds: (
2319
+ getResultSortedRowIds: (
2254
2320
  queryId: MaybeGetter<Id>,
2255
2321
  cellId?: MaybeGetter<Id | undefined>,
2256
2322
  descending?: MaybeGetter<boolean>,
@@ -2260,55 +2326,55 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2260
2326
  ) => {readonly current: Ids};
2261
2327
 
2262
2328
  /**
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`.
2329
+ * The getResultRow function returns a reactive object reflecting a result Row
2330
+ * in a result Table, and registers a listener so that any changes will update
2331
+ * `current`.
2266
2332
  * @param queryId The Id of the Query (or a getter returning it).
2267
2333
  * @param rowId The Id of the Row (or a getter returning it).
2268
2334
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2269
2335
  * Id.
2270
2336
  * @returns A reactive object with a `current` Row property.
2271
- * @category Hook
2337
+ * @category Getter
2272
2338
  * @since v8.1.0
2273
2339
  */
2274
- useResultRow: (
2340
+ getResultRow: (
2275
2341
  queryId: MaybeGetter<Id>,
2276
2342
  rowId: MaybeGetter<Id>,
2277
2343
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
2278
2344
  ) => {readonly current: ResultRow};
2279
2345
 
2280
2346
  /**
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`.
2347
+ * The getResultCellIds function returns a reactive object reflecting the Ids of
2348
+ * the Cells in a result Row, and registers a listener so that any changes will
2349
+ * update `current`.
2284
2350
  * @param queryId The Id of the Query (or a getter returning it).
2285
2351
  * @param rowId The Id of the Row (or a getter returning it).
2286
2352
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2287
2353
  * Id.
2288
2354
  * @returns A reactive object with a `current` Ids property.
2289
- * @category Hook
2355
+ * @category Getter
2290
2356
  * @since v8.1.0
2291
2357
  */
2292
- useResultCellIds: (
2358
+ getResultCellIds: (
2293
2359
  queryId: MaybeGetter<Id>,
2294
2360
  rowId: MaybeGetter<Id>,
2295
2361
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
2296
2362
  ) => {readonly current: Ids};
2297
2363
 
2298
2364
  /**
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
2301
- * update `.current`.
2365
+ * The getResultCell function returns a reactive object reflecting the value of
2366
+ * a Cell in a result Row, and registers a listener so that any changes will
2367
+ * update `current`.
2302
2368
  * @param queryId The Id of the Query (or a getter returning it).
2303
2369
  * @param rowId The Id of the Row (or a getter returning it).
2304
2370
  * @param cellId The Id of the Cell (or a getter returning it).
2305
2371
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2306
2372
  * Id.
2307
2373
  * @returns A reactive object with a `current` Cell | undefined property.
2308
- * @category Hook
2374
+ * @category Getter
2309
2375
  * @since v8.1.0
2310
2376
  */
2311
- useResultCell: (
2377
+ getResultCell: (
2312
2378
  queryId: MaybeGetter<Id>,
2313
2379
  rowId: MaybeGetter<Id>,
2314
2380
  cellId: MaybeGetter<Id>,
@@ -2316,44 +2382,44 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2316
2382
  ) => {readonly current: ResultCell | undefined};
2317
2383
 
2318
2384
  /**
2319
- * The useRelationships hook returns the default Relationships object from the
2320
- * current Provider context (or a named one if an Id is provided).
2385
+ * The getRelationships function returns the default Relationships object from
2386
+ * the current Provider context (or a named one if an Id is provided).
2321
2387
  * @param id An optional Id of a named Relationships object in the Provider
2322
2388
  * context.
2323
2389
  * @returns The Relationships object, or `undefined` if not found.
2324
- * @category Hook
2390
+ * @category Getter
2325
2391
  * @since v8.1.0
2326
2392
  */
2327
- useRelationships: (id?: Id) => Relationships<Schemas> | undefined;
2393
+ getRelationships: (id?: Id) => Relationships<Schemas> | undefined;
2328
2394
 
2329
2395
  /**
2330
- * The useRelationshipsOrRelationshipsById hook is used to get a reference to a
2396
+ * The resolveRelationships function is used to get a reference to a
2331
2397
  * Relationships object from a Provider context, or have it passed directly.
2332
2398
  * @param relationshipsOrRelationshipsId The Relationships object, its Id, or a
2333
2399
  * getter returning either.
2334
2400
  * @returns A getter function returning the Relationships object, or
2335
2401
  * `undefined`.
2336
- * @category Hook
2402
+ * @category Getter
2337
2403
  * @since v8.1.0
2338
2404
  */
2339
- useRelationshipsOrRelationshipsById: (
2405
+ resolveRelationships: (
2340
2406
  relationshipsOrRelationshipsId?: MaybeGetter<
2341
2407
  RelationshipsOrRelationshipsId<Schemas> | undefined
2342
2408
  >,
2343
2409
  ) => () => Relationships<Schemas> | undefined;
2344
2410
 
2345
2411
  /**
2346
- * The useRelationshipsStoreTableIds hook returns the Store, local table Id, and
2347
- * remote table Id for a given Relationships object and relationship Id.
2412
+ * The getRelationshipsStoreTableIds function returns the Store, local table Id,
2413
+ * and remote table Id for a given Relationships object and relationship Id.
2348
2414
  * @param relationshipsOrId The Relationships object, its Id, or a getter
2349
2415
  * returning either.
2350
2416
  * @param relationshipId The Id of the relationship, or a getter returning it.
2351
2417
  * @returns An object with `store`, `localTableId`, and `remoteTableId` getter
2352
2418
  * properties.
2353
- * @category Hook
2419
+ * @category Getter
2354
2420
  * @since v8.1.0
2355
2421
  */
2356
- useRelationshipsStoreTableIds: (
2422
+ getRelationshipsStoreTableIds: (
2357
2423
  relationshipsOrId: MaybeGetter<
2358
2424
  RelationshipsOrRelationshipsId<Schemas> | undefined
2359
2425
  >,
@@ -2365,221 +2431,221 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2365
2431
  };
2366
2432
 
2367
2433
  /**
2368
- * The useRelationshipsIds hook returns a reactive object with the Ids of all
2369
- * Relationships objects registered in the current Provider context.
2434
+ * The getRelationshipsIds function returns a reactive object with the Ids of
2435
+ * all Relationships objects registered in the current Provider context.
2370
2436
  * @returns A reactive object with a `current` Ids property.
2371
- * @category Hook
2437
+ * @category Getter
2372
2438
  * @since v8.1.0
2373
2439
  */
2374
- useRelationshipsIds: () => {readonly current: Ids};
2440
+ getRelationshipsIds: () => {readonly current: Ids};
2375
2441
 
2376
2442
  /**
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`.
2443
+ * The getRelationshipIds function returns a reactive object reflecting the Ids
2444
+ * of the Relationships in a Relationships object, and registers a listener so
2445
+ * that any changes will update `current`.
2380
2446
  * @param relationshipsOrRelationshipsId The Relationships object to use, or its
2381
2447
  * Id.
2382
2448
  * @returns A reactive object with a `current` Ids property.
2383
- * @category Hook
2449
+ * @category Getter
2384
2450
  * @since v8.1.0
2385
2451
  */
2386
- useRelationshipIds: (
2452
+ getRelationshipIds: (
2387
2453
  relationshipsOrRelationshipsId?: MaybeGetter<
2388
2454
  RelationshipsOrRelationshipsId<Schemas> | undefined
2389
2455
  >,
2390
2456
  ) => {readonly current: Ids};
2391
2457
 
2392
2458
  /**
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`.
2459
+ * The getRemoteRowId function returns a reactive object reflecting the remote
2460
+ * Row Id for a given local Row in a Relationship, and registers a listener so
2461
+ * that any changes will update `current`.
2396
2462
  * @param relationshipId The Id of the Relationship (or a getter returning it).
2397
2463
  * @param localRowId The Id of the local Row (or a getter returning it).
2398
2464
  * @param relationshipsOrRelationshipsId The Relationships object to use (plain
2399
2465
  * or getter), or its Id.
2400
2466
  * @returns A reactive object with a `current` Id | undefined property.
2401
- * @category Hook
2467
+ * @category Getter
2402
2468
  * @since v8.1.0
2403
2469
  */
2404
- useRemoteRowId: (
2470
+ getRemoteRowId: (
2405
2471
  relationshipId: MaybeGetter<Id>,
2406
2472
  localRowId: MaybeGetter<Id>,
2407
2473
  relationshipsOrRelationshipsId?: RelationshipsOrRelationshipsId<Schemas>,
2408
2474
  ) => {readonly current: Id | undefined};
2409
2475
 
2410
2476
  /**
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
2413
- * that any changes will update `.current`.
2477
+ * The getLocalRowIds function returns a reactive object reflecting the local
2478
+ * Row Ids for a given remote Row in a Relationship, and registers a listener so
2479
+ * that any changes will update `current`.
2414
2480
  * @param relationshipId The Id of the Relationship (or a getter returning it).
2415
2481
  * @param remoteRowId The Id of the remote Row (or a getter returning it).
2416
2482
  * @param relationshipsOrRelationshipsId The Relationships object to use (plain
2417
2483
  * or getter), or its Id.
2418
2484
  * @returns A reactive object with a `current` Ids property.
2419
- * @category Hook
2485
+ * @category Getter
2420
2486
  * @since v8.1.0
2421
2487
  */
2422
- useLocalRowIds: (
2488
+ getLocalRowIds: (
2423
2489
  relationshipId: MaybeGetter<Id>,
2424
2490
  remoteRowId: MaybeGetter<Id>,
2425
2491
  relationshipsOrRelationshipsId?: RelationshipsOrRelationshipsId<Schemas>,
2426
2492
  ) => {readonly current: Ids};
2427
2493
 
2428
2494
  /**
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`.
2495
+ * The getLinkedRowIds function returns a reactive object reflecting the linked
2496
+ * Row Ids in a Relationship, and registers a listener so that any changes will
2497
+ * update `current`.
2432
2498
  * @param relationshipId The Id of the Relationship (or a getter returning it).
2433
2499
  * @param firstRowId The Id of the first Row (or a getter returning it).
2434
2500
  * @param relationshipsOrRelationshipsId The Relationships object to use (plain
2435
2501
  * or getter), or its Id.
2436
2502
  * @returns A reactive object with a `current` Ids property.
2437
- * @category Hook
2503
+ * @category Getter
2438
2504
  * @since v8.1.0
2439
2505
  */
2440
- useLinkedRowIds: (
2506
+ getLinkedRowIds: (
2441
2507
  relationshipId: MaybeGetter<Id>,
2442
2508
  firstRowId: MaybeGetter<Id>,
2443
2509
  relationshipsOrRelationshipsId?: RelationshipsOrRelationshipsId<Schemas>,
2444
2510
  ) => {readonly current: Ids};
2445
2511
 
2446
2512
  /**
2447
- * The useCheckpoints hook returns the default Checkpoints object from the
2513
+ * The getCheckpoints function returns the default Checkpoints object from the
2448
2514
  * current Provider context (or a named one if an Id is provided).
2449
2515
  * @param id An optional Id of a named Checkpoints object in the Provider
2450
2516
  * context.
2451
2517
  * @returns The Checkpoints object, or `undefined` if not found.
2452
- * @category Hook
2518
+ * @category Getter
2453
2519
  * @since v8.1.0
2454
2520
  */
2455
- useCheckpoints: (id?: Id) => Checkpoints<Schemas> | undefined;
2521
+ getCheckpoints: (id?: Id) => Checkpoints<Schemas> | undefined;
2456
2522
 
2457
2523
  /**
2458
- * The useCheckpointsOrCheckpointsById hook is used to get a reference to a
2459
- * Checkpoints object from a Provider context, or have it passed directly.
2524
+ * The resolveCheckpoints function is used to get a reference to a Checkpoints
2525
+ * object from a Provider context, or have it passed directly.
2460
2526
  * @param checkpointsOrCheckpointsId The Checkpoints object, its Id, or a getter
2461
2527
  * returning either.
2462
2528
  * @returns A getter function returning the Checkpoints object, or `undefined`.
2463
- * @category Hook
2529
+ * @category Getter
2464
2530
  * @since v8.1.0
2465
2531
  */
2466
- useCheckpointsOrCheckpointsById: (
2532
+ resolveCheckpoints: (
2467
2533
  checkpointsOrCheckpointsId?: MaybeGetter<
2468
2534
  CheckpointsOrCheckpointsId<Schemas> | undefined
2469
2535
  >,
2470
2536
  ) => () => Checkpoints<Schemas> | undefined;
2471
2537
 
2472
2538
  /**
2473
- * The useCheckpointsIds hook returns a reactive object with the Ids of all
2539
+ * The getCheckpointsIds function returns a reactive object with the Ids of all
2474
2540
  * Checkpoints objects registered in the current Provider context.
2475
2541
  * @returns A reactive object with a `current` Ids property.
2476
- * @category Hook
2542
+ * @category Getter
2477
2543
  * @since v8.1.0
2478
2544
  */
2479
- useCheckpointsIds: () => {readonly current: Ids};
2545
+ getCheckpointsIds: () => {readonly current: Ids};
2480
2546
 
2481
2547
  /**
2482
- * The useCheckpointIds hook returns a reactive object reflecting the
2548
+ * The getCheckpointIds function returns a reactive object reflecting the
2483
2549
  * CheckpointIds (backward, current, forward) in a Checkpoints object, and
2484
- * registers a listener so that any changes will update `.current`.
2550
+ * registers a listener so that any changes will update `current`.
2485
2551
  * @param checkpointsOrCheckpointsId The Checkpoints object to use (plain or
2486
2552
  * getter), or its Id.
2487
2553
  * @returns A reactive object with a `current` CheckpointIds property.
2488
- * @category Hook
2554
+ * @category Getter
2489
2555
  * @since v8.1.0
2490
2556
  */
2491
- useCheckpointIds: (
2557
+ getCheckpointIds: (
2492
2558
  checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId<Schemas>,
2493
2559
  ) => {readonly current: CheckpointIds};
2494
2560
 
2495
2561
  /**
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`.
2562
+ * The getCheckpoint function returns a reactive object reflecting the label of
2563
+ * a checkpoint, and registers a listener so that any changes will update
2564
+ * `current`.
2499
2565
  * @param checkpointId The Id of the checkpoint (or a getter returning it).
2500
2566
  * @param checkpointsOrCheckpointsId The Checkpoints object to use (plain or
2501
2567
  * getter), or its Id.
2502
2568
  * @returns A reactive object with a `current` string | undefined property.
2503
- * @category Hook
2569
+ * @category Getter
2504
2570
  * @since v8.1.0
2505
2571
  */
2506
- useCheckpoint: (
2572
+ getCheckpoint: (
2507
2573
  checkpointId: MaybeGetter<Id>,
2508
2574
  checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId<Schemas>,
2509
2575
  ) => {readonly current: string | undefined};
2510
2576
 
2511
2577
  /**
2512
- * The useGoBackwardCallback hook returns a callback function that, when called,
2513
- * moves the Checkpoints object backward to the previous checkpoint.
2578
+ * The createGoBackwardCallback function returns a callback function that, when
2579
+ * called, moves the Checkpoints object backward to the previous checkpoint.
2514
2580
  * @param checkpointsOrCheckpointsId The Checkpoints object to use, or its Id.
2515
2581
  * @returns A callback function.
2516
- * @category Hook
2582
+ * @category Callback
2517
2583
  * @since v8.1.0
2518
2584
  */
2519
- useGoBackwardCallback: (
2585
+ createGoBackwardCallback: (
2520
2586
  checkpointsOrCheckpointsId?: MaybeGetter<
2521
2587
  CheckpointsOrCheckpointsId<Schemas> | undefined
2522
2588
  >,
2523
2589
  ) => () => void;
2524
2590
 
2525
2591
  /**
2526
- * The useGoForwardCallback hook returns a callback function that, when called,
2527
- * moves the Checkpoints object forward to the next checkpoint.
2592
+ * The createGoForwardCallback function returns a callback function that, when
2593
+ * called, moves the Checkpoints object forward to the next checkpoint.
2528
2594
  * @param checkpointsOrCheckpointsId The Checkpoints object to use, or its Id.
2529
2595
  * @returns A callback function.
2530
- * @category Hook
2596
+ * @category Callback
2531
2597
  * @since v8.1.0
2532
2598
  */
2533
- useGoForwardCallback: (
2599
+ createGoForwardCallback: (
2534
2600
  checkpointsOrCheckpointsId?: MaybeGetter<
2535
2601
  CheckpointsOrCheckpointsId<Schemas> | undefined
2536
2602
  >,
2537
2603
  ) => () => void;
2538
2604
 
2539
2605
  /**
2540
- * The usePersister hook returns the default Persister from the current Provider
2541
- * context (or a named one if an Id is provided).
2606
+ * The getPersister function returns the default Persister from the current
2607
+ * Provider context (or a named one if an Id is provided).
2542
2608
  * @param id An optional Id of a named Persister in the Provider context.
2543
2609
  * @returns The Persister, or `undefined` if not found.
2544
- * @category Hook
2610
+ * @category Getter
2545
2611
  * @since v8.1.0
2546
2612
  */
2547
- usePersister: (id?: Id) => AnyPersister<Schemas> | undefined;
2613
+ getPersister: (id?: Id) => AnyPersister<Schemas> | undefined;
2548
2614
 
2549
2615
  /**
2550
- * The usePersisterOrPersisterById hook is used to get a reference to a
2551
- * Persister object from a Provider context, or have it passed directly.
2616
+ * The resolvePersister function is used to get a reference to a Persister
2617
+ * object from a Provider context, or have it passed directly.
2552
2618
  * @param persisterOrPersisterId The Persister object, its Id, or a getter
2553
2619
  * returning either.
2554
2620
  * @returns A getter function returning the Persister object, or `undefined`.
2555
- * @category Hook
2621
+ * @category Getter
2556
2622
  * @since v8.1.0
2557
2623
  */
2558
- usePersisterOrPersisterById: (
2624
+ resolvePersister: (
2559
2625
  persisterOrPersisterId?: MaybeGetter<
2560
2626
  PersisterOrPersisterId<Schemas> | undefined
2561
2627
  >,
2562
2628
  ) => () => AnyPersister<Schemas> | undefined;
2563
2629
 
2564
2630
  /**
2565
- * The usePersisterIds hook returns a reactive object with the Ids of all
2631
+ * The getPersisterIds function returns a reactive object with the Ids of all
2566
2632
  * Persisters registered in the current Provider context.
2567
2633
  * @returns A reactive object with a `current` Ids property.
2568
- * @category Hook
2634
+ * @category Getter
2569
2635
  * @since v8.1.0
2570
2636
  */
2571
- usePersisterIds: () => {readonly current: Ids};
2637
+ getPersisterIds: () => {readonly current: Ids};
2572
2638
 
2573
2639
  /**
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`.
2640
+ * The getPersisterStatus function returns a reactive object reflecting the
2641
+ * status of a Persister, and registers a listener so that any changes will
2642
+ * update `current`.
2577
2643
  * @param persisterOrPersisterId The Persister to use, or its Id.
2578
2644
  * @returns A reactive object with a `current` Status property.
2579
- * @category Hook
2645
+ * @category Getter
2580
2646
  * @since v8.1.0
2581
2647
  */
2582
- usePersisterStatus: (
2648
+ getPersisterStatus: (
2583
2649
  persisterOrPersisterId?: MaybeGetter<
2584
2650
  PersisterOrPersisterId<Schemas> | undefined
2585
2651
  >,
@@ -2588,106 +2654,105 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2588
2654
  };
2589
2655
 
2590
2656
  /**
2591
- * The useSynchronizer hook returns the default Synchronizer from the current
2592
- * Provider context (or a named one if an Id is provided).
2657
+ * The getSynchronizer function returns the default Synchronizer from the
2658
+ * current Provider context (or a named one if an Id is provided).
2593
2659
  * @param id An optional Id of a named Synchronizer in the Provider context.
2594
2660
  * @returns The Synchronizer, or `undefined` if not found.
2595
- * @category Hook
2661
+ * @category Getter
2596
2662
  * @since v8.1.0
2597
2663
  */
2598
- useSynchronizer: (id?: Id) => Synchronizer<Schemas> | undefined;
2664
+ getSynchronizer: (id?: Id) => Synchronizer<Schemas> | undefined;
2599
2665
 
2600
2666
  /**
2601
- * The useSynchronizerOrSynchronizerById hook is used to get a reference to a
2602
- * Synchronizer object from a Provider context, or have it passed directly.
2667
+ * The resolveSynchronizer function is used to get a reference to a Synchronizer
2668
+ * object from a Provider context, or have it passed directly.
2603
2669
  * @param synchronizerOrSynchronizerId The Synchronizer object, its Id, or a
2604
2670
  * getter returning either.
2605
2671
  * @returns A getter function returning the Synchronizer object, or `undefined`.
2606
- * @category Hook
2672
+ * @category Getter
2607
2673
  * @since v8.1.0
2608
2674
  */
2609
- useSynchronizerOrSynchronizerById: (
2675
+ resolveSynchronizer: (
2610
2676
  synchronizerOrSynchronizerId?: MaybeGetter<
2611
2677
  SynchronizerOrSynchronizerId<Schemas> | undefined
2612
2678
  >,
2613
2679
  ) => () => Synchronizer<Schemas> | undefined;
2614
2680
 
2615
2681
  /**
2616
- * The useSynchronizerIds hook returns a reactive object with the Ids of all
2682
+ * The getSynchronizerIds function returns a reactive object with the Ids of all
2617
2683
  * Synchronizers registered in the current Provider context.
2618
2684
  * @returns A reactive object with a `current` Ids property.
2619
- * @category Hook
2685
+ * @category Getter
2620
2686
  * @since v8.1.0
2621
2687
  */
2622
- useSynchronizerIds: () => {readonly current: Ids};
2688
+ getSynchronizerIds: () => {readonly current: Ids};
2623
2689
 
2624
2690
  /**
2625
- * The useSynchronizerStatus hook returns a reactive object reflecting the
2691
+ * The getSynchronizerStatus function returns a reactive object reflecting the
2626
2692
  * status of a Synchronizer, and registers a listener so that any changes will
2627
- * update `.current`.
2693
+ * update `current`.
2628
2694
  * @param synchronizerOrSynchronizerId The Synchronizer to use, or its Id.
2629
2695
  * @returns A reactive object with a `current` Status property.
2630
- * @category Hook
2696
+ * @category Getter
2631
2697
  * @since v8.1.0
2632
2698
  */
2633
- useSynchronizerStatus: (
2699
+ getSynchronizerStatus: (
2634
2700
  synchronizerOrSynchronizerId?: MaybeGetter<
2635
2701
  SynchronizerOrSynchronizerId<Schemas> | undefined
2636
2702
  >,
2637
2703
  ) => {readonly current: Status};
2638
2704
 
2639
2705
  /**
2640
- * The useHasTablesListener hook registers a listener that is called whenever
2641
- * any Tables are added to or removed from the Store. The listener is tied to
2642
- * the component's `$effect` lifecycle and is removed when the component
2643
- * unmounts.
2706
+ * The onHasTables function registers a listener that is called whenever any
2707
+ * Tables are added to or removed from the Store. The listener is tied to the
2708
+ * component's `$effect` lifecycle and is removed when the component unmounts.
2644
2709
  * @param listener The function to call when table presence changes.
2645
2710
  * @param mutator An optional boolean indicating the listener mutates Store
2646
2711
  * data.
2647
2712
  * @param storeOrStoreId The Store to use, or its Id.
2648
- * @category Hook
2713
+ * @category Listener
2649
2714
  * @since v8.1.0
2650
2715
  */
2651
- useHasTablesListener: (
2716
+ onHasTables: (
2652
2717
  listener: HasTablesListener<Schemas>,
2653
2718
  mutator?: boolean,
2654
2719
  storeOrStoreId?: StoreOrStoreId<Schemas>,
2655
2720
  ) => void;
2656
2721
 
2657
2722
  /**
2658
- * The useTablesListener hook registers a listener that is called whenever
2659
- * tabular data in the Store changes.
2723
+ * The onTables function registers a listener that is called whenever tabular
2724
+ * data in the Store changes.
2660
2725
  * @param listener The function to call when Tables change.
2661
2726
  * @param mutator An optional boolean indicating the listener mutates Store
2662
2727
  * data.
2663
2728
  * @param storeOrStoreId The Store to use, or its Id.
2664
- * @category Hook
2729
+ * @category Listener
2665
2730
  * @since v8.1.0
2666
2731
  */
2667
- useTablesListener: (
2732
+ onTables: (
2668
2733
  listener: TablesListener<Schemas>,
2669
2734
  mutator?: boolean,
2670
2735
  storeOrStoreId?: StoreOrStoreId<Schemas>,
2671
2736
  ) => void;
2672
2737
 
2673
2738
  /**
2674
- * The useTableIdsListener hook registers a listener that is called whenever the
2675
- * set of Table Ids in the Store changes.
2739
+ * The onTableIds function registers a listener that is called whenever the set
2740
+ * of Table Ids in the Store changes.
2676
2741
  * @param listener The function to call when Table Ids change.
2677
2742
  * @param mutator An optional boolean indicating the listener mutates Store
2678
2743
  * data.
2679
2744
  * @param storeOrStoreId The Store to use, or its Id.
2680
- * @category Hook
2745
+ * @category Listener
2681
2746
  * @since v8.1.0
2682
2747
  */
2683
- useTableIdsListener: (
2748
+ onTableIds: (
2684
2749
  listener: TableIdsListener<Schemas>,
2685
2750
  mutator?: boolean,
2686
2751
  storeOrStoreId?: StoreOrStoreId<Schemas>,
2687
2752
  ) => void;
2688
2753
 
2689
2754
  /**
2690
- * The useHasTableListener hook registers a listener that is called whenever a
2755
+ * The onHasTable function registers a listener that is called whenever a
2691
2756
  * specified Table is added to or removed from the Store.
2692
2757
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2693
2758
  * Table.
@@ -2695,12 +2760,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2695
2760
  * @param mutator An optional boolean indicating the listener mutates Store
2696
2761
  * data.
2697
2762
  * @param storeOrStoreId The Store to use, or its Id.
2698
- * @category Hook
2763
+ * @category Listener
2699
2764
  * @since v8.1.0
2700
2765
  */
2701
- useHasTableListener: <
2702
- TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2703
- >(
2766
+ onHasTable: <TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null>(
2704
2767
  tableId: MaybeGetter<TableIdOrNull>,
2705
2768
  listener: HasTableListener<Schemas, TableIdOrNull>,
2706
2769
  mutator?: boolean,
@@ -2708,20 +2771,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2708
2771
  ) => void;
2709
2772
 
2710
2773
  /**
2711
- * The useTableListener hook registers a listener that is called whenever data
2712
- * in a specified Table changes.
2774
+ * The onTable function registers a listener that is called whenever data in a
2775
+ * specified Table changes.
2713
2776
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2714
2777
  * Table.
2715
2778
  * @param listener The function to call when the Table changes.
2716
2779
  * @param mutator An optional boolean indicating the listener mutates Store
2717
2780
  * data.
2718
2781
  * @param storeOrStoreId The Store to use, or its Id.
2719
- * @category Hook
2782
+ * @category Listener
2720
2783
  * @since v8.1.0
2721
2784
  */
2722
- useTableListener: <
2723
- TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2724
- >(
2785
+ onTable: <TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null>(
2725
2786
  tableId: MaybeGetter<TableIdOrNull>,
2726
2787
  listener: TableListener<Schemas, TableIdOrNull>,
2727
2788
  mutator?: boolean,
@@ -2729,20 +2790,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2729
2790
  ) => void;
2730
2791
 
2731
2792
  /**
2732
- * The useTableCellIdsListener hook registers a listener that is called whenever
2733
- * the Cell Ids used across a Table change.
2793
+ * The onTableCellIds function registers a listener that is called whenever the
2794
+ * Cell Ids used across a Table change.
2734
2795
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2735
2796
  * Table.
2736
2797
  * @param listener The function to call when Cell Ids change.
2737
2798
  * @param mutator An optional boolean indicating the listener mutates Store
2738
2799
  * data.
2739
2800
  * @param storeOrStoreId The Store to use, or its Id.
2740
- * @category Hook
2801
+ * @category Listener
2741
2802
  * @since v8.1.0
2742
2803
  */
2743
- useTableCellIdsListener: <
2744
- TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2745
- >(
2804
+ onTableCellIds: <TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null>(
2746
2805
  tableId: MaybeGetter<TableIdOrNull>,
2747
2806
  listener: TableCellIdsListener<Schemas, TableIdOrNull>,
2748
2807
  mutator?: boolean,
@@ -2750,8 +2809,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2750
2809
  ) => void;
2751
2810
 
2752
2811
  /**
2753
- * The useHasTableCellListener hook registers a listener that is called whenever
2754
- * a specified Cell Id is added to or removed from across a Table.
2812
+ * The onHasTableCell function registers a listener that is called whenever a
2813
+ * specified Cell Id is added to or removed from across a Table.
2755
2814
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2756
2815
  * Table.
2757
2816
  * @param cellId The Id of the Cell to listen to, or `null` to listen to any
@@ -2760,10 +2819,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2760
2819
  * @param mutator An optional boolean indicating the listener mutates Store
2761
2820
  * data.
2762
2821
  * @param storeOrStoreId The Store to use, or its Id.
2763
- * @category Hook
2822
+ * @category Listener
2764
2823
  * @since v8.1.0
2765
2824
  */
2766
- useHasTableCellListener: <
2825
+ onHasTableCell: <
2767
2826
  TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2768
2827
  CellIdOrNull extends
2769
2828
  | (TableIdOrNull extends TableIdFromSchema<Schemas[0]>
@@ -2779,7 +2838,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2779
2838
  ) => void;
2780
2839
 
2781
2840
  /**
2782
- * The useRowCountListener hook registers a listener that is called whenever the
2841
+ * The onRowCount function registers a listener that is called whenever the
2783
2842
  * count of Rows in a Table changes.
2784
2843
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2785
2844
  * Table.
@@ -2787,12 +2846,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2787
2846
  * @param mutator An optional boolean indicating the listener mutates Store
2788
2847
  * data.
2789
2848
  * @param storeOrStoreId The Store to use, or its Id.
2790
- * @category Hook
2849
+ * @category Listener
2791
2850
  * @since v8.1.0
2792
2851
  */
2793
- useRowCountListener: <
2794
- TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2795
- >(
2852
+ onRowCount: <TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null>(
2796
2853
  tableId: MaybeGetter<TableIdOrNull>,
2797
2854
  listener: RowCountListener<Schemas, TableIdOrNull>,
2798
2855
  mutator?: boolean,
@@ -2800,20 +2857,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2800
2857
  ) => void;
2801
2858
 
2802
2859
  /**
2803
- * The useRowIdsListener hook registers a listener that is called whenever the
2804
- * Row Ids in a Table change.
2860
+ * The onRowIds function registers a listener that is called whenever the Row
2861
+ * Ids in a Table change.
2805
2862
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2806
2863
  * Table.
2807
2864
  * @param listener The function to call when Row Ids change.
2808
2865
  * @param mutator An optional boolean indicating the listener mutates Store
2809
2866
  * data.
2810
2867
  * @param storeOrStoreId The Store to use, or its Id.
2811
- * @category Hook
2868
+ * @category Listener
2812
2869
  * @since v8.1.0
2813
2870
  */
2814
- useRowIdsListener: <
2815
- TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2816
- >(
2871
+ onRowIds: <TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null>(
2817
2872
  tableId: MaybeGetter<TableIdOrNull>,
2818
2873
  listener: RowIdsListener<Schemas, TableIdOrNull>,
2819
2874
  mutator?: boolean,
@@ -2821,8 +2876,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2821
2876
  ) => void;
2822
2877
 
2823
2878
  /**
2824
- * The useSortedRowIdsListener hook registers a listener that is called whenever
2825
- * the sorted Row Ids in a Table change.
2879
+ * The onSortedRowIds function registers a listener that is called whenever the
2880
+ * sorted Row Ids in a Table change.
2826
2881
  * @param tableId The Id of the Table to listen to.
2827
2882
  * @param cellId The Id of the Cell to sort by, or `undefined` for default
2828
2883
  * order.
@@ -2833,10 +2888,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2833
2888
  * @param mutator An optional boolean indicating the listener mutates Store
2834
2889
  * data.
2835
2890
  * @param storeOrStoreId The Store to use, or its Id.
2836
- * @category Hook
2891
+ * @category Listener
2837
2892
  * @since v8.1.0
2838
2893
  */
2839
- useSortedRowIdsListener: <
2894
+ onSortedRowIds: <
2840
2895
  TableId extends TableIdFromSchema<Schemas[0]>,
2841
2896
  CellIdOrUndefined extends CellIdFromSchema<Schemas[0], TableId> | undefined,
2842
2897
  >(
@@ -2851,7 +2906,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2851
2906
  ) => void;
2852
2907
 
2853
2908
  /**
2854
- * The useHasRowListener hook registers a listener that is called whenever a
2909
+ * The onHasRow function registers a listener that is called whenever a
2855
2910
  * specified Row is added to or removed from a Table.
2856
2911
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2857
2912
  * Table.
@@ -2860,10 +2915,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2860
2915
  * @param mutator An optional boolean indicating the listener mutates Store
2861
2916
  * data.
2862
2917
  * @param storeOrStoreId The Store to use, or its Id.
2863
- * @category Hook
2918
+ * @category Listener
2864
2919
  * @since v8.1.0
2865
2920
  */
2866
- useHasRowListener: <
2921
+ onHasRow: <
2867
2922
  TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2868
2923
  RowIdOrNull extends IdOrNull,
2869
2924
  >(
@@ -2875,8 +2930,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2875
2930
  ) => void;
2876
2931
 
2877
2932
  /**
2878
- * The useRowListener hook registers a listener that is called whenever data in
2879
- * a specified Row changes.
2933
+ * The onRow function registers a listener that is called whenever data in a
2934
+ * specified Row changes.
2880
2935
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2881
2936
  * Table.
2882
2937
  * @param rowId The Id of the Row to listen to, or `null` to listen to any Row.
@@ -2884,10 +2939,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2884
2939
  * @param mutator An optional boolean indicating the listener mutates Store
2885
2940
  * data.
2886
2941
  * @param storeOrStoreId The Store to use, or its Id.
2887
- * @category Hook
2942
+ * @category Listener
2888
2943
  * @since v8.1.0
2889
2944
  */
2890
- useRowListener: <
2945
+ onRow: <
2891
2946
  TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2892
2947
  RowIdOrNull extends IdOrNull,
2893
2948
  >(
@@ -2899,8 +2954,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2899
2954
  ) => void;
2900
2955
 
2901
2956
  /**
2902
- * The useCellIdsListener hook registers a listener that is called whenever the
2903
- * Cell Ids in a Row change.
2957
+ * The onCellIds function registers a listener that is called whenever the Cell
2958
+ * Ids in a Row change.
2904
2959
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2905
2960
  * Table.
2906
2961
  * @param rowId The Id of the Row to listen to, or `null` to listen to any Row.
@@ -2908,10 +2963,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2908
2963
  * @param mutator An optional boolean indicating the listener mutates Store
2909
2964
  * data.
2910
2965
  * @param storeOrStoreId The Store to use, or its Id.
2911
- * @category Hook
2966
+ * @category Listener
2912
2967
  * @since v8.1.0
2913
2968
  */
2914
- useCellIdsListener: <
2969
+ onCellIds: <
2915
2970
  TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2916
2971
  RowIdOrNull extends IdOrNull,
2917
2972
  >(
@@ -2923,7 +2978,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2923
2978
  ) => void;
2924
2979
 
2925
2980
  /**
2926
- * The useHasCellListener hook registers a listener that is called whenever a
2981
+ * The onHasCell function registers a listener that is called whenever a
2927
2982
  * specified Cell is added to or removed from a Row.
2928
2983
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2929
2984
  * Table.
@@ -2934,10 +2989,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2934
2989
  * @param mutator An optional boolean indicating the listener mutates Store
2935
2990
  * data.
2936
2991
  * @param storeOrStoreId The Store to use, or its Id.
2937
- * @category Hook
2992
+ * @category Listener
2938
2993
  * @since v8.1.0
2939
2994
  */
2940
- useHasCellListener: <
2995
+ onHasCell: <
2941
2996
  TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2942
2997
  RowIdOrNull extends IdOrNull,
2943
2998
  CellIdOrNull extends
@@ -2960,8 +3015,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2960
3015
  ) => void;
2961
3016
 
2962
3017
  /**
2963
- * The useCellListener hook registers a listener that is called whenever the
2964
- * value of a specified Cell changes.
3018
+ * The onCell function registers a listener that is called whenever the value of
3019
+ * a specified Cell changes.
2965
3020
  * @param tableId The Id of the Table to listen to, or `null` to listen to any
2966
3021
  * Table.
2967
3022
  * @param rowId The Id of the Row to listen to, or `null` to listen to any Row.
@@ -2971,10 +3026,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2971
3026
  * @param mutator An optional boolean indicating the listener mutates Store
2972
3027
  * data.
2973
3028
  * @param storeOrStoreId The Store to use, or its Id.
2974
- * @category Hook
3029
+ * @category Listener
2975
3030
  * @since v8.1.0
2976
3031
  */
2977
- useCellListener: <
3032
+ onCell: <
2978
3033
  TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
2979
3034
  RowIdOrNull extends IdOrNull,
2980
3035
  CellIdOrNull extends
@@ -2992,55 +3047,55 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2992
3047
  ) => void;
2993
3048
 
2994
3049
  /**
2995
- * The useHasValuesListener hook registers a listener that is called whenever
2996
- * any Values are added to or removed from the Store.
3050
+ * The onHasValues function registers a listener that is called whenever any
3051
+ * Values are added to or removed from the Store.
2997
3052
  * @param listener The function to call when value presence changes.
2998
3053
  * @param mutator An optional boolean indicating the listener mutates Store
2999
3054
  * data.
3000
3055
  * @param storeOrStoreId The Store to use, or its Id.
3001
- * @category Hook
3056
+ * @category Listener
3002
3057
  * @since v8.1.0
3003
3058
  */
3004
- useHasValuesListener: (
3059
+ onHasValues: (
3005
3060
  listener: HasValuesListener<Schemas>,
3006
3061
  mutator?: boolean,
3007
3062
  storeOrStoreId?: StoreOrStoreId<Schemas>,
3008
3063
  ) => void;
3009
3064
 
3010
3065
  /**
3011
- * The useValuesListener hook registers a listener that is called whenever any
3012
- * Values in the Store change.
3066
+ * The onValues function registers a listener that is called whenever any Values
3067
+ * in the Store change.
3013
3068
  * @param listener The function to call when Values change.
3014
3069
  * @param mutator An optional boolean indicating the listener mutates Store
3015
3070
  * data.
3016
3071
  * @param storeOrStoreId The Store to use, or its Id.
3017
- * @category Hook
3072
+ * @category Listener
3018
3073
  * @since v8.1.0
3019
3074
  */
3020
- useValuesListener: (
3075
+ onValues: (
3021
3076
  listener: ValuesListener<Schemas>,
3022
3077
  mutator?: boolean,
3023
3078
  storeOrStoreId?: StoreOrStoreId<Schemas>,
3024
3079
  ) => void;
3025
3080
 
3026
3081
  /**
3027
- * The useValueIdsListener hook registers a listener that is called whenever the
3082
+ * The onValueIds function registers a listener that is called whenever the
3028
3083
  * Value Ids in the Store change.
3029
3084
  * @param listener The function to call when Value Ids change.
3030
3085
  * @param mutator An optional boolean indicating the listener mutates Store
3031
3086
  * data.
3032
3087
  * @param storeOrStoreId The Store to use, or its Id.
3033
- * @category Hook
3088
+ * @category Listener
3034
3089
  * @since v8.1.0
3035
3090
  */
3036
- useValueIdsListener: (
3091
+ onValueIds: (
3037
3092
  listener: ValueIdsListener<Schemas>,
3038
3093
  mutator?: boolean,
3039
3094
  storeOrStoreId?: StoreOrStoreId<Schemas>,
3040
3095
  ) => void;
3041
3096
 
3042
3097
  /**
3043
- * The useHasValueListener hook registers a listener that is called whenever a
3098
+ * The onHasValue function registers a listener that is called whenever a
3044
3099
  * specified Value is added to or removed from the Store.
3045
3100
  * @param valueId The Id of the Value to listen to, or `null` to listen to any
3046
3101
  * Value.
@@ -3048,12 +3103,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3048
3103
  * @param mutator An optional boolean indicating the listener mutates Store
3049
3104
  * data.
3050
3105
  * @param storeOrStoreId The Store to use, or its Id.
3051
- * @category Hook
3106
+ * @category Listener
3052
3107
  * @since v8.1.0
3053
3108
  */
3054
- useHasValueListener: <
3055
- ValueIdOrNull extends ValueIdFromSchema<Schemas[1]> | null,
3056
- >(
3109
+ onHasValue: <ValueIdOrNull extends ValueIdFromSchema<Schemas[1]> | null>(
3057
3110
  valueId: MaybeGetter<ValueIdOrNull>,
3058
3111
  listener: HasValueListener<Schemas, ValueIdOrNull>,
3059
3112
  mutator?: boolean,
@@ -3061,20 +3114,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3061
3114
  ) => void;
3062
3115
 
3063
3116
  /**
3064
- * The useValueListener hook registers a listener that is called whenever the
3065
- * value of a specified Value changes.
3117
+ * The onValue function registers a listener that is called whenever the value
3118
+ * of a specified Value changes.
3066
3119
  * @param valueId The Id of the Value to listen to, or `null` to listen to any
3067
3120
  * Value.
3068
3121
  * @param listener The function to call when the Value changes.
3069
3122
  * @param mutator An optional boolean indicating the listener mutates Store
3070
3123
  * data.
3071
3124
  * @param storeOrStoreId The Store to use, or its Id.
3072
- * @category Hook
3125
+ * @category Listener
3073
3126
  * @since v8.1.0
3074
3127
  */
3075
- useValueListener: <
3076
- ValueIdOrNull extends ValueIdFromSchema<Schemas[1]> | null,
3077
- >(
3128
+ onValue: <ValueIdOrNull extends ValueIdFromSchema<Schemas[1]> | null>(
3078
3129
  valueId: MaybeGetter<ValueIdOrNull>,
3079
3130
  listener: ValueListener<Schemas, ValueIdOrNull>,
3080
3131
  mutator?: boolean,
@@ -3082,89 +3133,89 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3082
3133
  ) => void;
3083
3134
 
3084
3135
  /**
3085
- * The useStartTransactionListener hook registers a listener that is called at
3086
- * the start of every Store transaction.
3136
+ * The onStartTransaction function registers a listener that is called at the
3137
+ * start of every Store transaction.
3087
3138
  * @param listener The function to call at transaction start.
3088
3139
  * @param storeOrStoreId The Store to use, or its Id.
3089
- * @category Hook
3140
+ * @category Listener
3090
3141
  * @since v8.1.0
3091
3142
  */
3092
- useStartTransactionListener: (
3143
+ onStartTransaction: (
3093
3144
  listener: TransactionListener<Schemas>,
3094
3145
  storeOrStoreId?: StoreOrStoreId<Schemas>,
3095
3146
  ) => void;
3096
3147
 
3097
3148
  /**
3098
- * The useWillFinishTransactionListener hook registers a listener called just
3099
- * before a Store transaction completes.
3149
+ * The onWillFinishTransaction function registers a listener called just before
3150
+ * a Store transaction completes.
3100
3151
  * @param listener The function to call before transaction end.
3101
3152
  * @param storeOrStoreId The Store to use, or its Id.
3102
- * @category Hook
3153
+ * @category Listener
3103
3154
  * @since v8.1.0
3104
3155
  */
3105
- useWillFinishTransactionListener: (
3156
+ onWillFinishTransaction: (
3106
3157
  listener: TransactionListener<Schemas>,
3107
3158
  storeOrStoreId?: StoreOrStoreId<Schemas>,
3108
3159
  ) => void;
3109
3160
 
3110
3161
  /**
3111
- * The useDidFinishTransactionListener hook registers a listener called just
3112
- * after a Store transaction completes.
3162
+ * The onDidFinishTransaction function registers a listener called just after a
3163
+ * Store transaction completes.
3113
3164
  * @param listener The function to call after transaction end.
3114
3165
  * @param storeOrStoreId The Store to use, or its Id.
3115
- * @category Hook
3166
+ * @category Listener
3116
3167
  * @since v8.1.0
3117
3168
  */
3118
- useDidFinishTransactionListener: (
3169
+ onDidFinishTransaction: (
3119
3170
  listener: TransactionListener<Schemas>,
3120
3171
  storeOrStoreId?: StoreOrStoreId<Schemas>,
3121
3172
  ) => void;
3122
3173
 
3123
3174
  /**
3124
- * The useMetricListener hook registers a listener that is called whenever a
3175
+ * The onMetric function registers a listener that is called whenever a
3125
3176
  * specified Metric value changes.
3126
3177
  * @param metricId The Id of the Metric to listen to, or `null` to listen to any
3127
3178
  * Metric.
3128
3179
  * @param listener The function to call when the Metric changes.
3129
3180
  * @param metricsOrMetricsId The Metrics object to use, or its Id.
3130
- * @category Hook
3181
+ * @category Listener
3131
3182
  * @since v8.1.0
3132
3183
  */
3133
- useMetricListener: (
3184
+ onMetric: (
3134
3185
  metricId: MaybeGetter<IdOrNull>,
3135
3186
  listener: MetricListener<Schemas>,
3136
3187
  metricsOrMetricsId?: MetricsOrMetricsId<Schemas>,
3137
3188
  ) => void;
3138
3189
 
3139
3190
  /**
3140
- * The useSliceIdsListener hook registers a listener that is called whenever the
3191
+ * The onSliceIds function registers a listener that is called whenever the
3141
3192
  * Slice Ids in an Index change.
3142
3193
  * @param indexId The Id of the Index to listen to, or `null` to listen to any
3143
3194
  * Index.
3144
3195
  * @param listener The function to call when Slice Ids change.
3145
3196
  * @param indexesOrIndexesId The Indexes object to use, or its Id.
3146
- * @category Hook
3197
+ * @category Listener
3147
3198
  * @since v8.1.0
3148
3199
  */
3149
- useSliceIdsListener: (
3200
+ onSliceIds: (
3150
3201
  indexId: MaybeGetter<IdOrNull>,
3151
3202
  listener: SliceIdsListener<Schemas>,
3152
3203
  indexesOrIndexesId?: IndexesOrIndexesId<Schemas>,
3153
3204
  ) => void;
3154
3205
 
3155
3206
  /**
3156
- * The useSliceRowIdsListener hook registers a listener that is called whenever
3157
- * the Row Ids in a Slice change.
3207
+ * The onSliceRowIds function registers a listener that is called whenever the
3208
+ * Row Ids in a Slice change.
3158
3209
  * @param indexId The Id of the Index to listen to, or `null` to listen to any
3159
3210
  * Index.
3160
3211
  * @param sliceId The Id of the Slice to listen to, or `null` to listen to any
3161
3212
  * Slice.
3162
3213
  * @param listener The function to call when Slice Row Ids change.
3163
3214
  * @param indexesOrIndexesId The Indexes object to use, or its Id.
3164
- * @category Hook
3215
+ * @category Listener
3165
3216
  * @since v8.1.0
3166
3217
  */
3167
- useSliceRowIdsListener: (
3218
+ onSliceRowIds: (
3168
3219
  indexId: MaybeGetter<IdOrNull>,
3169
3220
  sliceId: MaybeGetter<IdOrNull>,
3170
3221
  listener: SliceRowIdsListener<Schemas>,
@@ -3172,8 +3223,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3172
3223
  ) => void;
3173
3224
 
3174
3225
  /**
3175
- * The useRemoteRowIdListener hook registers a listener that is called whenever
3176
- * the remote Row Id for a local Row changes.
3226
+ * The onRemoteRowId function registers a listener that is called whenever the
3227
+ * remote Row Id for a local Row changes.
3177
3228
  * @param relationshipId The Id of the Relationship, or `null` to listen to any
3178
3229
  * Relationship.
3179
3230
  * @param localRowId The Id of the local Row, or `null` to listen to any local
@@ -3181,10 +3232,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3181
3232
  * @param listener The function to call when the remote Row Id changes.
3182
3233
  * @param relationshipsOrRelationshipsId The Relationships object to use, or its
3183
3234
  * Id.
3184
- * @category Hook
3235
+ * @category Listener
3185
3236
  * @since v8.1.0
3186
3237
  */
3187
- useRemoteRowIdListener: (
3238
+ onRemoteRowId: (
3188
3239
  relationshipId: MaybeGetter<IdOrNull>,
3189
3240
  localRowId: MaybeGetter<IdOrNull>,
3190
3241
  listener: RemoteRowIdListener<Schemas>,
@@ -3192,8 +3243,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3192
3243
  ) => void;
3193
3244
 
3194
3245
  /**
3195
- * The useLocalRowIdsListener hook registers a listener that is called whenever
3196
- * the local Row Ids for a remote Row change.
3246
+ * The onLocalRowIds function registers a listener that is called whenever the
3247
+ * local Row Ids for a remote Row change.
3197
3248
  * @param relationshipId The Id of the Relationship, or `null` to listen to any
3198
3249
  * Relationship.
3199
3250
  * @param remoteRowId The Id of the remote Row, or `null` to listen to any
@@ -3201,10 +3252,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3201
3252
  * @param listener The function to call when local Row Ids change.
3202
3253
  * @param relationshipsOrRelationshipsId The Relationships object to use, or its
3203
3254
  * Id.
3204
- * @category Hook
3255
+ * @category Listener
3205
3256
  * @since v8.1.0
3206
3257
  */
3207
- useLocalRowIdsListener: (
3258
+ onLocalRowIds: (
3208
3259
  relationshipId: MaybeGetter<IdOrNull>,
3209
3260
  remoteRowId: MaybeGetter<IdOrNull>,
3210
3261
  listener: LocalRowIdsListener<Schemas>,
@@ -3212,17 +3263,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3212
3263
  ) => void;
3213
3264
 
3214
3265
  /**
3215
- * The useLinkedRowIdsListener hook registers a listener that is called whenever
3216
- * the linked Row Ids for a first Row change.
3266
+ * The onLinkedRowIds function registers a listener that is called whenever the
3267
+ * linked Row Ids for a first Row change.
3217
3268
  * @param relationshipId The Id of the Relationship.
3218
3269
  * @param firstRowId The Id of the first Row.
3219
3270
  * @param listener The function to call when linked Row Ids change.
3220
3271
  * @param relationshipsOrRelationshipsId The Relationships object to use, or its
3221
3272
  * Id.
3222
- * @category Hook
3273
+ * @category Listener
3223
3274
  * @since v8.1.0
3224
3275
  */
3225
- useLinkedRowIdsListener: (
3276
+ onLinkedRowIds: (
3226
3277
  relationshipId: MaybeGetter<Id>,
3227
3278
  firstRowId: MaybeGetter<Id>,
3228
3279
  listener: LinkedRowIdsListener<Schemas>,
@@ -3230,71 +3281,71 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3230
3281
  ) => void;
3231
3282
 
3232
3283
  /**
3233
- * The useResultTableListener hook registers a listener that is called whenever
3234
- * the result Table of a query changes.
3284
+ * The onResultTable function registers a listener that is called whenever the
3285
+ * result Table of a query changes.
3235
3286
  * @param queryId The Id of the query to listen to, or `null` to listen to any
3236
3287
  * query.
3237
3288
  * @param listener The function to call when the result Table changes.
3238
3289
  * @param queriesOrQueriesId The Queries object to use, or its Id.
3239
- * @category Hook
3290
+ * @category Listener
3240
3291
  * @since v8.1.0
3241
3292
  */
3242
- useResultTableListener: (
3293
+ onResultTable: (
3243
3294
  queryId: MaybeGetter<IdOrNull>,
3244
3295
  listener: ResultTableListener<Schemas>,
3245
3296
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
3246
3297
  ) => void;
3247
3298
 
3248
3299
  /**
3249
- * The useResultTableCellIdsListener hook registers a listener that is called
3300
+ * The onResultTableCellIds function registers a listener that is called
3250
3301
  * whenever the Cell Ids across a result Table change.
3251
3302
  * @param queryId The Id of the query to listen to, or `null` to listen to any
3252
3303
  * query.
3253
3304
  * @param listener The function to call when Cell Ids change.
3254
3305
  * @param queriesOrQueriesId The Queries object to use, or its Id.
3255
- * @category Hook
3306
+ * @category Listener
3256
3307
  * @since v8.1.0
3257
3308
  */
3258
- useResultTableCellIdsListener: (
3309
+ onResultTableCellIds: (
3259
3310
  queryId: MaybeGetter<IdOrNull>,
3260
3311
  listener: ResultTableCellIdsListener<Schemas>,
3261
3312
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
3262
3313
  ) => void;
3263
3314
 
3264
3315
  /**
3265
- * The useResultRowCountListener hook registers a listener that is called
3266
- * whenever the count of result Rows changes.
3316
+ * The onResultRowCount function registers a listener that is called whenever
3317
+ * the count of result Rows changes.
3267
3318
  * @param queryId The Id of the query to listen to, or `null` to listen to any
3268
3319
  * query.
3269
3320
  * @param listener The function to call when the count changes.
3270
3321
  * @param queriesOrQueriesId The Queries object to use, or its Id.
3271
- * @category Hook
3322
+ * @category Listener
3272
3323
  * @since v8.1.0
3273
3324
  */
3274
- useResultRowCountListener: (
3325
+ onResultRowCount: (
3275
3326
  queryId: MaybeGetter<IdOrNull>,
3276
3327
  listener: ResultRowCountListener<Schemas>,
3277
3328
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
3278
3329
  ) => void;
3279
3330
 
3280
3331
  /**
3281
- * The useResultRowIdsListener hook registers a listener that is called whenever
3282
- * the result Row Ids of a query change.
3332
+ * The onResultRowIds function registers a listener that is called whenever the
3333
+ * result Row Ids of a query change.
3283
3334
  * @param queryId The Id of the query to listen to, or `null` to listen to any
3284
3335
  * query.
3285
3336
  * @param listener The function to call when result Row Ids change.
3286
3337
  * @param queriesOrQueriesId The Queries object to use, or its Id.
3287
- * @category Hook
3338
+ * @category Listener
3288
3339
  * @since v8.1.0
3289
3340
  */
3290
- useResultRowIdsListener: (
3341
+ onResultRowIds: (
3291
3342
  queryId: MaybeGetter<IdOrNull>,
3292
3343
  listener: ResultRowIdsListener<Schemas>,
3293
3344
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
3294
3345
  ) => void;
3295
3346
 
3296
3347
  /**
3297
- * The useResultSortedRowIdsListener hook registers a listener that is called
3348
+ * The onResultSortedRowIds function registers a listener that is called
3298
3349
  * whenever the sorted result Row Ids change.
3299
3350
  * @param queryId The Id of the query to listen to.
3300
3351
  * @param cellId The Id of the Cell to sort by, or `undefined` for default
@@ -3304,10 +3355,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3304
3355
  * @param limit The maximum number of Rows to include, or `undefined` for all.
3305
3356
  * @param listener The function to call when sorted Row Ids change.
3306
3357
  * @param queriesOrQueriesId The Queries object to use, or its Id.
3307
- * @category Hook
3358
+ * @category Listener
3308
3359
  * @since v8.1.0
3309
3360
  */
3310
- useResultSortedRowIdsListener: (
3361
+ onResultSortedRowIds: (
3311
3362
  queryId: MaybeGetter<Id>,
3312
3363
  cellId: MaybeGetter<Id | undefined>,
3313
3364
  descending: MaybeGetter<boolean>,
@@ -3318,7 +3369,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3318
3369
  ) => void;
3319
3370
 
3320
3371
  /**
3321
- * The useResultRowListener hook registers a listener that is called whenever a
3372
+ * The onResultRow function registers a listener that is called whenever a
3322
3373
  * result Row changes.
3323
3374
  * @param queryId The Id of the query to listen to, or `null` to listen to any
3324
3375
  * query.
@@ -3326,10 +3377,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3326
3377
  * any result Row.
3327
3378
  * @param listener The function to call when the result Row changes.
3328
3379
  * @param queriesOrQueriesId The Queries object to use, or its Id.
3329
- * @category Hook
3380
+ * @category Listener
3330
3381
  * @since v8.1.0
3331
3382
  */
3332
- useResultRowListener: (
3383
+ onResultRow: (
3333
3384
  queryId: MaybeGetter<IdOrNull>,
3334
3385
  rowId: MaybeGetter<IdOrNull>,
3335
3386
  listener: ResultRowListener<Schemas>,
@@ -3337,18 +3388,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3337
3388
  ) => void;
3338
3389
 
3339
3390
  /**
3340
- * The useResultCellIdsListener hook registers a listener that is called
3341
- * whenever the Cell Ids in a result Row change.
3391
+ * The onResultCellIds function registers a listener that is called whenever the
3392
+ * Cell Ids in a result Row change.
3342
3393
  * @param queryId The Id of the query to listen to, or `null` to listen to any
3343
3394
  * query.
3344
3395
  * @param rowId The Id of the result Row to listen to, or `null` to listen to
3345
3396
  * any result Row.
3346
3397
  * @param listener The function to call when Cell Ids change.
3347
3398
  * @param queriesOrQueriesId The Queries object to use, or its Id.
3348
- * @category Hook
3399
+ * @category Listener
3349
3400
  * @since v8.1.0
3350
3401
  */
3351
- useResultCellIdsListener: (
3402
+ onResultCellIds: (
3352
3403
  queryId: MaybeGetter<IdOrNull>,
3353
3404
  rowId: MaybeGetter<IdOrNull>,
3354
3405
  listener: ResultCellIdsListener<Schemas>,
@@ -3356,8 +3407,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3356
3407
  ) => void;
3357
3408
 
3358
3409
  /**
3359
- * The useResultCellListener hook registers a listener that is called whenever
3360
- * the value of a result Cell changes.
3410
+ * The onResultCell function registers a listener that is called whenever the
3411
+ * value of a result Cell changes.
3361
3412
  * @param queryId The Id of the query to listen to, or `null` to listen to any
3362
3413
  * query.
3363
3414
  * @param rowId The Id of the result Row to listen to, or `null` to listen to
@@ -3366,10 +3417,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3366
3417
  * any result Cell.
3367
3418
  * @param listener The function to call when the result Cell changes.
3368
3419
  * @param queriesOrQueriesId The Queries object to use, or its Id.
3369
- * @category Hook
3420
+ * @category Listener
3370
3421
  * @since v8.1.0
3371
3422
  */
3372
- useResultCellListener: (
3423
+ onResultCell: (
3373
3424
  queryId: MaybeGetter<IdOrNull>,
3374
3425
  rowId: MaybeGetter<IdOrNull>,
3375
3426
  cellId: MaybeGetter<IdOrNull>,
@@ -3378,23 +3429,23 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3378
3429
  ) => void;
3379
3430
 
3380
3431
  /**
3381
- * The useParamValuesListener hook registers a listener that is called whenever
3382
- * the parameter values for a query change.
3432
+ * The onParamValues function registers a listener that is called whenever the
3433
+ * parameter values for a query change.
3383
3434
  * @param queryId The Id of the query to listen to, or `null` to listen to any
3384
3435
  * query.
3385
3436
  * @param listener The function to call when parameter values change.
3386
3437
  * @param queriesOrQueriesId The Queries object to use, or its Id.
3387
- * @category Hook
3438
+ * @category Listener
3388
3439
  * @since v8.1.0
3389
3440
  */
3390
- useParamValuesListener: (
3441
+ onParamValues: (
3391
3442
  queryId: MaybeGetter<IdOrNull>,
3392
3443
  listener: ParamValuesListener<Schemas>,
3393
3444
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
3394
3445
  ) => void;
3395
3446
 
3396
3447
  /**
3397
- * The useParamValueListener hook registers a listener that is called whenever a
3448
+ * The onParamValue function registers a listener that is called whenever a
3398
3449
  * specific parameter value for a query changes.
3399
3450
  * @param queryId The Id of the query to listen to, or `null` to listen to any
3400
3451
  * query.
@@ -3402,10 +3453,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3402
3453
  * any parameter.
3403
3454
  * @param listener The function to call when the parameter value changes.
3404
3455
  * @param queriesOrQueriesId The Queries object to use, or its Id.
3405
- * @category Hook
3456
+ * @category Listener
3406
3457
  * @since v8.1.0
3407
3458
  */
3408
- useParamValueListener: (
3459
+ onParamValue: (
3409
3460
  queryId: MaybeGetter<IdOrNull>,
3410
3461
  paramId: MaybeGetter<IdOrNull>,
3411
3462
  listener: ParamValueListener<Schemas>,
@@ -3413,43 +3464,43 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3413
3464
  ) => void;
3414
3465
 
3415
3466
  /**
3416
- * The useCheckpointIdsListener hook registers a listener that is called
3417
- * whenever the Checkpoint Ids change.
3467
+ * The onCheckpointIds function registers a listener that is called whenever the
3468
+ * Checkpoint Ids change.
3418
3469
  * @param listener The function to call when Checkpoint Ids change.
3419
3470
  * @param checkpointsOrCheckpointsId The Checkpoints object to use, or its Id.
3420
- * @category Hook
3471
+ * @category Listener
3421
3472
  * @since v8.1.0
3422
3473
  */
3423
- useCheckpointIdsListener: (
3474
+ onCheckpointIds: (
3424
3475
  listener: CheckpointIdsListener<Schemas>,
3425
3476
  checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId<Schemas>,
3426
3477
  ) => void;
3427
3478
 
3428
3479
  /**
3429
- * The useCheckpointListener hook registers a listener that is called whenever
3430
- * the label of a specified Checkpoint changes.
3480
+ * The onCheckpoint function registers a listener that is called whenever the
3481
+ * label of a specified Checkpoint changes.
3431
3482
  * @param checkpointId The Id of the Checkpoint to listen to, or `null` to
3432
3483
  * listen to any Checkpoint.
3433
3484
  * @param listener The function to call when the Checkpoint label changes.
3434
3485
  * @param checkpointsOrCheckpointsId The Checkpoints object to use, or its Id.
3435
- * @category Hook
3486
+ * @category Listener
3436
3487
  * @since v8.1.0
3437
3488
  */
3438
- useCheckpointListener: (
3489
+ onCheckpoint: (
3439
3490
  checkpointId: MaybeGetter<IdOrNull>,
3440
3491
  listener: CheckpointListener<Schemas>,
3441
3492
  checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId<Schemas>,
3442
3493
  ) => void;
3443
3494
 
3444
3495
  /**
3445
- * The usePersisterStatusListener hook registers a listener that is called
3446
- * whenever the status of a Persister changes.
3496
+ * The onPersisterStatus function registers a listener that is called whenever
3497
+ * the status of a Persister changes.
3447
3498
  * @param listener The function to call when the status changes.
3448
3499
  * @param persisterOrPersisterId The Persister to use, or its Id.
3449
- * @category Hook
3500
+ * @category Listener
3450
3501
  * @since v8.1.0
3451
3502
  */
3452
- usePersisterStatusListener: (
3503
+ onPersisterStatus: (
3453
3504
  listener: StatusListener<Schemas>,
3454
3505
  persisterOrPersisterId?: MaybeGetter<
3455
3506
  PersisterOrPersisterId<Schemas> | undefined
@@ -3457,14 +3508,14 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3457
3508
  ) => void;
3458
3509
 
3459
3510
  /**
3460
- * The useSynchronizerStatusListener hook registers a listener that is called
3511
+ * The onSynchronizerStatus function registers a listener that is called
3461
3512
  * whenever the status of a Synchronizer changes.
3462
3513
  * @param listener The function to call when the status changes.
3463
3514
  * @param synchronizerOrSynchronizerId The Synchronizer to use, or its Id.
3464
- * @category Hook
3515
+ * @category Listener
3465
3516
  * @since v8.1.0
3466
3517
  */
3467
- useSynchronizerStatusListener: (
3518
+ onSynchronizerStatus: (
3468
3519
  listener: StatusListener<Schemas>,
3469
3520
  synchronizerOrSynchronizerId?: MaybeGetter<
3470
3521
  SynchronizerOrSynchronizerId<Schemas> | undefined
@@ -3481,8 +3532,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
3481
3532
  * provideStore(storeId: Id, store: Store): void;
3482
3533
  * ```
3483
3534
  *
3484
- * This function must be called inside a Svelte component's `<script>` block
3485
- * that is a descendant of a Provider component.
3535
+ * The provideStore function must be called inside a Svelte component's
3536
+ * `<script>` block that is a descendant of a Provider component.
3486
3537
  * @param storeId The Id to register the Store under.
3487
3538
  * @param store The Store to register.
3488
3539
  * @category Provider