tinybase 8.1.0-beta.4 → 8.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. package/@types/indexes/index.d.ts +0 -1
  2. package/@types/indexes/with-schemas/index.d.ts +0 -1
  3. package/@types/metrics/index.d.ts +0 -1
  4. package/@types/metrics/with-schemas/index.d.ts +0 -1
  5. package/@types/ui-react/index.d.ts +2 -1
  6. package/@types/ui-react/with-schemas/index.d.ts +2 -1
  7. package/@types/ui-svelte/index.d.ts +462 -361
  8. package/@types/ui-svelte/with-schemas/index.d.ts +451 -359
  9. package/min/omni/index.js +1 -1
  10. package/min/omni/index.js.gz +0 -0
  11. package/min/omni/with-schemas/index.js +1 -1
  12. package/min/omni/with-schemas/index.js.gz +0 -0
  13. package/min/persisters/persister-partykit-server/index.js +1 -1
  14. package/min/persisters/persister-partykit-server/index.js.gz +0 -0
  15. package/min/persisters/persister-partykit-server/with-schemas/index.js +1 -1
  16. package/min/persisters/persister-partykit-server/with-schemas/index.js.gz +0 -0
  17. package/min/persisters/persister-remote/index.js +1 -1
  18. package/min/persisters/persister-remote/index.js.gz +0 -0
  19. package/min/persisters/persister-remote/with-schemas/index.js +1 -1
  20. package/min/persisters/persister-remote/with-schemas/index.js.gz +0 -0
  21. package/min/ui-svelte/index.js +1 -1
  22. package/min/ui-svelte/index.js.gz +0 -0
  23. package/min/ui-svelte/with-schemas/index.js +1 -1
  24. package/min/ui-svelte/with-schemas/index.js.gz +0 -0
  25. package/omni/index.js +5 -2
  26. package/omni/with-schemas/index.js +5 -2
  27. package/package.json +5 -5
  28. package/persisters/persister-partykit-server/index.js +1 -0
  29. package/persisters/persister-partykit-server/with-schemas/index.js +1 -0
  30. package/persisters/persister-remote/index.js +4 -2
  31. package/persisters/persister-remote/with-schemas/index.js +4 -2
  32. package/readme.md +5 -5
  33. package/releases.md +15 -7
  34. package/ui-svelte/index.js +121 -121
  35. package/ui-svelte/with-schemas/index.js +121 -121
@@ -141,17 +141,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
141
141
  * Metrics | Id;
142
142
  * ```
143
143
  *
144
- * In some simple cases you will already have a direct reference to the
145
- * Metrics object.
144
+ * In some simple cases you will already have a direct reference to the Metrics
145
+ * object.
146
146
  *
147
147
  * This module also includes a Provider component that can be used to wrap
148
148
  * multiple Metrics objects into a context that can be used throughout the app.
149
- * In this case you will want to refer to a Metrics object by its Id in
150
- * that context.
149
+ * In this case you will want to refer to a Metrics object by its Id in that
150
+ * context.
151
151
  *
152
152
  * Many functions and components in this ui-svelte module take this type as a
153
- * parameter or a prop, allowing you to pass in either the Metrics object or
154
- * its Id.
153
+ * parameter or a prop, allowing you to pass in either the Metrics object or its
154
+ * Id.
155
155
  * @category Identity
156
156
  * @since v8.1.0
157
157
  */
@@ -167,17 +167,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
167
167
  * Indexes | Id;
168
168
  * ```
169
169
  *
170
- * In some simple cases you will already have a direct reference to the
171
- * Indexes object.
170
+ * In some simple cases you will already have a direct reference to the Indexes
171
+ * object.
172
172
  *
173
173
  * This module also includes a Provider component that can be used to wrap
174
174
  * multiple Indexes objects into a context that can be used throughout the app.
175
- * In this case you will want to refer to an Indexes object by its Id in
176
- * that context.
175
+ * In this case you will want to refer to an Indexes object by its Id in that
176
+ * context.
177
177
  *
178
178
  * Many functions and components in this ui-svelte module take this type as a
179
- * parameter or a prop, allowing you to pass in either the Indexes object or
180
- * its Id.
179
+ * parameter or a prop, allowing you to pass in either the Indexes object or its
180
+ * Id.
181
181
  * @category Identity
182
182
  * @since v8.1.0
183
183
  */
@@ -219,17 +219,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
219
219
  * Queries | Id;
220
220
  * ```
221
221
  *
222
- * In some simple cases you will already have a direct reference to the
223
- * Queries object.
222
+ * In some simple cases you will already have a direct reference to the Queries
223
+ * object.
224
224
  *
225
225
  * This module also includes a Provider component that can be used to wrap
226
226
  * multiple Queries objects into a context that can be used throughout the app.
227
- * In this case you will want to refer to a Queries object by its Id in
228
- * that context.
227
+ * In this case you will want to refer to a Queries object by its Id in that
228
+ * context.
229
229
  *
230
230
  * Many functions and components in this ui-svelte module take this type as a
231
- * parameter or a prop, allowing you to pass in either the Queries object or
232
- * its Id.
231
+ * parameter or a prop, allowing you to pass in either the Queries object or its
232
+ * Id.
233
233
  * @category Identity
234
234
  * @since v8.1.0
235
235
  */
@@ -305,8 +305,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
305
305
  * in that context.
306
306
  *
307
307
  * Many functions and components in this ui-svelte module take this type as a
308
- * parameter or a prop, allowing you to pass in either the Synchronizer or
309
- * its Id.
308
+ * parameter or a prop, allowing you to pass in either the Synchronizer or its
309
+ * Id.
310
310
  * @category Identity
311
311
  * @since v8.1.0
312
312
  */
@@ -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
540
- * CheckpointView 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
661
- * SortedTableView 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
876
- * RemoteRowView 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
915
- * LocalRowsView 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
960
- * LinkedRowsView component.
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
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
1005
- * ResultCellView 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
1044
- * ResultRowView 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
1089
- * ResultTableView 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
  */
@@ -1292,6 +1381,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1292
1381
  * Store objects, Metrics, Indexes, Relationships, Queries, Checkpoints,
1293
1382
  * Persisters, and Synchronizers can all be provided both as single defaults and
1294
1383
  * as named instances in a `*ById` map.
1384
+ *
1385
+ * Provider components can be nested and their contexts are merged, so outer
1386
+ * defaults and named instances remain visible unless a nearer Provider
1387
+ * replaces them.
1295
1388
  * @param props The props for this component.
1296
1389
  * @example
1297
1390
  * This example creates a Provider context with a default Store.
@@ -1320,8 +1413,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1320
1413
 
1321
1414
  /**
1322
1415
  * The ValueView component renders the value of a single Value in a Store, and
1323
- * registers a listener so that any changes to that result will cause
1324
- * a re-render.
1416
+ * registers a listener so that any changes to that result will cause a
1417
+ * re-render.
1325
1418
  * @param props The props for this component.
1326
1419
  * @returns A rendering of the Value, or nothing if not present.
1327
1420
  * @category Component
@@ -1331,8 +1424,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1331
1424
 
1332
1425
  /**
1333
1426
  * The RowView component renders the contents of a single Row in a given Table,
1334
- * and registers a listener so that any changes to that result will cause
1335
- * a re-render.
1427
+ * and registers a listener so that any changes to that result will cause a
1428
+ * re-render.
1336
1429
  * @param props The props for this component.
1337
1430
  * @returns A rendering of the Row, or nothing if not present.
1338
1431
  * @category Component
@@ -1363,8 +1456,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1363
1456
 
1364
1457
  /**
1365
1458
  * The TablesView component renders the contents of all Tables in a Store, and
1366
- * registers a listener so that any changes to that result will cause
1367
- * a re-render.
1459
+ * registers a listener so that any changes to that result will cause a
1460
+ * re-render.
1368
1461
  * @param props The props for this component.
1369
1462
  * @returns A rendering of all Tables.
1370
1463
  * @category Component
@@ -1405,8 +1498,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1405
1498
 
1406
1499
  /**
1407
1500
  * The SliceView component renders the Row Ids in a named Slice in an Index, and
1408
- * registers a listener so that any changes to that result will cause
1409
- * a re-render.
1501
+ * registers a listener so that any changes to that result will cause a
1502
+ * re-render.
1410
1503
  * @param props The props for this component.
1411
1504
  * @returns A rendering of the Rows in the Slice.
1412
1505
  * @category Component
@@ -1438,8 +1531,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1438
1531
 
1439
1532
  /**
1440
1533
  * The LinkedRowsView component renders the Rows in a linked list Relationship,
1441
- * and registers a listener so that any changes to that result will cause
1442
- * a re-render.
1534
+ * and registers a listener so that any changes to that result will cause a
1535
+ * re-render.
1443
1536
  * @param props The props for this component.
1444
1537
  * @returns A rendering of the linked Row Ids.
1445
1538
  * @category Component
@@ -1544,97 +1637,97 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1544
1637
  >;
1545
1638
 
1546
1639
  /**
1547
- * The createHasTables function returns a reactive object indicating whether any
1640
+ * The hasTables function returns a reactive object indicating whether any
1548
1641
  * Tables exist in the Store, and registers a listener so that any changes to
1549
- * that result will update `.current`.
1642
+ * that result will update `current`.
1550
1643
  * @param storeOrStoreId The Store to use, or its Id in a Provider context.
1551
1644
  * @returns A reactive object with a `current` boolean property.
1552
1645
  * @category Getter
1553
1646
  * @since v8.1.0
1554
1647
  */
1555
- createHasTables: (
1648
+ hasTables: (
1556
1649
  storeOrStoreId?: MaybeGetter<StoreOrStoreId<Schemas> | undefined>,
1557
1650
  ) => {
1558
1651
  readonly current: boolean;
1559
1652
  };
1560
1653
 
1561
1654
  /**
1562
- * The createTables function returns a reactive object reflecting the Tables in
1563
- * the Store, and registers a listener so that any changes to those Tables will
1564
- * update `.current`.
1655
+ * The getTables function returns a reactive object reflecting the Tables in the
1656
+ * Store, and registers a listener so that any changes to those Tables will
1657
+ * update `current`.
1565
1658
  * @param storeOrStoreId The Store to use, or its Id in a Provider context.
1566
1659
  * @returns A reactive object with a `current` Tables property.
1567
1660
  * @category Getter
1568
1661
  * @since v8.1.0
1569
1662
  */
1570
- createTables: (
1663
+ getTables: (
1571
1664
  storeOrStoreId?: MaybeGetter<StoreOrStoreId<Schemas> | undefined>,
1572
1665
  ) => {
1573
1666
  readonly current: Tables<Schemas[0]>;
1574
1667
  };
1575
1668
 
1576
1669
  /**
1577
- * The createTableIds function returns a reactive object reflecting the Ids of
1578
- * the Tables in a Store, and registers a listener so that any changes to those
1579
- * Ids will update `.current`.
1670
+ * The getTableIds function returns a reactive object reflecting the Ids of the
1671
+ * Tables in a Store, and registers a listener so that any changes to those Ids
1672
+ * will update `current`.
1580
1673
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1581
1674
  * @returns A reactive object with a `current` Ids property.
1582
1675
  * @category Getter
1583
1676
  * @since v8.1.0
1584
1677
  */
1585
- createTableIds: (storeOrStoreId?: StoreOrStoreId<Schemas>) => {
1678
+ getTableIds: (storeOrStoreId?: StoreOrStoreId<Schemas>) => {
1586
1679
  readonly current: TableIdFromSchema<Schemas[0]>[];
1587
1680
  };
1588
1681
 
1589
1682
  /**
1590
- * The createHasTable function returns a reactive object indicating whether a
1591
- * Table exists in the Store, and registers a listener so that any changes to
1592
- * that result will update `.current`.
1683
+ * The hasTable function returns a reactive object indicating whether a Table
1684
+ * exists in the Store, and registers a listener so that any changes to that
1685
+ * result will update `current`.
1593
1686
  * @param tableId The Id of the Table (or a getter returning it).
1594
1687
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1595
1688
  * @returns A reactive object with a `current` boolean property.
1596
1689
  * @category Getter
1597
1690
  * @since v8.1.0
1598
1691
  */
1599
- createHasTable: <TableId extends TableIdFromSchema<Schemas[0]>>(
1692
+ hasTable: <TableId extends TableIdFromSchema<Schemas[0]>>(
1600
1693
  tableId: MaybeGetter<TableId>,
1601
1694
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1602
1695
  ) => {readonly current: boolean};
1603
1696
 
1604
1697
  /**
1605
- * The createTable function returns a reactive object reflecting a Table in a
1606
- * Store, and registers a listener so that any changes to that Table will
1607
- * update `.current`.
1698
+ * The getTable function returns a reactive object reflecting a Table in a
1699
+ * Store, and registers a listener so that any changes to that Table will update
1700
+ * `current`.
1608
1701
  * @param tableId The Id of the Table (or a getter returning it).
1609
1702
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1610
1703
  * @returns A reactive object with a `current` Table property.
1611
1704
  * @category Getter
1612
1705
  * @since v8.1.0
1613
1706
  */
1614
- createTable: <TableId extends TableIdFromSchema<Schemas[0]>>(
1707
+ getTable: <TableId extends TableIdFromSchema<Schemas[0]>>(
1615
1708
  tableId: MaybeGetter<TableId>,
1616
1709
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1617
1710
  ) => {readonly current: Table<Schemas[0], TableId>};
1618
1711
 
1619
1712
  /**
1620
- * The createTableCellIds function returns a reactive object reflecting the Ids
1621
- * of all Cells used across a Table, and registers a listener so that any
1622
- * changes to those Ids will update `.current`.
1713
+ * The getTableCellIds function returns a reactive object reflecting the Ids of
1714
+ * all Cells used across a Table, and registers a listener so that any changes
1715
+ * to those Ids will update `current`.
1623
1716
  * @param tableId The Id of the Table (or a getter returning it).
1624
1717
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1625
1718
  * @returns A reactive object with a `current` Ids property.
1626
1719
  * @category Getter
1627
1720
  * @since v8.1.0
1628
1721
  */
1629
- createTableCellIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
1722
+ getTableCellIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
1630
1723
  tableId: MaybeGetter<TableId>,
1631
1724
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1632
1725
  ) => {readonly current: CellIdFromSchema<Schemas[0], TableId>[]};
1633
1726
 
1634
1727
  /**
1635
- * The createHasTableCell function returns a reactive object indicating whether
1636
- * a particular Cell is used anywhere in a Table, and registers a listener so
1637
- * that any changes to that result will update `.current`.
1728
+ * The hasTableCell function returns a reactive object indicating whether a
1729
+ * particular Cell is used anywhere in a Table, and registers a listener so that
1730
+ * any changes to that result will update `current`.
1638
1731
  * @param tableId The Id of the Table (or a getter returning it).
1639
1732
  * @param cellId The Id of the Cell (or a getter returning it).
1640
1733
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
@@ -1642,46 +1735,46 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1642
1735
  * @category Getter
1643
1736
  * @since v8.1.0
1644
1737
  */
1645
- createHasTableCell: <TableId extends TableIdFromSchema<Schemas[0]>>(
1738
+ hasTableCell: <TableId extends TableIdFromSchema<Schemas[0]>>(
1646
1739
  tableId: MaybeGetter<TableId>,
1647
1740
  cellId: MaybeGetter<CellIdFromSchema<Schemas[0], TableId>>,
1648
1741
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1649
1742
  ) => {readonly current: boolean};
1650
1743
 
1651
1744
  /**
1652
- * The createRowCount function returns a reactive object reflecting the number
1653
- * of Rows in a Table, and registers a listener so that any changes will
1654
- * update `.current`.
1745
+ * The getRowCount function returns a reactive object reflecting the number of
1746
+ * Rows in a Table, and registers a listener so that any changes will update
1747
+ * `current`.
1655
1748
  * @param tableId The Id of the Table (or a getter returning it).
1656
1749
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1657
1750
  * @returns A reactive object with a `current` number property.
1658
1751
  * @category Getter
1659
1752
  * @since v8.1.0
1660
1753
  */
1661
- createRowCount: (
1754
+ getRowCount: (
1662
1755
  tableId: MaybeGetter<TableIdFromSchema<Schemas[0]>>,
1663
1756
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1664
1757
  ) => {readonly current: number};
1665
1758
 
1666
1759
  /**
1667
- * The createRowIds function returns a reactive object reflecting the Ids of the
1668
- * Rows in a Table, and registers a listener so that any changes will
1669
- * update `.current`.
1760
+ * The getRowIds function returns a reactive object reflecting the Ids of the
1761
+ * Rows in a Table, and registers a listener so that any changes will update
1762
+ * `current`.
1670
1763
  * @param tableId The Id of the Table (or a getter returning it).
1671
1764
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1672
1765
  * @returns A reactive object with a `current` Ids property.
1673
1766
  * @category Getter
1674
1767
  * @since v8.1.0
1675
1768
  */
1676
- createRowIds: (
1769
+ getRowIds: (
1677
1770
  tableId: MaybeGetter<TableIdFromSchema<Schemas[0]>>,
1678
1771
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1679
1772
  ) => {readonly current: Ids};
1680
1773
 
1681
1774
  /**
1682
- * The createSortedRowIds function returns a reactive object reflecting the
1683
- * sorted Row Ids in a Table, and registers a listener so that any changes will
1684
- * update `.current`.
1775
+ * The getSortedRowIds function returns a reactive object reflecting the sorted
1776
+ * Row Ids in a Table, and registers a listener so that any changes will update
1777
+ * `current`.
1685
1778
  * @param tableId The Id of the Table (or a getter returning it).
1686
1779
  * @param cellId The Id of the Cell to sort by (or a getter returning it).
1687
1780
  * @param descending Whether to sort descending (or a getter returning it).
@@ -1692,7 +1785,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1692
1785
  * @category Getter
1693
1786
  * @since v8.1.0
1694
1787
  */
1695
- createSortedRowIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
1788
+ getSortedRowIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
1696
1789
  tableId: MaybeGetter<TableId>,
1697
1790
  cellId?: MaybeGetter<CellIdFromSchema<Schemas[0], TableId> | undefined>,
1698
1791
  descending?: MaybeGetter<boolean>,
@@ -1702,9 +1795,9 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1702
1795
  ) => {readonly current: Ids};
1703
1796
 
1704
1797
  /**
1705
- * The createHasRow function returns a reactive object indicating whether a Row
1706
- * exists in a Table, and registers a listener so that any changes to that
1707
- * result will update `.current`.
1798
+ * The hasRow function returns a reactive object indicating whether a Row exists
1799
+ * in a Table, and registers a listener so that any changes to that result will
1800
+ * update `current`.
1708
1801
  * @param tableId The Id of the Table (or a getter returning it).
1709
1802
  * @param rowId The Id of the Row (or a getter returning it).
1710
1803
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
@@ -1712,16 +1805,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1712
1805
  * @category Getter
1713
1806
  * @since v8.1.0
1714
1807
  */
1715
- createHasRow: (
1808
+ hasRow: (
1716
1809
  tableId: MaybeGetter<TableIdFromSchema<Schemas[0]>>,
1717
1810
  rowId: MaybeGetter<Id>,
1718
1811
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1719
1812
  ) => {readonly current: boolean};
1720
1813
 
1721
1814
  /**
1722
- * The createRow function returns a reactive object reflecting a Row in a Table,
1723
- * and registers a listener so that any changes to that Row will
1724
- * update `.current`.
1815
+ * The getRow function returns a reactive object reflecting a Row in a Table,
1816
+ * and registers a listener so that any changes to that Row will update
1817
+ * `current`.
1725
1818
  * @param tableId The Id of the Table (or a getter returning it).
1726
1819
  * @param rowId The Id of the Row (or a getter returning it).
1727
1820
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
@@ -1729,16 +1822,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1729
1822
  * @category Getter
1730
1823
  * @since v8.1.0
1731
1824
  */
1732
- createRow: <TableId extends TableIdFromSchema<Schemas[0]>>(
1825
+ getRow: <TableId extends TableIdFromSchema<Schemas[0]>>(
1733
1826
  tableId: MaybeGetter<TableId>,
1734
1827
  rowId: MaybeGetter<Id>,
1735
1828
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1736
1829
  ) => {readonly current: Row<Schemas[0], TableId>};
1737
1830
 
1738
1831
  /**
1739
- * The createCellIds function returns a reactive object reflecting the Ids of
1740
- * the Cells in a Row, and registers a listener so that any changes will
1741
- * update `.current`.
1832
+ * The getCellIds function returns a reactive object reflecting the Ids of the
1833
+ * Cells in a Row, and registers a listener so that any changes will update
1834
+ * `current`.
1742
1835
  * @param tableId The Id of the Table (or a getter returning it).
1743
1836
  * @param rowId The Id of the Row (or a getter returning it).
1744
1837
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
@@ -1746,16 +1839,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1746
1839
  * @category Getter
1747
1840
  * @since v8.1.0
1748
1841
  */
1749
- createCellIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
1842
+ getCellIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
1750
1843
  tableId: MaybeGetter<TableId>,
1751
1844
  rowId: MaybeGetter<Id>,
1752
1845
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1753
1846
  ) => {readonly current: CellIdFromSchema<Schemas[0], TableId>[]};
1754
1847
 
1755
1848
  /**
1756
- * The createHasCell function returns a reactive object indicating whether a
1757
- * Cell exists in a Row in a Table, and registers a listener so that any changes
1758
- * to that result will update `.current`.
1849
+ * The hasCell function returns a reactive object indicating whether a Cell
1850
+ * exists in a Row in a Table, and registers a listener so that any changes to
1851
+ * that result will update `current`.
1759
1852
  * @param tableId The Id of the Table (or a getter returning it).
1760
1853
  * @param rowId The Id of the Row (or a getter returning it).
1761
1854
  * @param cellId The Id of the Cell (or a getter returning it).
@@ -1764,7 +1857,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1764
1857
  * @category Getter
1765
1858
  * @since v8.1.0
1766
1859
  */
1767
- createHasCell: <
1860
+ hasCell: <
1768
1861
  TableId extends TableIdFromSchema<Schemas[0]>,
1769
1862
  CellId extends CellIdFromSchema<Schemas[0], TableId>,
1770
1863
  >(
@@ -1775,14 +1868,14 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1775
1868
  ) => {readonly current: boolean};
1776
1869
 
1777
1870
  /**
1778
- * The createCell function returns a reactive object reflecting the value of a
1779
- * Cell in a Row in a Table, and registers a listener so that any changes to
1780
- * that Cell will update `.current`.
1871
+ * The getCell function returns a reactive object reflecting the value of a Cell
1872
+ * in a Row in a Table, and registers a listener so that any changes to that
1873
+ * Cell will update `current`.
1781
1874
  *
1782
1875
  * This has schema-based typing. The following is a simplified representation:
1783
1876
  *
1784
1877
  * ```ts override
1785
- * createCell(
1878
+ * getCell(
1786
1879
  * tableId: MaybeGetter<Id>,
1787
1880
  * rowId: MaybeGetter<Id>,
1788
1881
  * cellId: MaybeGetter<Id>,
@@ -1798,18 +1891,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1798
1891
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1799
1892
  * @returns A reactive object with gettable and settable `current`.
1800
1893
  * @example
1801
- * This example uses the createCell function to display a Cell value reactively.
1894
+ * This example uses the getCell function to display a Cell value reactively.
1802
1895
  *
1803
1896
  * ```ts
1804
1897
  * // In a .svelte file:
1805
1898
  * // const store = createStore().setCell('pets', 'cat', 'name', 'Fido');
1806
- * // const name = createCell('pets', 'cat', 'name', store);
1899
+ * // const name = getCell('pets', 'cat', 'name', store);
1807
1900
  * // $: console.log(name.current); // 'Fido'
1808
1901
  * ```
1809
1902
  * @category Getter
1810
1903
  * @since v8.1.0
1811
1904
  */
1812
- createCell: <
1905
+ getCell: <
1813
1906
  TableId extends TableIdFromSchema<Schemas[0]>,
1814
1907
  CellId extends CellIdFromSchema<Schemas[0], TableId>,
1815
1908
  >(
@@ -1823,72 +1916,71 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1823
1916
  };
1824
1917
 
1825
1918
  /**
1826
- * The createHasValues function returns a reactive object indicating whether any
1919
+ * The hasValues function returns a reactive object indicating whether any
1827
1920
  * Values exist in the Store, and registers a listener so that any changes to
1828
- * that result will update `.current`.
1921
+ * that result will update `current`.
1829
1922
  * @param storeOrStoreId The Store to use, or its Id in a Provider context.
1830
1923
  * @returns A reactive object with a `current` boolean property.
1831
1924
  * @category Getter
1832
1925
  * @since v8.1.0
1833
1926
  */
1834
- createHasValues: (
1927
+ hasValues: (
1835
1928
  storeOrStoreId?: MaybeGetter<StoreOrStoreId<Schemas> | undefined>,
1836
1929
  ) => {
1837
1930
  readonly current: boolean;
1838
1931
  };
1839
1932
 
1840
1933
  /**
1841
- * The createValues function returns a reactive object reflecting the Values in
1842
- * the Store, and registers a listener so that any changes will
1843
- * update `.current`.
1934
+ * The getValues function returns a reactive object reflecting the Values in the
1935
+ * Store, and registers a listener so that any changes will update `current`.
1844
1936
  * @param storeOrStoreId The Store to use, or its Id in a Provider context.
1845
1937
  * @returns A reactive object with a `current` Values property.
1846
1938
  * @category Getter
1847
1939
  * @since v8.1.0
1848
1940
  */
1849
- createValues: (
1941
+ getValues: (
1850
1942
  storeOrStoreId?: MaybeGetter<StoreOrStoreId<Schemas> | undefined>,
1851
1943
  ) => {
1852
1944
  readonly current: Values<Schemas[1]>;
1853
1945
  };
1854
1946
 
1855
1947
  /**
1856
- * The createValueIds function returns a reactive object reflecting the Ids of
1857
- * the Values in a Store, and registers a listener so that any changes will
1858
- * update `.current`.
1948
+ * The getValueIds function returns a reactive object reflecting the Ids of the
1949
+ * Values in a Store, and registers a listener so that any changes will update
1950
+ * `current`.
1859
1951
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1860
1952
  * @returns A reactive object with a `current` Ids property.
1861
1953
  * @category Getter
1862
1954
  * @since v8.1.0
1863
1955
  */
1864
- createValueIds: (storeOrStoreId?: StoreOrStoreId<Schemas>) => {
1956
+ getValueIds: (storeOrStoreId?: StoreOrStoreId<Schemas>) => {
1865
1957
  readonly current: ValueIdFromSchema<Schemas[1]>[];
1866
1958
  };
1867
1959
 
1868
1960
  /**
1869
- * The createHasValue function returns a reactive object indicating whether a
1870
- * Value exists in the Store, and registers a listener so that any changes to
1871
- * that result will update `.current`.
1961
+ * The hasValue function returns a reactive object indicating whether a Value
1962
+ * exists in the Store, and registers a listener so that any changes to that
1963
+ * result will update `current`.
1872
1964
  * @param valueId The Id of the Value (or a getter returning it).
1873
1965
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
1874
1966
  * @returns A reactive object with a `current` boolean property.
1875
1967
  * @category Getter
1876
1968
  * @since v8.1.0
1877
1969
  */
1878
- createHasValue: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
1970
+ hasValue: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
1879
1971
  valueId: MaybeGetter<ValueId>,
1880
1972
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1881
1973
  ) => {readonly current: boolean};
1882
1974
 
1883
1975
  /**
1884
- * The createValue function returns a reactive object reflecting the value of a
1976
+ * The getValue function returns a reactive object reflecting the value of a
1885
1977
  * Value in a Store, and registers a listener so that any changes to that Value
1886
- * will update `.current`.
1978
+ * will update `current`.
1887
1979
  *
1888
1980
  * This has schema-based typing. The following is a simplified representation:
1889
1981
  *
1890
1982
  * ```ts override
1891
- * createValue(
1983
+ * getValue(
1892
1984
  * valueId: MaybeGetter<Id>,
1893
1985
  * storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
1894
1986
  * ): {get current(): ValueOrUndefined; set current(v: Value)};
@@ -1902,7 +1994,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1902
1994
  * @category Getter
1903
1995
  * @since v8.1.0
1904
1996
  */
1905
- createValue: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
1997
+ getValue: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
1906
1998
  valueId: MaybeGetter<ValueId>,
1907
1999
  storeOrStoreId?: StoreOrStoreId<Schemas>,
1908
2000
  ) => {
@@ -1933,13 +2025,13 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1933
2025
  ) => () => Store<Schemas> | undefined;
1934
2026
 
1935
2027
  /**
1936
- * The createStoreIds function returns a reactive object with the Ids of all
1937
- * Stores registered in the current Provider context.
2028
+ * The getStoreIds function returns a reactive object with the Ids of all Stores
2029
+ * registered in the current Provider context.
1938
2030
  * @returns A reactive object with a `current` Ids property.
1939
2031
  * @category Getter
1940
2032
  * @since v8.1.0
1941
2033
  */
1942
- createStoreIds: () => {readonly current: Ids};
2034
+ getStoreIds: () => {readonly current: Ids};
1943
2035
 
1944
2036
  /**
1945
2037
  * The getMetrics function returns the default Metrics object from the current
@@ -1965,33 +2057,33 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1965
2057
  ) => () => Metrics<Schemas> | undefined;
1966
2058
 
1967
2059
  /**
1968
- * The createMetricsIds function returns a reactive object with the Ids of all
2060
+ * The getMetricsIds function returns a reactive object with the Ids of all
1969
2061
  * Metrics objects registered in the current Provider context.
1970
2062
  * @returns A reactive object with a `current` Ids property.
1971
2063
  * @category Getter
1972
2064
  * @since v8.1.0
1973
2065
  */
1974
- createMetricsIds: () => {readonly current: Ids};
2066
+ getMetricsIds: () => {readonly current: Ids};
1975
2067
 
1976
2068
  /**
1977
- * The createMetricIds function returns a reactive object reflecting the Ids of
1978
- * the Metrics in a Metrics object, and registers a listener so that any changes
1979
- * will update `.current`.
2069
+ * The getMetricIds function returns a reactive object reflecting the Ids of the
2070
+ * Metrics in a Metrics object, and registers a listener so that any changes
2071
+ * will update `current`.
1980
2072
  * @param metricsOrMetricsId The Metrics object to use, or its Id.
1981
2073
  * @returns A reactive object with a `current` Ids property.
1982
2074
  * @category Getter
1983
2075
  * @since v8.1.0
1984
2076
  */
1985
- createMetricIds: (
2077
+ getMetricIds: (
1986
2078
  metricsOrMetricsId?: MaybeGetter<MetricsOrMetricsId<Schemas> | undefined>,
1987
2079
  ) => {
1988
2080
  readonly current: Ids;
1989
2081
  };
1990
2082
 
1991
2083
  /**
1992
- * The createMetric function returns a reactive object reflecting the value of a
2084
+ * The getMetric function returns a reactive object reflecting the value of a
1993
2085
  * named Metric in a Metrics object, and registers a listener so that any
1994
- * changes to that Metric will update `.current`.
2086
+ * changes to that Metric will update `current`.
1995
2087
  * @param metricId The Id of the Metric (or a getter returning it).
1996
2088
  * @param metricsOrMetricsId The Metrics object to use (plain or getter), or its
1997
2089
  * Id.
@@ -1999,7 +2091,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1999
2091
  * @category Getter
2000
2092
  * @since v8.1.0
2001
2093
  */
2002
- createMetric: (
2094
+ getMetric: (
2003
2095
  metricId: MaybeGetter<Id>,
2004
2096
  metricsOrMetricsId?: MetricsOrMetricsId<Schemas>,
2005
2097
  ) => {readonly current: number | undefined};
@@ -2045,33 +2137,33 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2045
2137
  };
2046
2138
 
2047
2139
  /**
2048
- * The createIndexesIds function returns a reactive object with the Ids of all
2140
+ * The getIndexesIds function returns a reactive object with the Ids of all
2049
2141
  * Indexes objects registered in the current Provider context.
2050
2142
  * @returns A reactive object with a `current` Ids property.
2051
2143
  * @category Getter
2052
2144
  * @since v8.1.0
2053
2145
  */
2054
- createIndexesIds: () => {readonly current: Ids};
2146
+ getIndexesIds: () => {readonly current: Ids};
2055
2147
 
2056
2148
  /**
2057
- * The createIndexIds function returns a reactive object reflecting the Ids of
2058
- * the Indexes in an Indexes object, and registers a listener so that any
2059
- * changes will update `.current`.
2149
+ * The getIndexIds function returns a reactive object reflecting the Ids of the
2150
+ * Indexes in an Indexes object, and registers a listener so that any changes
2151
+ * will update `current`.
2060
2152
  * @param indexesOrIndexesId The Indexes object to use, or its Id.
2061
2153
  * @returns A reactive object with a `current` Ids property.
2062
2154
  * @category Getter
2063
2155
  * @since v8.1.0
2064
2156
  */
2065
- createIndexIds: (
2157
+ getIndexIds: (
2066
2158
  indexesOrIndexesId?: MaybeGetter<IndexesOrIndexesId<Schemas> | undefined>,
2067
2159
  ) => {
2068
2160
  readonly current: Ids;
2069
2161
  };
2070
2162
 
2071
2163
  /**
2072
- * The createSliceIds function returns a reactive object reflecting the Ids of
2073
- * the Slices in an Index, and registers a listener so that any changes will
2074
- * update `.current`.
2164
+ * The getSliceIds function returns a reactive object reflecting the Ids of the
2165
+ * Slices in an Index, and registers a listener so that any changes will update
2166
+ * `current`.
2075
2167
  * @param indexId The Id of the Index (or a getter returning it).
2076
2168
  * @param indexesOrIndexesId The Indexes object to use (plain or getter), or its
2077
2169
  * Id.
@@ -2079,15 +2171,15 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2079
2171
  * @category Getter
2080
2172
  * @since v8.1.0
2081
2173
  */
2082
- createSliceIds: (
2174
+ getSliceIds: (
2083
2175
  indexId: MaybeGetter<Id>,
2084
2176
  indexesOrIndexesId?: IndexesOrIndexesId<Schemas>,
2085
2177
  ) => {readonly current: Ids};
2086
2178
 
2087
2179
  /**
2088
- * The createSliceRowIds function returns a reactive object reflecting the Ids
2089
- * of the Rows in a Slice, and registers a listener so that any changes will
2090
- * update `.current`.
2180
+ * The getSliceRowIds function returns a reactive object reflecting the Ids of
2181
+ * the Rows in a Slice, and registers a listener so that any changes will update
2182
+ * `current`.
2091
2183
  * @param indexId The Id of the Index (or a getter returning it).
2092
2184
  * @param sliceId The Id of the Slice (or a getter returning it).
2093
2185
  * @param indexesOrIndexesId The Indexes object to use (plain or getter), or its
@@ -2096,7 +2188,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2096
2188
  * @category Getter
2097
2189
  * @since v8.1.0
2098
2190
  */
2099
- createSliceRowIds: (
2191
+ getSliceRowIds: (
2100
2192
  indexId: MaybeGetter<Id>,
2101
2193
  sliceId: MaybeGetter<Id>,
2102
2194
  indexesOrIndexesId?: IndexesOrIndexesId<Schemas>,
@@ -2126,33 +2218,33 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2126
2218
  ) => () => Queries<Schemas> | undefined;
2127
2219
 
2128
2220
  /**
2129
- * The createQueriesIds function returns a reactive object with the Ids of all
2221
+ * The getQueriesIds function returns a reactive object with the Ids of all
2130
2222
  * Queries objects registered in the current Provider context.
2131
2223
  * @returns A reactive object with a `current` Ids property.
2132
2224
  * @category Getter
2133
2225
  * @since v8.1.0
2134
2226
  */
2135
- createQueriesIds: () => {readonly current: Ids};
2227
+ getQueriesIds: () => {readonly current: Ids};
2136
2228
 
2137
2229
  /**
2138
- * The createQueryIds function returns a reactive object reflecting the Ids of
2139
- * the Queries in a Queries object, and registers a listener so that any changes
2140
- * will update `.current`.
2230
+ * The getQueryIds function returns a reactive object reflecting the Ids of the
2231
+ * Queries in a Queries object, and registers a listener so that any changes
2232
+ * will update `current`.
2141
2233
  * @param queriesOrQueriesId The Queries object to use, or its Id.
2142
2234
  * @returns A reactive object with a `current` Ids property.
2143
2235
  * @category Getter
2144
2236
  * @since v8.1.0
2145
2237
  */
2146
- createQueryIds: (
2238
+ getQueryIds: (
2147
2239
  queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId<Schemas> | undefined>,
2148
2240
  ) => {
2149
2241
  readonly current: Ids;
2150
2242
  };
2151
2243
 
2152
2244
  /**
2153
- * The createResultTable function returns a reactive object reflecting a result
2245
+ * The getResultTable function returns a reactive object reflecting a result
2154
2246
  * Table in a Queries object, and registers a listener so that any changes to
2155
- * that result will update `.current`.
2247
+ * that result will update `current`.
2156
2248
  * @param queryId The Id of the Query (or a getter returning it).
2157
2249
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2158
2250
  * Id.
@@ -2160,15 +2252,15 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2160
2252
  * @category Getter
2161
2253
  * @since v8.1.0
2162
2254
  */
2163
- createResultTable: (
2255
+ getResultTable: (
2164
2256
  queryId: MaybeGetter<Id>,
2165
2257
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
2166
2258
  ) => {readonly current: ResultTable};
2167
2259
 
2168
2260
  /**
2169
- * The createResultTableCellIds function returns a reactive object reflecting
2170
- * the Ids of all Cells used across a result Table, and registers a listener so
2171
- * that any changes will update `.current`.
2261
+ * The getResultTableCellIds function returns a reactive object reflecting the
2262
+ * Ids of all Cells used across a result Table, and registers a listener so that
2263
+ * any changes will update `current`.
2172
2264
  * @param queryId The Id of the Query (or a getter returning it).
2173
2265
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2174
2266
  * Id.
@@ -2176,15 +2268,15 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2176
2268
  * @category Getter
2177
2269
  * @since v8.1.0
2178
2270
  */
2179
- createResultTableCellIds: (
2271
+ getResultTableCellIds: (
2180
2272
  queryId: MaybeGetter<Id>,
2181
2273
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
2182
2274
  ) => {readonly current: Ids};
2183
2275
 
2184
2276
  /**
2185
- * The createResultRowCount function returns a reactive object reflecting the
2277
+ * The getResultRowCount function returns a reactive object reflecting the
2186
2278
  * number of Rows in a result Table, and registers a listener so that any
2187
- * changes will update `.current`.
2279
+ * changes will update `current`.
2188
2280
  * @param queryId The Id of the Query (or a getter returning it).
2189
2281
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2190
2282
  * Id.
@@ -2192,15 +2284,15 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2192
2284
  * @category Getter
2193
2285
  * @since v8.1.0
2194
2286
  */
2195
- createResultRowCount: (
2287
+ getResultRowCount: (
2196
2288
  queryId: MaybeGetter<Id>,
2197
2289
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
2198
2290
  ) => {readonly current: number};
2199
2291
 
2200
2292
  /**
2201
- * The createResultRowIds function returns a reactive object reflecting the Ids
2202
- * of the Rows in a result Table, and registers a listener so that any changes
2203
- * will update `.current`.
2293
+ * The getResultRowIds function returns a reactive object reflecting the Ids of
2294
+ * the Rows in a result Table, and registers a listener so that any changes will
2295
+ * update `current`.
2204
2296
  * @param queryId The Id of the Query (or a getter returning it).
2205
2297
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
2206
2298
  * Id.
@@ -2208,15 +2300,15 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2208
2300
  * @category Getter
2209
2301
  * @since v8.1.0
2210
2302
  */
2211
- createResultRowIds: (
2303
+ getResultRowIds: (
2212
2304
  queryId: MaybeGetter<Id>,
2213
2305
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
2214
2306
  ) => {readonly current: Ids};
2215
2307
 
2216
2308
  /**
2217
- * The createResultSortedRowIds function returns a reactive object reflecting
2218
- * the sorted Row Ids in a result Table, and registers a listener so that any
2219
- * changes will update `.current`.
2309
+ * The getResultSortedRowIds function returns a reactive object reflecting the
2310
+ * sorted Row Ids in a result Table, and registers a listener so that any
2311
+ * changes will update `current`.
2220
2312
  * @param queryId The Id of the Query (or a getter returning it).
2221
2313
  * @param cellId The Id of the Cell to sort by (or a getter returning it).
2222
2314
  * @param descending Whether to sort descending (or a getter returning it).
@@ -2228,7 +2320,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2228
2320
  * @category Getter
2229
2321
  * @since v8.1.0
2230
2322
  */
2231
- createResultSortedRowIds: (
2323
+ getResultSortedRowIds: (
2232
2324
  queryId: MaybeGetter<Id>,
2233
2325
  cellId?: MaybeGetter<Id | undefined>,
2234
2326
  descending?: MaybeGetter<boolean>,
@@ -2238,9 +2330,9 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2238
2330
  ) => {readonly current: Ids};
2239
2331
 
2240
2332
  /**
2241
- * The createResultRow function returns a reactive object reflecting a result
2242
- * Row in a result Table, and registers a listener so that any changes will
2243
- * update `.current`.
2333
+ * The getResultRow function returns a reactive object reflecting a result Row
2334
+ * in a result Table, and registers a listener so that any changes will update
2335
+ * `current`.
2244
2336
  * @param queryId The Id of the Query (or a getter returning it).
2245
2337
  * @param rowId The Id of the Row (or a getter returning it).
2246
2338
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
@@ -2249,16 +2341,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2249
2341
  * @category Getter
2250
2342
  * @since v8.1.0
2251
2343
  */
2252
- createResultRow: (
2344
+ getResultRow: (
2253
2345
  queryId: MaybeGetter<Id>,
2254
2346
  rowId: MaybeGetter<Id>,
2255
2347
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
2256
2348
  ) => {readonly current: ResultRow};
2257
2349
 
2258
2350
  /**
2259
- * The createResultCellIds function returns a reactive object reflecting the Ids
2260
- * of the Cells in a result Row, and registers a listener so that any changes
2261
- * will update `.current`.
2351
+ * The getResultCellIds function returns a reactive object reflecting the Ids of
2352
+ * the Cells in a result Row, and registers a listener so that any changes will
2353
+ * update `current`.
2262
2354
  * @param queryId The Id of the Query (or a getter returning it).
2263
2355
  * @param rowId The Id of the Row (or a getter returning it).
2264
2356
  * @param queriesOrQueriesId The Queries object to use (plain or getter), or its
@@ -2267,16 +2359,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2267
2359
  * @category Getter
2268
2360
  * @since v8.1.0
2269
2361
  */
2270
- createResultCellIds: (
2362
+ getResultCellIds: (
2271
2363
  queryId: MaybeGetter<Id>,
2272
2364
  rowId: MaybeGetter<Id>,
2273
2365
  queriesOrQueriesId?: QueriesOrQueriesId<Schemas>,
2274
2366
  ) => {readonly current: Ids};
2275
2367
 
2276
2368
  /**
2277
- * The createResultCell function returns a reactive object reflecting the value
2278
- * of a Cell in a result Row, and registers a listener so that any changes will
2279
- * update `.current`.
2369
+ * The getResultCell function returns a reactive object reflecting the value of
2370
+ * a Cell in a result Row, and registers a listener so that any changes will
2371
+ * update `current`.
2280
2372
  * @param queryId The Id of the Query (or a getter returning it).
2281
2373
  * @param rowId The Id of the Row (or a getter returning it).
2282
2374
  * @param cellId The Id of the Cell (or a getter returning it).
@@ -2286,7 +2378,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2286
2378
  * @category Getter
2287
2379
  * @since v8.1.0
2288
2380
  */
2289
- createResultCell: (
2381
+ getResultCell: (
2290
2382
  queryId: MaybeGetter<Id>,
2291
2383
  rowId: MaybeGetter<Id>,
2292
2384
  cellId: MaybeGetter<Id>,
@@ -2343,34 +2435,34 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2343
2435
  };
2344
2436
 
2345
2437
  /**
2346
- * The createRelationshipsIds function returns a reactive object with the Ids of
2438
+ * The getRelationshipsIds function returns a reactive object with the Ids of
2347
2439
  * all Relationships objects registered in the current Provider context.
2348
2440
  * @returns A reactive object with a `current` Ids property.
2349
2441
  * @category Getter
2350
2442
  * @since v8.1.0
2351
2443
  */
2352
- createRelationshipsIds: () => {readonly current: Ids};
2444
+ getRelationshipsIds: () => {readonly current: Ids};
2353
2445
 
2354
2446
  /**
2355
- * The createRelationshipIds function returns a reactive object reflecting the
2356
- * Ids of the Relationships in a Relationships object, and registers a listener
2357
- * so that any changes will update `.current`.
2447
+ * The getRelationshipIds function returns a reactive object reflecting the Ids
2448
+ * of the Relationships in a Relationships object, and registers a listener so
2449
+ * that any changes will update `current`.
2358
2450
  * @param relationshipsOrRelationshipsId The Relationships object to use, or its
2359
2451
  * Id.
2360
2452
  * @returns A reactive object with a `current` Ids property.
2361
2453
  * @category Getter
2362
2454
  * @since v8.1.0
2363
2455
  */
2364
- createRelationshipIds: (
2456
+ getRelationshipIds: (
2365
2457
  relationshipsOrRelationshipsId?: MaybeGetter<
2366
2458
  RelationshipsOrRelationshipsId<Schemas> | undefined
2367
2459
  >,
2368
2460
  ) => {readonly current: Ids};
2369
2461
 
2370
2462
  /**
2371
- * The createRemoteRowId function returns a reactive object reflecting the
2372
- * remote Row Id for a given local Row in a Relationship, and registers a
2373
- * listener so that any changes will update `.current`.
2463
+ * The getRemoteRowId function returns a reactive object reflecting the remote
2464
+ * Row Id for a given local Row in a Relationship, and registers a listener so
2465
+ * that any changes will update `current`.
2374
2466
  * @param relationshipId The Id of the Relationship (or a getter returning it).
2375
2467
  * @param localRowId The Id of the local Row (or a getter returning it).
2376
2468
  * @param relationshipsOrRelationshipsId The Relationships object to use (plain
@@ -2379,16 +2471,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2379
2471
  * @category Getter
2380
2472
  * @since v8.1.0
2381
2473
  */
2382
- createRemoteRowId: (
2474
+ getRemoteRowId: (
2383
2475
  relationshipId: MaybeGetter<Id>,
2384
2476
  localRowId: MaybeGetter<Id>,
2385
2477
  relationshipsOrRelationshipsId?: RelationshipsOrRelationshipsId<Schemas>,
2386
2478
  ) => {readonly current: Id | undefined};
2387
2479
 
2388
2480
  /**
2389
- * The createLocalRowIds function returns a reactive object reflecting the local
2481
+ * The getLocalRowIds function returns a reactive object reflecting the local
2390
2482
  * Row Ids for a given remote Row in a Relationship, and registers a listener so
2391
- * that any changes will update `.current`.
2483
+ * that any changes will update `current`.
2392
2484
  * @param relationshipId The Id of the Relationship (or a getter returning it).
2393
2485
  * @param remoteRowId The Id of the remote Row (or a getter returning it).
2394
2486
  * @param relationshipsOrRelationshipsId The Relationships object to use (plain
@@ -2397,16 +2489,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2397
2489
  * @category Getter
2398
2490
  * @since v8.1.0
2399
2491
  */
2400
- createLocalRowIds: (
2492
+ getLocalRowIds: (
2401
2493
  relationshipId: MaybeGetter<Id>,
2402
2494
  remoteRowId: MaybeGetter<Id>,
2403
2495
  relationshipsOrRelationshipsId?: RelationshipsOrRelationshipsId<Schemas>,
2404
2496
  ) => {readonly current: Ids};
2405
2497
 
2406
2498
  /**
2407
- * The createLinkedRowIds function returns a reactive object reflecting the
2408
- * linked Row Ids in a Relationship, and registers a listener so that any
2409
- * changes will update `.current`.
2499
+ * The getLinkedRowIds function returns a reactive object reflecting the linked
2500
+ * Row Ids in a Relationship, and registers a listener so that any changes will
2501
+ * update `current`.
2410
2502
  * @param relationshipId The Id of the Relationship (or a getter returning it).
2411
2503
  * @param firstRowId The Id of the first Row (or a getter returning it).
2412
2504
  * @param relationshipsOrRelationshipsId The Relationships object to use (plain
@@ -2415,7 +2507,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2415
2507
  * @category Getter
2416
2508
  * @since v8.1.0
2417
2509
  */
2418
- createLinkedRowIds: (
2510
+ getLinkedRowIds: (
2419
2511
  relationshipId: MaybeGetter<Id>,
2420
2512
  firstRowId: MaybeGetter<Id>,
2421
2513
  relationshipsOrRelationshipsId?: RelationshipsOrRelationshipsId<Schemas>,
@@ -2448,32 +2540,32 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2448
2540
  ) => () => Checkpoints<Schemas> | undefined;
2449
2541
 
2450
2542
  /**
2451
- * The createCheckpointsIds function returns a reactive object with the Ids of
2452
- * all Checkpoints objects registered in the current Provider context.
2543
+ * The getCheckpointsIds function returns a reactive object with the Ids of all
2544
+ * Checkpoints objects registered in the current Provider context.
2453
2545
  * @returns A reactive object with a `current` Ids property.
2454
2546
  * @category Getter
2455
2547
  * @since v8.1.0
2456
2548
  */
2457
- createCheckpointsIds: () => {readonly current: Ids};
2549
+ getCheckpointsIds: () => {readonly current: Ids};
2458
2550
 
2459
2551
  /**
2460
- * The createCheckpointIds function returns a reactive object reflecting the
2552
+ * The getCheckpointIds function returns a reactive object reflecting the
2461
2553
  * CheckpointIds (backward, current, forward) in a Checkpoints object, and
2462
- * registers a listener so that any changes will update `.current`.
2554
+ * registers a listener so that any changes will update `current`.
2463
2555
  * @param checkpointsOrCheckpointsId The Checkpoints object to use (plain or
2464
2556
  * getter), or its Id.
2465
2557
  * @returns A reactive object with a `current` CheckpointIds property.
2466
2558
  * @category Getter
2467
2559
  * @since v8.1.0
2468
2560
  */
2469
- createCheckpointIds: (
2561
+ getCheckpointIds: (
2470
2562
  checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId<Schemas>,
2471
2563
  ) => {readonly current: CheckpointIds};
2472
2564
 
2473
2565
  /**
2474
- * The createCheckpoint function returns a reactive object reflecting the label
2475
- * of a checkpoint, and registers a listener so that any changes will
2476
- * update `.current`.
2566
+ * The getCheckpoint function returns a reactive object reflecting the label of
2567
+ * a checkpoint, and registers a listener so that any changes will update
2568
+ * `current`.
2477
2569
  * @param checkpointId The Id of the checkpoint (or a getter returning it).
2478
2570
  * @param checkpointsOrCheckpointsId The Checkpoints object to use (plain or
2479
2571
  * getter), or its Id.
@@ -2481,7 +2573,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2481
2573
  * @category Getter
2482
2574
  * @since v8.1.0
2483
2575
  */
2484
- createCheckpoint: (
2576
+ getCheckpoint: (
2485
2577
  checkpointId: MaybeGetter<Id>,
2486
2578
  checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId<Schemas>,
2487
2579
  ) => {readonly current: string | undefined};
@@ -2540,24 +2632,24 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2540
2632
  ) => () => AnyPersister<Schemas> | undefined;
2541
2633
 
2542
2634
  /**
2543
- * The createPersisterIds function returns a reactive object with the Ids of all
2635
+ * The getPersisterIds function returns a reactive object with the Ids of all
2544
2636
  * Persisters registered in the current Provider context.
2545
2637
  * @returns A reactive object with a `current` Ids property.
2546
2638
  * @category Getter
2547
2639
  * @since v8.1.0
2548
2640
  */
2549
- createPersisterIds: () => {readonly current: Ids};
2641
+ getPersisterIds: () => {readonly current: Ids};
2550
2642
 
2551
2643
  /**
2552
- * The createPersisterStatus function returns a reactive object reflecting the
2644
+ * The getPersisterStatus function returns a reactive object reflecting the
2553
2645
  * status of a Persister, and registers a listener so that any changes will
2554
- * update `.current`.
2646
+ * update `current`.
2555
2647
  * @param persisterOrPersisterId The Persister to use, or its Id.
2556
2648
  * @returns A reactive object with a `current` Status property.
2557
2649
  * @category Getter
2558
2650
  * @since v8.1.0
2559
2651
  */
2560
- createPersisterStatus: (
2652
+ getPersisterStatus: (
2561
2653
  persisterOrPersisterId?: MaybeGetter<
2562
2654
  PersisterOrPersisterId<Schemas> | undefined
2563
2655
  >,
@@ -2591,24 +2683,24 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2591
2683
  ) => () => Synchronizer<Schemas> | undefined;
2592
2684
 
2593
2685
  /**
2594
- * The createSynchronizerIds function returns a reactive object with the Ids of
2595
- * all Synchronizers registered in the current Provider context.
2686
+ * The getSynchronizerIds function returns a reactive object with the Ids of all
2687
+ * Synchronizers registered in the current Provider context.
2596
2688
  * @returns A reactive object with a `current` Ids property.
2597
2689
  * @category Getter
2598
2690
  * @since v8.1.0
2599
2691
  */
2600
- createSynchronizerIds: () => {readonly current: Ids};
2692
+ getSynchronizerIds: () => {readonly current: Ids};
2601
2693
 
2602
2694
  /**
2603
- * The createSynchronizerStatus function returns a reactive object reflecting
2604
- * the status of a Synchronizer, and registers a listener so that any changes
2605
- * will update `.current`.
2695
+ * The getSynchronizerStatus function returns a reactive object reflecting the
2696
+ * status of a Synchronizer, and registers a listener so that any changes will
2697
+ * update `current`.
2606
2698
  * @param synchronizerOrSynchronizerId The Synchronizer to use, or its Id.
2607
2699
  * @returns A reactive object with a `current` Status property.
2608
2700
  * @category Getter
2609
2701
  * @since v8.1.0
2610
2702
  */
2611
- createSynchronizerStatus: (
2703
+ getSynchronizerStatus: (
2612
2704
  synchronizerOrSynchronizerId?: MaybeGetter<
2613
2705
  SynchronizerOrSynchronizerId<Schemas> | undefined
2614
2706
  >,