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.
- package/@types/indexes/index.d.ts +0 -1
- package/@types/indexes/with-schemas/index.d.ts +0 -1
- package/@types/metrics/index.d.ts +0 -1
- package/@types/metrics/with-schemas/index.d.ts +0 -1
- package/@types/ui-react/index.d.ts +2 -1
- package/@types/ui-react/with-schemas/index.d.ts +2 -1
- package/@types/ui-svelte/index.d.ts +462 -361
- package/@types/ui-svelte/with-schemas/index.d.ts +451 -359
- package/min/omni/index.js +1 -1
- package/min/omni/index.js.gz +0 -0
- package/min/omni/with-schemas/index.js +1 -1
- package/min/omni/with-schemas/index.js.gz +0 -0
- package/min/persisters/persister-partykit-server/index.js +1 -1
- package/min/persisters/persister-partykit-server/index.js.gz +0 -0
- package/min/persisters/persister-partykit-server/with-schemas/index.js +1 -1
- package/min/persisters/persister-partykit-server/with-schemas/index.js.gz +0 -0
- package/min/persisters/persister-remote/index.js +1 -1
- package/min/persisters/persister-remote/index.js.gz +0 -0
- package/min/persisters/persister-remote/with-schemas/index.js +1 -1
- package/min/persisters/persister-remote/with-schemas/index.js.gz +0 -0
- package/min/ui-svelte/index.js +1 -1
- package/min/ui-svelte/index.js.gz +0 -0
- package/min/ui-svelte/with-schemas/index.js +1 -1
- package/min/ui-svelte/with-schemas/index.js.gz +0 -0
- package/omni/index.js +5 -2
- package/omni/with-schemas/index.js +5 -2
- package/package.json +5 -5
- package/persisters/persister-partykit-server/index.js +1 -0
- package/persisters/persister-partykit-server/with-schemas/index.js +1 -0
- package/persisters/persister-remote/index.js +4 -2
- package/persisters/persister-remote/with-schemas/index.js +4 -2
- package/readme.md +5 -5
- package/releases.md +15 -7
- package/ui-svelte/index.js +121 -121
- package/ui-svelte/with-schemas/index.js +121 -121
|
@@ -8,13 +8,22 @@
|
|
|
8
8
|
* objects with a `current` property. Those functions register listeners such
|
|
9
9
|
* that components using them re-render when data changes.
|
|
10
10
|
*
|
|
11
|
+
* The components in this module provide a further abstraction over those
|
|
12
|
+
* reactive functions, and use Svelte snippet props to customize rendering in
|
|
13
|
+
* an idiomatic way.
|
|
14
|
+
*
|
|
15
|
+
* Functions like the getStore function and getMetrics function return TinyBase
|
|
16
|
+
* objects directly from Provider context. Functions like the getCell function,
|
|
17
|
+
* the getRow function, the getTable function, the getValue function, and the
|
|
18
|
+
* hasCell function return reactive objects whose `current` property reflects
|
|
19
|
+
* underlying TinyBase data.
|
|
20
|
+
*
|
|
11
21
|
* Function parameters accept either plain values or reactive getter functions
|
|
12
|
-
* (
|
|
22
|
+
* (as per the MaybeGetter type), so passing `() => tableId` from a `let`-bound
|
|
13
23
|
* Svelte prop makes the function re-execute whenever the prop changes.
|
|
14
|
-
*
|
|
15
|
-
* The components in this module provide a further abstraction over those
|
|
16
|
-
* functions to ease the composition of user interfaces that use TinyBase.
|
|
17
24
|
* @see Building UIs With Svelte guide
|
|
25
|
+
* @see Hello World (Svelte) demo
|
|
26
|
+
* @see Countries (Svelte) demo
|
|
18
27
|
* @packageDocumentation
|
|
19
28
|
* @module ui-svelte
|
|
20
29
|
* @since v8.1.0
|
|
@@ -124,17 +133,17 @@ export type StoreOrStoreId = Store | Id;
|
|
|
124
133
|
* The MetricsOrMetricsId type is used when you need to refer to a Metrics
|
|
125
134
|
* object in a ui-svelte function or component.
|
|
126
135
|
*
|
|
127
|
-
* In some simple cases you will already have a direct reference to the
|
|
128
|
-
*
|
|
136
|
+
* In some simple cases you will already have a direct reference to the Metrics
|
|
137
|
+
* object.
|
|
129
138
|
*
|
|
130
139
|
* This module also includes a Provider component that can be used to wrap
|
|
131
140
|
* multiple Metrics objects into a context that can be used throughout the app.
|
|
132
|
-
* In this case you will want to refer to a Metrics object by its Id in
|
|
133
|
-
*
|
|
141
|
+
* In this case you will want to refer to a Metrics object by its Id in that
|
|
142
|
+
* context.
|
|
134
143
|
*
|
|
135
144
|
* Many functions and components in this ui-svelte module take this type as a
|
|
136
|
-
* parameter or a prop, allowing you to pass in either the Metrics object or
|
|
137
|
-
*
|
|
145
|
+
* parameter or a prop, allowing you to pass in either the Metrics object or its
|
|
146
|
+
* Id.
|
|
138
147
|
* @category Identity
|
|
139
148
|
* @since v8.1.0
|
|
140
149
|
*/
|
|
@@ -144,17 +153,17 @@ export type MetricsOrMetricsId = Metrics | Id;
|
|
|
144
153
|
* The IndexesOrIndexesId type is used when you need to refer to an Indexes
|
|
145
154
|
* object in a ui-svelte function or component.
|
|
146
155
|
*
|
|
147
|
-
* In some simple cases you will already have a direct reference to the
|
|
148
|
-
*
|
|
156
|
+
* In some simple cases you will already have a direct reference to the Indexes
|
|
157
|
+
* object.
|
|
149
158
|
*
|
|
150
159
|
* This module also includes a Provider component that can be used to wrap
|
|
151
160
|
* multiple Indexes objects into a context that can be used throughout the app.
|
|
152
|
-
* In this case you will want to refer to an Indexes object by its Id in
|
|
153
|
-
*
|
|
161
|
+
* In this case you will want to refer to an Indexes object by its Id in that
|
|
162
|
+
* context.
|
|
154
163
|
*
|
|
155
164
|
* Many functions and components in this ui-svelte module take this type as a
|
|
156
|
-
* parameter or a prop, allowing you to pass in either the Indexes object or
|
|
157
|
-
*
|
|
165
|
+
* parameter or a prop, allowing you to pass in either the Indexes object or its
|
|
166
|
+
* Id.
|
|
158
167
|
* @category Identity
|
|
159
168
|
* @since v8.1.0
|
|
160
169
|
*/
|
|
@@ -184,17 +193,17 @@ export type RelationshipsOrRelationshipsId = Relationships | Id;
|
|
|
184
193
|
* The QueriesOrQueriesId type is used when you need to refer to a Queries
|
|
185
194
|
* object in a ui-svelte function or component.
|
|
186
195
|
*
|
|
187
|
-
* In some simple cases you will already have a direct reference to the
|
|
188
|
-
*
|
|
196
|
+
* In some simple cases you will already have a direct reference to the Queries
|
|
197
|
+
* object.
|
|
189
198
|
*
|
|
190
199
|
* This module also includes a Provider component that can be used to wrap
|
|
191
200
|
* multiple Queries objects into a context that can be used throughout the app.
|
|
192
|
-
* In this case you will want to refer to a Queries object by its Id in
|
|
193
|
-
*
|
|
201
|
+
* In this case you will want to refer to a Queries object by its Id in that
|
|
202
|
+
* context.
|
|
194
203
|
*
|
|
195
204
|
* Many functions and components in this ui-svelte module take this type as a
|
|
196
|
-
* parameter or a prop, allowing you to pass in either the Queries object or
|
|
197
|
-
*
|
|
205
|
+
* parameter or a prop, allowing you to pass in either the Queries object or its
|
|
206
|
+
* Id.
|
|
198
207
|
* @category Identity
|
|
199
208
|
* @since v8.1.0
|
|
200
209
|
*/
|
|
@@ -252,8 +261,8 @@ export type PersisterOrPersisterId = AnyPersister | Id;
|
|
|
252
261
|
* in that context.
|
|
253
262
|
*
|
|
254
263
|
* Many functions and components in this ui-svelte module take this type as a
|
|
255
|
-
* parameter or a prop, allowing you to pass in either the Synchronizer or
|
|
256
|
-
*
|
|
264
|
+
* parameter or a prop, allowing you to pass in either the Synchronizer or its
|
|
265
|
+
* Id.
|
|
257
266
|
* @category Identity
|
|
258
267
|
* @since v8.1.0
|
|
259
268
|
*/
|
|
@@ -261,8 +270,9 @@ export type SynchronizerOrSynchronizerId = Synchronizer | Id;
|
|
|
261
270
|
|
|
262
271
|
/**
|
|
263
272
|
* ProviderProps props are used with the Provider component, so that Store,
|
|
264
|
-
* Metrics, Indexes, Relationships, Queries,
|
|
265
|
-
* passed into the context of a Svelte 5 application and
|
|
273
|
+
* Metrics, Indexes, Relationships, Queries, Checkpoints, Persisters, and
|
|
274
|
+
* Synchronizers can be passed into the context of a Svelte 5 application and
|
|
275
|
+
* used throughout.
|
|
266
276
|
*
|
|
267
277
|
* One of each type of object can be provided as a default within the context.
|
|
268
278
|
* Additionally, multiple of each type of object can be provided in an Id-keyed
|
|
@@ -383,47 +393,44 @@ export type ProviderProps = {
|
|
|
383
393
|
* @since v8.1.0
|
|
384
394
|
*/
|
|
385
395
|
readonly synchronizersById?: {readonly [id: Id]: Synchronizer};
|
|
386
|
-
/**
|
|
387
|
-
* The `children` prop of a ProviderProps object — the app subtree that will
|
|
388
|
-
* have access to the provided context.
|
|
389
|
-
* @category Prop
|
|
390
|
-
* @since v8.1.0
|
|
391
|
-
*/
|
|
392
396
|
readonly children: Snippet;
|
|
393
397
|
};
|
|
394
398
|
|
|
395
399
|
/**
|
|
396
|
-
*
|
|
400
|
+
* CellViewProps props are used for components that refer to a single Cell in a
|
|
401
|
+
* Row, such as the CellView component.
|
|
397
402
|
* @category Props
|
|
398
403
|
* @since v8.1.0
|
|
399
404
|
*/
|
|
400
405
|
export type CellViewProps = {
|
|
401
406
|
/**
|
|
402
|
-
* The
|
|
407
|
+
* The Id of the Table in the Store.
|
|
403
408
|
* @category Props
|
|
404
409
|
* @since v8.1.0
|
|
405
410
|
*/
|
|
406
411
|
readonly tableId: Id;
|
|
407
412
|
/**
|
|
408
|
-
* The
|
|
413
|
+
* The Id of the Row in the Table.
|
|
409
414
|
* @category Props
|
|
410
415
|
* @since v8.1.0
|
|
411
416
|
*/
|
|
412
417
|
readonly rowId: Id;
|
|
413
418
|
/**
|
|
414
|
-
* The
|
|
419
|
+
* The Id of the Cell in the Row to be rendered.
|
|
415
420
|
* @category Props
|
|
416
421
|
* @since v8.1.0
|
|
417
422
|
*/
|
|
418
423
|
readonly cellId: Id;
|
|
419
424
|
/**
|
|
420
|
-
* The
|
|
425
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
426
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
421
427
|
* @category Props
|
|
422
428
|
* @since v8.1.0
|
|
423
429
|
*/
|
|
424
430
|
readonly store?: StoreOrStoreId;
|
|
425
431
|
/**
|
|
426
|
-
*
|
|
432
|
+
* Whether the component should also render the Id of the Cell to assist with
|
|
433
|
+
* debugging.
|
|
427
434
|
* @category Props
|
|
428
435
|
* @since v8.1.0
|
|
429
436
|
*/
|
|
@@ -431,25 +438,28 @@ export type CellViewProps = {
|
|
|
431
438
|
};
|
|
432
439
|
|
|
433
440
|
/**
|
|
434
|
-
*
|
|
441
|
+
* ValueViewProps props are used for components that refer to a single Value in
|
|
442
|
+
* a Store, such as the ValueView component.
|
|
435
443
|
* @category Props
|
|
436
444
|
* @since v8.1.0
|
|
437
445
|
*/
|
|
438
446
|
export type ValueViewProps = {
|
|
439
447
|
/**
|
|
440
|
-
* The
|
|
448
|
+
* The Id of the Value in the Store to be rendered.
|
|
441
449
|
* @category Props
|
|
442
450
|
* @since v8.1.0
|
|
443
451
|
*/
|
|
444
452
|
readonly valueId: Id;
|
|
445
453
|
/**
|
|
446
|
-
* The
|
|
454
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
455
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
447
456
|
* @category Props
|
|
448
457
|
* @since v8.1.0
|
|
449
458
|
*/
|
|
450
459
|
readonly store?: StoreOrStoreId;
|
|
451
460
|
/**
|
|
452
|
-
*
|
|
461
|
+
* Whether the component should also render the Id of the Value to assist
|
|
462
|
+
* with debugging.
|
|
453
463
|
* @category Props
|
|
454
464
|
* @since v8.1.0
|
|
455
465
|
*/
|
|
@@ -457,25 +467,29 @@ export type ValueViewProps = {
|
|
|
457
467
|
};
|
|
458
468
|
|
|
459
469
|
/**
|
|
460
|
-
*
|
|
470
|
+
* MetricViewProps props are used for components that refer to a single Metric
|
|
471
|
+
* in a Metrics object, such as the MetricView component.
|
|
461
472
|
* @category Props
|
|
462
473
|
* @since v8.1.0
|
|
463
474
|
*/
|
|
464
475
|
export type MetricViewProps = {
|
|
465
476
|
/**
|
|
466
|
-
* The
|
|
477
|
+
* The Id of the Metric in the Metrics object to be rendered.
|
|
467
478
|
* @category Props
|
|
468
479
|
* @since v8.1.0
|
|
469
480
|
*/
|
|
470
481
|
readonly metricId: Id;
|
|
471
482
|
/**
|
|
472
|
-
* The
|
|
483
|
+
* The Metrics object to be accessed: omit for the default context Metrics
|
|
484
|
+
* object, provide an Id for a named context Metrics object, or provide an
|
|
485
|
+
* explicit reference.
|
|
473
486
|
* @category Props
|
|
474
487
|
* @since v8.1.0
|
|
475
488
|
*/
|
|
476
489
|
readonly metrics?: MetricsOrMetricsId;
|
|
477
490
|
/**
|
|
478
|
-
*
|
|
491
|
+
* Whether the component should also render the Id of the Metric to assist
|
|
492
|
+
* with debugging.
|
|
479
493
|
* @category Props
|
|
480
494
|
* @since v8.1.0
|
|
481
495
|
*/
|
|
@@ -483,26 +497,29 @@ export type MetricViewProps = {
|
|
|
483
497
|
};
|
|
484
498
|
|
|
485
499
|
/**
|
|
486
|
-
*
|
|
487
|
-
* CheckpointView component.
|
|
500
|
+
* CheckpointViewProps props are used for components that refer to a single
|
|
501
|
+
* checkpoint in a Checkpoints object, such as the CheckpointView component.
|
|
488
502
|
* @category Props
|
|
489
503
|
* @since v8.1.0
|
|
490
504
|
*/
|
|
491
505
|
export type CheckpointViewProps = {
|
|
492
506
|
/**
|
|
493
|
-
* The
|
|
507
|
+
* The Id of the checkpoint in the Checkpoints object.
|
|
494
508
|
* @category Props
|
|
495
509
|
* @since v8.1.0
|
|
496
510
|
*/
|
|
497
511
|
readonly checkpointId: Id;
|
|
498
512
|
/**
|
|
499
|
-
* The
|
|
513
|
+
* The Checkpoints object to be accessed: omit for the default context
|
|
514
|
+
* Checkpoints object, provide an Id for a named context Checkpoints object,
|
|
515
|
+
* or provide an explicit reference.
|
|
500
516
|
* @category Props
|
|
501
517
|
* @since v8.1.0
|
|
502
518
|
*/
|
|
503
519
|
readonly checkpoints?: CheckpointsOrCheckpointsId;
|
|
504
520
|
/**
|
|
505
|
-
*
|
|
521
|
+
* Whether the component should also render the Id of the checkpoint to
|
|
522
|
+
* assist with debugging.
|
|
506
523
|
* @category Props
|
|
507
524
|
* @since v8.1.0
|
|
508
525
|
*/
|
|
@@ -510,49 +527,54 @@ export type CheckpointViewProps = {
|
|
|
510
527
|
};
|
|
511
528
|
|
|
512
529
|
/**
|
|
513
|
-
*
|
|
530
|
+
* RowViewProps props are used for components that refer to a single Row in a
|
|
531
|
+
* Table, such as the RowView component.
|
|
514
532
|
* @category Props
|
|
515
533
|
* @since v8.1.0
|
|
516
534
|
*/
|
|
517
535
|
export type RowViewProps = {
|
|
518
536
|
/**
|
|
519
|
-
* The
|
|
537
|
+
* The Id of the Table in the Store.
|
|
520
538
|
* @category Props
|
|
521
539
|
* @since v8.1.0
|
|
522
540
|
*/
|
|
523
541
|
readonly tableId: Id;
|
|
524
542
|
/**
|
|
525
|
-
* The
|
|
543
|
+
* The Id of the Row in the Table to be rendered.
|
|
526
544
|
* @category Props
|
|
527
545
|
* @since v8.1.0
|
|
528
546
|
*/
|
|
529
547
|
readonly rowId: Id;
|
|
530
548
|
/**
|
|
531
|
-
* The
|
|
549
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
550
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
532
551
|
* @category Props
|
|
533
552
|
* @since v8.1.0
|
|
534
553
|
*/
|
|
535
554
|
readonly store?: StoreOrStoreId;
|
|
536
555
|
/**
|
|
537
|
-
*
|
|
556
|
+
* An optional list of Cell Ids to use for rendering a prescribed set of the
|
|
557
|
+
* Row's Cells in a given order.
|
|
538
558
|
* @category Props
|
|
539
559
|
* @since v8.1.0
|
|
540
560
|
*/
|
|
541
561
|
readonly customCellIds?: Ids;
|
|
542
562
|
/**
|
|
543
|
-
*
|
|
563
|
+
* A component or string to separate each rendered Cell.
|
|
544
564
|
* @category Props
|
|
545
565
|
* @since v8.1.0
|
|
546
566
|
*/
|
|
547
567
|
readonly separator?: Snippet<[]>;
|
|
548
568
|
/**
|
|
549
|
-
*
|
|
569
|
+
* Whether the component should also render the Id of the Row, and its
|
|
570
|
+
* descendent objects, to assist with debugging.
|
|
550
571
|
* @category Props
|
|
551
572
|
* @since v8.1.0
|
|
552
573
|
*/
|
|
553
574
|
readonly debugIds?: boolean;
|
|
554
575
|
/**
|
|
555
|
-
*
|
|
576
|
+
* A snippet for rendering each Cell in the Row, to override the default
|
|
577
|
+
* CellView component.
|
|
556
578
|
* @category Props
|
|
557
579
|
* @since v8.1.0
|
|
558
580
|
*/
|
|
@@ -560,43 +582,48 @@ export type RowViewProps = {
|
|
|
560
582
|
};
|
|
561
583
|
|
|
562
584
|
/**
|
|
563
|
-
*
|
|
585
|
+
* TableViewProps props are used for components that refer to a single Table in
|
|
586
|
+
* a Store, such as the TableView component.
|
|
564
587
|
* @category Props
|
|
565
588
|
* @since v8.1.0
|
|
566
589
|
*/
|
|
567
590
|
export type TableViewProps = {
|
|
568
591
|
/**
|
|
569
|
-
* The
|
|
592
|
+
* The Id of the Table in the Store to be rendered.
|
|
570
593
|
* @category Props
|
|
571
594
|
* @since v8.1.0
|
|
572
595
|
*/
|
|
573
596
|
readonly tableId: Id;
|
|
574
597
|
/**
|
|
575
|
-
* The
|
|
598
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
599
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
576
600
|
* @category Props
|
|
577
601
|
* @since v8.1.0
|
|
578
602
|
*/
|
|
579
603
|
readonly store?: StoreOrStoreId;
|
|
580
604
|
/**
|
|
581
|
-
*
|
|
605
|
+
* An optional list of Cell Ids to use for rendering a prescribed set of the
|
|
606
|
+
* Table's Cells in a given order for each Row.
|
|
582
607
|
* @category Props
|
|
583
608
|
* @since v8.1.0
|
|
584
609
|
*/
|
|
585
610
|
readonly customCellIds?: Ids;
|
|
586
611
|
/**
|
|
587
|
-
*
|
|
612
|
+
* A component or string to separate each rendered Row.
|
|
588
613
|
* @category Props
|
|
589
614
|
* @since v8.1.0
|
|
590
615
|
*/
|
|
591
616
|
readonly separator?: Snippet<[]>;
|
|
592
617
|
/**
|
|
593
|
-
*
|
|
618
|
+
* Whether the component should also render the Id of the Table, and its
|
|
619
|
+
* descendent objects, to assist with debugging.
|
|
594
620
|
* @category Props
|
|
595
621
|
* @since v8.1.0
|
|
596
622
|
*/
|
|
597
623
|
readonly debugIds?: boolean;
|
|
598
624
|
/**
|
|
599
|
-
*
|
|
625
|
+
* A snippet for rendering each Row in the Table, to override the default
|
|
626
|
+
* RowView component.
|
|
600
627
|
* @category Props
|
|
601
628
|
* @since v8.1.0
|
|
602
629
|
*/
|
|
@@ -604,68 +631,73 @@ export type TableViewProps = {
|
|
|
604
631
|
};
|
|
605
632
|
|
|
606
633
|
/**
|
|
607
|
-
*
|
|
608
|
-
* SortedTableView component.
|
|
634
|
+
* SortedTableViewProps props are used for components that refer to a single
|
|
635
|
+
* sorted Table in a Store, such as the SortedTableView component.
|
|
609
636
|
* @category Props
|
|
610
637
|
* @since v8.1.0
|
|
611
638
|
*/
|
|
612
639
|
export type SortedTableViewProps = {
|
|
613
640
|
/**
|
|
614
|
-
* The
|
|
641
|
+
* The Id of the Table in the Store to be rendered.
|
|
615
642
|
* @category Props
|
|
616
643
|
* @since v8.1.0
|
|
617
644
|
*/
|
|
618
645
|
readonly tableId: Id;
|
|
619
646
|
/**
|
|
620
|
-
* The
|
|
647
|
+
* The Id of the Cell whose values are used for sorting. If omitted, the view
|
|
648
|
+
* will sort the Row Id itself.
|
|
621
649
|
* @category Props
|
|
622
650
|
* @since v8.1.0
|
|
623
651
|
*/
|
|
624
652
|
readonly cellId?: Id;
|
|
625
653
|
/**
|
|
626
|
-
*
|
|
654
|
+
* Whether the sorting should be in descending order.
|
|
627
655
|
* @category Props
|
|
628
656
|
* @since v8.1.0
|
|
629
657
|
*/
|
|
630
658
|
readonly descending?: boolean;
|
|
631
659
|
/**
|
|
632
|
-
* The
|
|
660
|
+
* The number of Row Ids to skip for pagination purposes.
|
|
633
661
|
* @category Props
|
|
634
662
|
* @since v8.1.0
|
|
635
663
|
*/
|
|
636
664
|
readonly offset?: number;
|
|
637
665
|
/**
|
|
638
|
-
* The
|
|
666
|
+
* The maximum number of Row Ids to return.
|
|
639
667
|
* @category Props
|
|
640
668
|
* @since v8.1.0
|
|
641
669
|
*/
|
|
642
670
|
readonly limit?: number;
|
|
643
671
|
/**
|
|
644
|
-
* The
|
|
672
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
673
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
645
674
|
* @category Props
|
|
646
675
|
* @since v8.1.0
|
|
647
676
|
*/
|
|
648
677
|
readonly store?: StoreOrStoreId;
|
|
649
678
|
/**
|
|
650
|
-
*
|
|
679
|
+
* An optional list of Cell Ids to use for rendering a prescribed set of the
|
|
680
|
+
* sorted Table's Cells in a given order.
|
|
651
681
|
* @category Props
|
|
652
682
|
* @since v8.1.0
|
|
653
683
|
*/
|
|
654
684
|
readonly customCellIds?: Ids;
|
|
655
685
|
/**
|
|
656
|
-
*
|
|
686
|
+
* A component or string to separate each rendered Row.
|
|
657
687
|
* @category Props
|
|
658
688
|
* @since v8.1.0
|
|
659
689
|
*/
|
|
660
690
|
readonly separator?: Snippet<[]>;
|
|
661
691
|
/**
|
|
662
|
-
*
|
|
692
|
+
* Whether the component should also render the Id of the Table, and its
|
|
693
|
+
* descendent objects, to assist with debugging.
|
|
663
694
|
* @category Props
|
|
664
695
|
* @since v8.1.0
|
|
665
696
|
*/
|
|
666
697
|
readonly debugIds?: boolean;
|
|
667
698
|
/**
|
|
668
|
-
*
|
|
699
|
+
* A snippet for rendering each Row in the sorted Table, to override the
|
|
700
|
+
* default RowView component.
|
|
669
701
|
* @category Props
|
|
670
702
|
* @since v8.1.0
|
|
671
703
|
*/
|
|
@@ -673,31 +705,35 @@ export type SortedTableViewProps = {
|
|
|
673
705
|
};
|
|
674
706
|
|
|
675
707
|
/**
|
|
676
|
-
*
|
|
708
|
+
* TablesViewProps props are used for components that refer to all the Tables
|
|
709
|
+
* in a Store, such as the TablesView component.
|
|
677
710
|
* @category Props
|
|
678
711
|
* @since v8.1.0
|
|
679
712
|
*/
|
|
680
713
|
export type TablesViewProps = {
|
|
681
714
|
/**
|
|
682
|
-
* The
|
|
715
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
716
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
683
717
|
* @category Props
|
|
684
718
|
* @since v8.1.0
|
|
685
719
|
*/
|
|
686
720
|
readonly store?: StoreOrStoreId;
|
|
687
721
|
/**
|
|
688
|
-
*
|
|
722
|
+
* A component or string to separate each rendered Table.
|
|
689
723
|
* @category Props
|
|
690
724
|
* @since v8.1.0
|
|
691
725
|
*/
|
|
692
726
|
readonly separator?: Snippet<[]>;
|
|
693
727
|
/**
|
|
694
|
-
*
|
|
728
|
+
* Whether the component should also render the Ids of each Table, and its
|
|
729
|
+
* descendent objects, to assist with debugging.
|
|
695
730
|
* @category Props
|
|
696
731
|
* @since v8.1.0
|
|
697
732
|
*/
|
|
698
733
|
readonly debugIds?: boolean;
|
|
699
734
|
/**
|
|
700
|
-
*
|
|
735
|
+
* A snippet for rendering each Table in the Store, to override the default
|
|
736
|
+
* TableView component.
|
|
701
737
|
* @category Props
|
|
702
738
|
* @since v8.1.0
|
|
703
739
|
*/
|
|
@@ -705,31 +741,35 @@ export type TablesViewProps = {
|
|
|
705
741
|
};
|
|
706
742
|
|
|
707
743
|
/**
|
|
708
|
-
*
|
|
744
|
+
* ValuesViewProps props are used for components that refer to all the Values
|
|
745
|
+
* in a Store, such as the ValuesView component.
|
|
709
746
|
* @category Props
|
|
710
747
|
* @since v8.1.0
|
|
711
748
|
*/
|
|
712
749
|
export type ValuesViewProps = {
|
|
713
750
|
/**
|
|
714
|
-
* The
|
|
751
|
+
* The Store to be accessed: omit for the default context Store, provide an
|
|
752
|
+
* Id for a named context Store, or provide an explicit reference.
|
|
715
753
|
* @category Props
|
|
716
754
|
* @since v8.1.0
|
|
717
755
|
*/
|
|
718
756
|
readonly store?: StoreOrStoreId;
|
|
719
757
|
/**
|
|
720
|
-
*
|
|
758
|
+
* A component or string to separate each rendered Value.
|
|
721
759
|
* @category Props
|
|
722
760
|
* @since v8.1.0
|
|
723
761
|
*/
|
|
724
762
|
readonly separator?: Snippet<[]>;
|
|
725
763
|
/**
|
|
726
|
-
*
|
|
764
|
+
* Whether the component should also render the Ids of each Value to assist
|
|
765
|
+
* with debugging.
|
|
727
766
|
* @category Props
|
|
728
767
|
* @since v8.1.0
|
|
729
768
|
*/
|
|
730
769
|
readonly debugIds?: boolean;
|
|
731
770
|
/**
|
|
732
|
-
*
|
|
771
|
+
* A snippet for rendering each Value in the Store, to override the default
|
|
772
|
+
* ValueView component.
|
|
733
773
|
* @category Props
|
|
734
774
|
* @since v8.1.0
|
|
735
775
|
*/
|
|
@@ -737,37 +777,41 @@ export type ValuesViewProps = {
|
|
|
737
777
|
};
|
|
738
778
|
|
|
739
779
|
/**
|
|
740
|
-
*
|
|
780
|
+
* IndexViewProps props are used for components that refer to a single Index in
|
|
781
|
+
* an Indexes object, such as the IndexView component.
|
|
741
782
|
* @category Props
|
|
742
783
|
* @since v8.1.0
|
|
743
784
|
*/
|
|
744
785
|
export type IndexViewProps = {
|
|
745
786
|
/**
|
|
746
|
-
* The
|
|
787
|
+
* The Id of the Index in the Indexes object to be rendered.
|
|
747
788
|
* @category Props
|
|
748
789
|
* @since v8.1.0
|
|
749
790
|
*/
|
|
750
791
|
readonly indexId: Id;
|
|
751
792
|
/**
|
|
752
|
-
* The
|
|
793
|
+
* The Indexes object to be accessed: omit for the default context Indexes
|
|
794
|
+
* object, provide an Id for a named context Indexes object, or provide an
|
|
795
|
+
* explicit reference.
|
|
753
796
|
* @category Props
|
|
754
797
|
* @since v8.1.0
|
|
755
798
|
*/
|
|
756
799
|
readonly indexes?: IndexesOrIndexesId;
|
|
757
800
|
/**
|
|
758
|
-
*
|
|
801
|
+
* A component or string to separate each rendered Slice.
|
|
759
802
|
* @category Props
|
|
760
803
|
* @since v8.1.0
|
|
761
804
|
*/
|
|
762
805
|
readonly separator?: Snippet<[]>;
|
|
763
806
|
/**
|
|
764
|
-
*
|
|
807
|
+
* Whether the component should also render the Id of the Index, and its
|
|
808
|
+
* descendent objects, to assist with debugging.
|
|
765
809
|
* @category Props
|
|
766
810
|
* @since v8.1.0
|
|
767
811
|
*/
|
|
768
812
|
readonly debugIds?: boolean;
|
|
769
813
|
/**
|
|
770
|
-
*
|
|
814
|
+
* A snippet for rendering each Slice in the Index.
|
|
771
815
|
* @category Props
|
|
772
816
|
* @since v8.1.0
|
|
773
817
|
*/
|
|
@@ -775,43 +819,48 @@ export type IndexViewProps = {
|
|
|
775
819
|
};
|
|
776
820
|
|
|
777
821
|
/**
|
|
778
|
-
*
|
|
822
|
+
* SliceViewProps props are used for components that refer to a single Slice in
|
|
823
|
+
* an Index object, such as the SliceView component.
|
|
779
824
|
* @category Props
|
|
780
825
|
* @since v8.1.0
|
|
781
826
|
*/
|
|
782
827
|
export type SliceViewProps = {
|
|
783
828
|
/**
|
|
784
|
-
* The
|
|
829
|
+
* The Id of the Index in the Indexes object.
|
|
785
830
|
* @category Props
|
|
786
831
|
* @since v8.1.0
|
|
787
832
|
*/
|
|
788
833
|
readonly indexId: Id;
|
|
789
834
|
/**
|
|
790
|
-
* The
|
|
835
|
+
* The Id of the Slice in the Index to be rendered.
|
|
791
836
|
* @category Props
|
|
792
837
|
* @since v8.1.0
|
|
793
838
|
*/
|
|
794
839
|
readonly sliceId: Id;
|
|
795
840
|
/**
|
|
796
|
-
* The
|
|
841
|
+
* The Indexes object to be accessed: omit for the default context Indexes
|
|
842
|
+
* object, provide an Id for a named context Indexes object, or provide an
|
|
843
|
+
* explicit reference.
|
|
797
844
|
* @category Props
|
|
798
845
|
* @since v8.1.0
|
|
799
846
|
*/
|
|
800
847
|
readonly indexes?: IndexesOrIndexesId;
|
|
801
848
|
/**
|
|
802
|
-
*
|
|
849
|
+
* A component or string to separate each rendered Row.
|
|
803
850
|
* @category Props
|
|
804
851
|
* @since v8.1.0
|
|
805
852
|
*/
|
|
806
853
|
readonly separator?: Snippet<[]>;
|
|
807
854
|
/**
|
|
808
|
-
*
|
|
855
|
+
* Whether the component should also render the Id of the Slice, and its
|
|
856
|
+
* descendent objects, to assist with debugging.
|
|
809
857
|
* @category Props
|
|
810
858
|
* @since v8.1.0
|
|
811
859
|
*/
|
|
812
860
|
readonly debugIds?: boolean;
|
|
813
861
|
/**
|
|
814
|
-
*
|
|
862
|
+
* A snippet for rendering each Row in the Slice, to override the default
|
|
863
|
+
* RowView component.
|
|
815
864
|
* @category Props
|
|
816
865
|
* @since v8.1.0
|
|
817
866
|
*/
|
|
@@ -819,38 +868,43 @@ export type SliceViewProps = {
|
|
|
819
868
|
};
|
|
820
869
|
|
|
821
870
|
/**
|
|
822
|
-
*
|
|
823
|
-
*
|
|
871
|
+
* RemoteRowViewProps props are used for components that refer to a single
|
|
872
|
+
* Relationship in a Relationships object, and where you want to render a
|
|
873
|
+
* remote Row based on a local Row, such as in the RemoteRowView component.
|
|
824
874
|
* @category Props
|
|
825
875
|
* @since v8.1.0
|
|
826
876
|
*/
|
|
827
877
|
export type RemoteRowViewProps = {
|
|
828
878
|
/**
|
|
829
|
-
* The
|
|
879
|
+
* The Id of the Relationship in the Relationships object.
|
|
830
880
|
* @category Props
|
|
831
881
|
* @since v8.1.0
|
|
832
882
|
*/
|
|
833
883
|
readonly relationshipId: Id;
|
|
834
884
|
/**
|
|
835
|
-
* The
|
|
885
|
+
* The Id of the local Row for which to render the remote Row.
|
|
836
886
|
* @category Props
|
|
837
887
|
* @since v8.1.0
|
|
838
888
|
*/
|
|
839
889
|
readonly localRowId: Id;
|
|
840
890
|
/**
|
|
841
|
-
* The
|
|
891
|
+
* The Relationships object to be accessed: omit for the default context
|
|
892
|
+
* Relationships object, provide an Id for a named context Relationships
|
|
893
|
+
* object, or provide an explicit reference.
|
|
842
894
|
* @category Props
|
|
843
895
|
* @since v8.1.0
|
|
844
896
|
*/
|
|
845
897
|
readonly relationships?: RelationshipsOrRelationshipsId;
|
|
846
898
|
/**
|
|
847
|
-
*
|
|
899
|
+
* Whether the component should also render the Id of the Row in the
|
|
900
|
+
* Relationship, and its descendent objects, to assist with debugging.
|
|
848
901
|
* @category Props
|
|
849
902
|
* @since v8.1.0
|
|
850
903
|
*/
|
|
851
904
|
readonly debugIds?: boolean;
|
|
852
905
|
/**
|
|
853
|
-
*
|
|
906
|
+
* A snippet for rendering each (remote, local, or linked) Row in the
|
|
907
|
+
* Relationship.
|
|
854
908
|
* @category Props
|
|
855
909
|
* @since v8.1.0
|
|
856
910
|
*/
|
|
@@ -858,44 +912,49 @@ export type RemoteRowViewProps = {
|
|
|
858
912
|
};
|
|
859
913
|
|
|
860
914
|
/**
|
|
861
|
-
*
|
|
862
|
-
*
|
|
915
|
+
* LocalRowsViewProps props are used for components that refer to a single
|
|
916
|
+
* Relationship in a Relationships object, and where you want to render local
|
|
917
|
+
* Rows based on a remote Row, such as the LocalRowsView component.
|
|
863
918
|
* @category Props
|
|
864
919
|
* @since v8.1.0
|
|
865
920
|
*/
|
|
866
921
|
export type LocalRowsViewProps = {
|
|
867
922
|
/**
|
|
868
|
-
* The
|
|
923
|
+
* The Id of the Relationship in the Relationships object.
|
|
869
924
|
* @category Props
|
|
870
925
|
* @since v8.1.0
|
|
871
926
|
*/
|
|
872
927
|
readonly relationshipId: Id;
|
|
873
928
|
/**
|
|
874
|
-
* The
|
|
929
|
+
* The Id of the remote Row for which to render the local Rows.
|
|
875
930
|
* @category Props
|
|
876
931
|
* @since v8.1.0
|
|
877
932
|
*/
|
|
878
933
|
readonly remoteRowId: Id;
|
|
879
934
|
/**
|
|
880
|
-
* The
|
|
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.
|
|
881
938
|
* @category Props
|
|
882
939
|
* @since v8.1.0
|
|
883
940
|
*/
|
|
884
941
|
readonly relationships?: RelationshipsOrRelationshipsId;
|
|
885
942
|
/**
|
|
886
|
-
*
|
|
943
|
+
* A component or string to separate each rendered Row.
|
|
887
944
|
* @category Props
|
|
888
945
|
* @since v8.1.0
|
|
889
946
|
*/
|
|
890
947
|
readonly separator?: Snippet<[]>;
|
|
891
948
|
/**
|
|
892
|
-
*
|
|
949
|
+
* Whether the component should also render the Id of the Row in the
|
|
950
|
+
* Relationship, and its descendent objects, to assist with debugging.
|
|
893
951
|
* @category Props
|
|
894
952
|
* @since v8.1.0
|
|
895
953
|
*/
|
|
896
954
|
readonly debugIds?: boolean;
|
|
897
955
|
/**
|
|
898
|
-
*
|
|
956
|
+
* A snippet for rendering each (remote, local, or linked) Row in the
|
|
957
|
+
* Relationship.
|
|
899
958
|
* @category Props
|
|
900
959
|
* @since v8.1.0
|
|
901
960
|
*/
|
|
@@ -903,44 +962,50 @@ export type LocalRowsViewProps = {
|
|
|
903
962
|
};
|
|
904
963
|
|
|
905
964
|
/**
|
|
906
|
-
*
|
|
907
|
-
*
|
|
965
|
+
* LinkedRowsViewProps props are used for components that refer to a single
|
|
966
|
+
* Relationship in a Relationships object, and where you want to render a
|
|
967
|
+
* linked list of Rows starting from a first Row, such as the LinkedRowsView
|
|
968
|
+
* component.
|
|
908
969
|
* @category Props
|
|
909
970
|
* @since v8.1.0
|
|
910
971
|
*/
|
|
911
972
|
export type LinkedRowsViewProps = {
|
|
912
973
|
/**
|
|
913
|
-
* The
|
|
974
|
+
* The Id of the Relationship in the Relationships object.
|
|
914
975
|
* @category Props
|
|
915
976
|
* @since v8.1.0
|
|
916
977
|
*/
|
|
917
978
|
readonly relationshipId: Id;
|
|
918
979
|
/**
|
|
919
|
-
* The
|
|
980
|
+
* The Id of the first Row in the linked list Relationship.
|
|
920
981
|
* @category Props
|
|
921
982
|
* @since v8.1.0
|
|
922
983
|
*/
|
|
923
984
|
readonly firstRowId: Id;
|
|
924
985
|
/**
|
|
925
|
-
* The
|
|
986
|
+
* The Relationships object to be accessed: omit for the default context
|
|
987
|
+
* Relationships object, provide an Id for a named context Relationships
|
|
988
|
+
* object, or provide an explicit reference.
|
|
926
989
|
* @category Props
|
|
927
990
|
* @since v8.1.0
|
|
928
991
|
*/
|
|
929
992
|
readonly relationships?: RelationshipsOrRelationshipsId;
|
|
930
993
|
/**
|
|
931
|
-
*
|
|
994
|
+
* A component or string to separate each rendered Row.
|
|
932
995
|
* @category Props
|
|
933
996
|
* @since v8.1.0
|
|
934
997
|
*/
|
|
935
998
|
readonly separator?: Snippet<[]>;
|
|
936
999
|
/**
|
|
937
|
-
*
|
|
1000
|
+
* Whether the component should also render the Id of the Row in the
|
|
1001
|
+
* Relationship, and its descendent objects, to assist with debugging.
|
|
938
1002
|
* @category Props
|
|
939
1003
|
* @since v8.1.0
|
|
940
1004
|
*/
|
|
941
1005
|
readonly debugIds?: boolean;
|
|
942
1006
|
/**
|
|
943
|
-
*
|
|
1007
|
+
* A snippet for rendering each (remote, local, or linked) Row in the
|
|
1008
|
+
* Relationship.
|
|
944
1009
|
* @category Props
|
|
945
1010
|
* @since v8.1.0
|
|
946
1011
|
*/
|
|
@@ -948,38 +1013,42 @@ export type LinkedRowsViewProps = {
|
|
|
948
1013
|
};
|
|
949
1014
|
|
|
950
1015
|
/**
|
|
951
|
-
*
|
|
952
|
-
* ResultCellView component.
|
|
1016
|
+
* ResultCellViewProps props are used for components that refer to a single
|
|
1017
|
+
* Cell in a Row of a query ResultTable, such as the ResultCellView component.
|
|
953
1018
|
* @category Props
|
|
954
1019
|
* @since v8.1.0
|
|
955
1020
|
*/
|
|
956
1021
|
export type ResultCellViewProps = {
|
|
957
1022
|
/**
|
|
958
|
-
* The
|
|
1023
|
+
* The Id of the query in the Queries object for which the ResultTable will be
|
|
1024
|
+
* rendered.
|
|
959
1025
|
* @category Props
|
|
960
1026
|
* @since v8.1.0
|
|
961
1027
|
*/
|
|
962
1028
|
readonly queryId: Id;
|
|
963
1029
|
/**
|
|
964
|
-
* The
|
|
1030
|
+
* The Id of the Row in the ResultTable.
|
|
965
1031
|
* @category Props
|
|
966
1032
|
* @since v8.1.0
|
|
967
1033
|
*/
|
|
968
1034
|
readonly rowId: Id;
|
|
969
1035
|
/**
|
|
970
|
-
* The
|
|
1036
|
+
* The Id of the Cell in the Row to be rendered.
|
|
971
1037
|
* @category Props
|
|
972
1038
|
* @since v8.1.0
|
|
973
1039
|
*/
|
|
974
1040
|
readonly cellId: Id;
|
|
975
1041
|
/**
|
|
976
|
-
* The
|
|
1042
|
+
* The Queries object to be accessed: omit for the default context Queries
|
|
1043
|
+
* object, provide an Id for a named context Queries object, or provide an
|
|
1044
|
+
* explicit reference.
|
|
977
1045
|
* @category Props
|
|
978
1046
|
* @since v8.1.0
|
|
979
1047
|
*/
|
|
980
1048
|
readonly queries?: QueriesOrQueriesId;
|
|
981
1049
|
/**
|
|
982
|
-
*
|
|
1050
|
+
* Whether the component should also render the Id of the Cell to assist with
|
|
1051
|
+
* debugging.
|
|
983
1052
|
* @category Props
|
|
984
1053
|
* @since v8.1.0
|
|
985
1054
|
*/
|
|
@@ -987,44 +1056,49 @@ export type ResultCellViewProps = {
|
|
|
987
1056
|
};
|
|
988
1057
|
|
|
989
1058
|
/**
|
|
990
|
-
*
|
|
991
|
-
* ResultRowView component.
|
|
1059
|
+
* ResultRowViewProps props are used for components that refer to a single Row
|
|
1060
|
+
* in a query ResultTable, such as the ResultRowView component.
|
|
992
1061
|
* @category Props
|
|
993
1062
|
* @since v8.1.0
|
|
994
1063
|
*/
|
|
995
1064
|
export type ResultRowViewProps = {
|
|
996
1065
|
/**
|
|
997
|
-
* The
|
|
1066
|
+
* The Id of the query in the Queries object for which the ResultTable will be
|
|
1067
|
+
* rendered.
|
|
998
1068
|
* @category Props
|
|
999
1069
|
* @since v8.1.0
|
|
1000
1070
|
*/
|
|
1001
1071
|
readonly queryId: Id;
|
|
1002
1072
|
/**
|
|
1003
|
-
* The
|
|
1073
|
+
* The Id of the Row in the ResultTable to be rendered.
|
|
1004
1074
|
* @category Props
|
|
1005
1075
|
* @since v8.1.0
|
|
1006
1076
|
*/
|
|
1007
1077
|
readonly rowId: Id;
|
|
1008
1078
|
/**
|
|
1009
|
-
* The
|
|
1079
|
+
* The Queries object to be accessed: omit for the default context Queries
|
|
1080
|
+
* object, provide an Id for a named context Queries object, or provide an
|
|
1081
|
+
* explicit reference.
|
|
1010
1082
|
* @category Props
|
|
1011
1083
|
* @since v8.1.0
|
|
1012
1084
|
*/
|
|
1013
1085
|
readonly queries?: QueriesOrQueriesId;
|
|
1014
1086
|
/**
|
|
1015
|
-
*
|
|
1087
|
+
* A component or string to separate each rendered Cell.
|
|
1016
1088
|
* @category Props
|
|
1017
1089
|
* @since v8.1.0
|
|
1018
1090
|
*/
|
|
1019
1091
|
readonly separator?: Snippet<[]>;
|
|
1020
1092
|
/**
|
|
1021
|
-
*
|
|
1093
|
+
* Whether the component should also render the Id of the Row, and its
|
|
1094
|
+
* descendent objects, to assist with debugging.
|
|
1022
1095
|
* @category Props
|
|
1023
1096
|
* @since v8.1.0
|
|
1024
1097
|
*/
|
|
1025
1098
|
readonly debugIds?: boolean;
|
|
1026
1099
|
/**
|
|
1027
|
-
*
|
|
1100
|
+
* A snippet for rendering each Cell in the Row, to override the default
|
|
1101
|
+
* ResultCellView component.
|
|
1028
1102
|
* @category Props
|
|
1029
1103
|
* @since v8.1.0
|
|
1030
1104
|
*/
|
|
@@ -1032,38 +1106,43 @@ export type ResultRowViewProps = {
|
|
|
1032
1106
|
};
|
|
1033
1107
|
|
|
1034
1108
|
/**
|
|
1035
|
-
*
|
|
1036
|
-
* ResultTableView component.
|
|
1109
|
+
* ResultTableViewProps props are used for components that refer to a single
|
|
1110
|
+
* query ResultTable, such as the ResultTableView component.
|
|
1037
1111
|
* @category Props
|
|
1038
1112
|
* @since v8.1.0
|
|
1039
1113
|
*/
|
|
1040
1114
|
export type ResultTableViewProps = {
|
|
1041
1115
|
/**
|
|
1042
|
-
* The
|
|
1116
|
+
* The Id of the query in the Queries object for which the ResultTable will be
|
|
1117
|
+
* rendered.
|
|
1043
1118
|
* @category Props
|
|
1044
1119
|
* @since v8.1.0
|
|
1045
1120
|
*/
|
|
1046
1121
|
readonly queryId: Id;
|
|
1047
1122
|
/**
|
|
1048
|
-
* The
|
|
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.
|
|
1049
1126
|
* @category Props
|
|
1050
1127
|
* @since v8.1.0
|
|
1051
1128
|
*/
|
|
1052
1129
|
readonly queries?: QueriesOrQueriesId;
|
|
1053
1130
|
/**
|
|
1054
|
-
*
|
|
1131
|
+
* A component or string to separate each rendered Row.
|
|
1055
1132
|
* @category Props
|
|
1056
1133
|
* @since v8.1.0
|
|
1057
1134
|
*/
|
|
1058
1135
|
readonly separator?: Snippet<[]>;
|
|
1059
1136
|
/**
|
|
1060
|
-
*
|
|
1137
|
+
* Whether the component should also render the Id of the query, and its
|
|
1138
|
+
* descendent objects, to assist with debugging.
|
|
1061
1139
|
* @category Props
|
|
1062
1140
|
* @since v8.1.0
|
|
1063
1141
|
*/
|
|
1064
1142
|
readonly debugIds?: boolean;
|
|
1065
1143
|
/**
|
|
1066
|
-
*
|
|
1144
|
+
* A snippet for rendering each Row in the Table, to override the default
|
|
1145
|
+
* ResultRowView component.
|
|
1067
1146
|
* @category Props
|
|
1068
1147
|
* @since v8.1.0
|
|
1069
1148
|
*/
|
|
@@ -1071,62 +1150,69 @@ export type ResultTableViewProps = {
|
|
|
1071
1150
|
};
|
|
1072
1151
|
|
|
1073
1152
|
/**
|
|
1074
|
-
*
|
|
1075
|
-
* ResultSortedTableView
|
|
1153
|
+
* ResultSortedTableViewProps props are used for components that refer to a
|
|
1154
|
+
* single sorted query ResultTable, such as the ResultSortedTableView
|
|
1155
|
+
* component.
|
|
1076
1156
|
* @category Props
|
|
1077
1157
|
* @since v8.1.0
|
|
1078
1158
|
*/
|
|
1079
1159
|
export type ResultSortedTableViewProps = {
|
|
1080
1160
|
/**
|
|
1081
|
-
* The
|
|
1161
|
+
* The Id of the query in the Queries object for which the sorted ResultTable
|
|
1162
|
+
* will be rendered.
|
|
1082
1163
|
* @category Props
|
|
1083
1164
|
* @since v8.1.0
|
|
1084
1165
|
*/
|
|
1085
1166
|
readonly queryId: Id;
|
|
1086
1167
|
/**
|
|
1087
|
-
* The
|
|
1168
|
+
* The Id of the Cell whose values are used for sorting. If omitted, the view
|
|
1169
|
+
* will sort the Row Id itself.
|
|
1088
1170
|
* @category Props
|
|
1089
1171
|
* @since v8.1.0
|
|
1090
1172
|
*/
|
|
1091
1173
|
readonly cellId?: Id;
|
|
1092
1174
|
/**
|
|
1093
|
-
*
|
|
1175
|
+
* Whether the sorting should be in descending order.
|
|
1094
1176
|
* @category Props
|
|
1095
1177
|
* @since v8.1.0
|
|
1096
1178
|
*/
|
|
1097
1179
|
readonly descending?: boolean;
|
|
1098
1180
|
/**
|
|
1099
|
-
* The
|
|
1181
|
+
* The number of Row Ids to skip for pagination purposes.
|
|
1100
1182
|
* @category Props
|
|
1101
1183
|
* @since v8.1.0
|
|
1102
1184
|
*/
|
|
1103
1185
|
readonly offset?: number;
|
|
1104
1186
|
/**
|
|
1105
|
-
* The
|
|
1187
|
+
* The maximum number of Row Ids to return.
|
|
1106
1188
|
* @category Props
|
|
1107
1189
|
* @since v8.1.0
|
|
1108
1190
|
*/
|
|
1109
1191
|
readonly limit?: number;
|
|
1110
1192
|
/**
|
|
1111
|
-
* The
|
|
1193
|
+
* The Queries object to be accessed: omit for the default context Queries
|
|
1194
|
+
* object, provide an Id for a named context Queries object, or provide an
|
|
1195
|
+
* explicit reference.
|
|
1112
1196
|
* @category Props
|
|
1113
1197
|
* @since v8.1.0
|
|
1114
1198
|
*/
|
|
1115
1199
|
readonly queries?: QueriesOrQueriesId;
|
|
1116
1200
|
/**
|
|
1117
|
-
*
|
|
1201
|
+
* A component or string to separate each rendered Row.
|
|
1118
1202
|
* @category Props
|
|
1119
1203
|
* @since v8.1.0
|
|
1120
1204
|
*/
|
|
1121
1205
|
readonly separator?: Snippet<[]>;
|
|
1122
1206
|
/**
|
|
1123
|
-
*
|
|
1207
|
+
* Whether the component should also render the Id of the query, and its
|
|
1208
|
+
* descendent objects, to assist with debugging.
|
|
1124
1209
|
* @category Props
|
|
1125
1210
|
* @since v8.1.0
|
|
1126
1211
|
*/
|
|
1127
1212
|
readonly debugIds?: boolean;
|
|
1128
1213
|
/**
|
|
1129
|
-
*
|
|
1214
|
+
* A snippet for rendering each Row in the Table, to override the default
|
|
1215
|
+
* ResultRowView component.
|
|
1130
1216
|
* @category Props
|
|
1131
1217
|
* @since v8.1.0
|
|
1132
1218
|
*/
|
|
@@ -1134,32 +1220,36 @@ export type ResultSortedTableViewProps = {
|
|
|
1134
1220
|
};
|
|
1135
1221
|
|
|
1136
1222
|
/**
|
|
1137
|
-
*
|
|
1223
|
+
* BackwardCheckpointsViewProps props are used for components that refer to a
|
|
1224
|
+
* list of previous checkpoints in a Checkpoints object, such as the
|
|
1138
1225
|
* BackwardCheckpointsView component.
|
|
1139
1226
|
* @category Props
|
|
1140
1227
|
* @since v8.1.0
|
|
1141
1228
|
*/
|
|
1142
1229
|
export type BackwardCheckpointsViewProps = {
|
|
1143
1230
|
/**
|
|
1144
|
-
* The
|
|
1231
|
+
* The Checkpoints object to be accessed: omit for the default context
|
|
1232
|
+
* Checkpoints object, provide an Id for a named context Checkpoints object,
|
|
1233
|
+
* or provide an explicit reference.
|
|
1145
1234
|
* @category Props
|
|
1146
1235
|
* @since v8.1.0
|
|
1147
1236
|
*/
|
|
1148
1237
|
readonly checkpoints?: CheckpointsOrCheckpointsId;
|
|
1149
1238
|
/**
|
|
1150
|
-
*
|
|
1239
|
+
* A component or string to separate each rendered checkpoint.
|
|
1151
1240
|
* @category Props
|
|
1152
1241
|
* @since v8.1.0
|
|
1153
1242
|
*/
|
|
1154
1243
|
readonly separator?: Snippet<[]>;
|
|
1155
1244
|
/**
|
|
1156
|
-
*
|
|
1245
|
+
* Whether the component should also render the Ids of the checkpoints to
|
|
1246
|
+
* assist with debugging.
|
|
1157
1247
|
* @category Props
|
|
1158
1248
|
* @since v8.1.0
|
|
1159
1249
|
*/
|
|
1160
1250
|
readonly debugIds?: boolean;
|
|
1161
1251
|
/**
|
|
1162
|
-
*
|
|
1252
|
+
* A snippet for rendering each checkpoint in the Checkpoints object.
|
|
1163
1253
|
* @category Props
|
|
1164
1254
|
* @since v8.1.0
|
|
1165
1255
|
*/
|
|
@@ -1167,32 +1257,36 @@ export type BackwardCheckpointsViewProps = {
|
|
|
1167
1257
|
};
|
|
1168
1258
|
|
|
1169
1259
|
/**
|
|
1170
|
-
*
|
|
1260
|
+
* ForwardCheckpointsViewProps props are used for components that refer to a
|
|
1261
|
+
* list of future checkpoints in a Checkpoints object, such as the
|
|
1171
1262
|
* ForwardCheckpointsView component.
|
|
1172
1263
|
* @category Props
|
|
1173
1264
|
* @since v8.1.0
|
|
1174
1265
|
*/
|
|
1175
1266
|
export type ForwardCheckpointsViewProps = {
|
|
1176
1267
|
/**
|
|
1177
|
-
* The
|
|
1268
|
+
* The Checkpoints object to be accessed: omit for the default context
|
|
1269
|
+
* Checkpoints object, provide an Id for a named context Checkpoints object,
|
|
1270
|
+
* or provide an explicit reference.
|
|
1178
1271
|
* @category Props
|
|
1179
1272
|
* @since v8.1.0
|
|
1180
1273
|
*/
|
|
1181
1274
|
readonly checkpoints?: CheckpointsOrCheckpointsId;
|
|
1182
1275
|
/**
|
|
1183
|
-
*
|
|
1276
|
+
* A component or string to separate each rendered checkpoint.
|
|
1184
1277
|
* @category Props
|
|
1185
1278
|
* @since v8.1.0
|
|
1186
1279
|
*/
|
|
1187
1280
|
readonly separator?: Snippet<[]>;
|
|
1188
1281
|
/**
|
|
1189
|
-
*
|
|
1282
|
+
* Whether the component should also render the Ids of the checkpoints to
|
|
1283
|
+
* assist with debugging.
|
|
1190
1284
|
* @category Props
|
|
1191
1285
|
* @since v8.1.0
|
|
1192
1286
|
*/
|
|
1193
1287
|
readonly debugIds?: boolean;
|
|
1194
1288
|
/**
|
|
1195
|
-
*
|
|
1289
|
+
* A snippet for rendering each checkpoint in the Checkpoints object.
|
|
1196
1290
|
* @category Props
|
|
1197
1291
|
* @since v8.1.0
|
|
1198
1292
|
*/
|
|
@@ -1200,26 +1294,30 @@ export type ForwardCheckpointsViewProps = {
|
|
|
1200
1294
|
};
|
|
1201
1295
|
|
|
1202
1296
|
/**
|
|
1203
|
-
*
|
|
1297
|
+
* CurrentCheckpointViewProps props are used for components that refer to the
|
|
1298
|
+
* current checkpoint in a Checkpoints object, such as the
|
|
1204
1299
|
* CurrentCheckpointView component.
|
|
1205
1300
|
* @category Props
|
|
1206
1301
|
* @since v8.1.0
|
|
1207
1302
|
*/
|
|
1208
1303
|
export type CurrentCheckpointViewProps = {
|
|
1209
1304
|
/**
|
|
1210
|
-
* The
|
|
1305
|
+
* The Checkpoints object to be accessed: omit for the default context
|
|
1306
|
+
* Checkpoints object, provide an Id for a named context Checkpoints object,
|
|
1307
|
+
* or provide an explicit reference.
|
|
1211
1308
|
* @category Props
|
|
1212
1309
|
* @since v8.1.0
|
|
1213
1310
|
*/
|
|
1214
1311
|
readonly checkpoints?: CheckpointsOrCheckpointsId;
|
|
1215
1312
|
/**
|
|
1216
|
-
*
|
|
1313
|
+
* Whether the component should also render the Id of the current checkpoint
|
|
1314
|
+
* to assist with debugging.
|
|
1217
1315
|
* @category Props
|
|
1218
1316
|
* @since v8.1.0
|
|
1219
1317
|
*/
|
|
1220
1318
|
readonly debugIds?: boolean;
|
|
1221
1319
|
/**
|
|
1222
|
-
*
|
|
1320
|
+
* A snippet for rendering the current checkpoint in the Checkpoints object.
|
|
1223
1321
|
* @category Props
|
|
1224
1322
|
* @since v8.1.0
|
|
1225
1323
|
*/
|
|
@@ -1233,6 +1331,10 @@ export type CurrentCheckpointViewProps = {
|
|
|
1233
1331
|
* Store objects, Metrics, Indexes, Relationships, Queries, Checkpoints,
|
|
1234
1332
|
* Persisters, and Synchronizers can all be provided both as single defaults and
|
|
1235
1333
|
* as named instances in a `*ById` map.
|
|
1334
|
+
*
|
|
1335
|
+
* Provider components can be nested and their contexts are merged, so outer
|
|
1336
|
+
* defaults and named instances remain visible unless a nearer Provider
|
|
1337
|
+
* replaces them.
|
|
1236
1338
|
* @param props The props for this component.
|
|
1237
1339
|
* @example
|
|
1238
1340
|
* This example creates a Provider context with a default Store.
|
|
@@ -1315,8 +1417,8 @@ export const IndexView: Component<IndexViewProps>;
|
|
|
1315
1417
|
|
|
1316
1418
|
/**
|
|
1317
1419
|
* The LinkedRowsView component renders the Rows in a linked list Relationship,
|
|
1318
|
-
* and registers a listener so that any changes to that result will cause
|
|
1319
|
-
*
|
|
1420
|
+
* and registers a listener so that any changes to that result will cause a
|
|
1421
|
+
* re-render.
|
|
1320
1422
|
* @param props The props for this component.
|
|
1321
1423
|
* @returns A rendering of the linked Row Ids.
|
|
1322
1424
|
* @category Component
|
|
@@ -1403,8 +1505,8 @@ export const ResultTableView: Component<ResultTableViewProps>;
|
|
|
1403
1505
|
|
|
1404
1506
|
/**
|
|
1405
1507
|
* The RowView component renders the contents of a single Row in a given Table,
|
|
1406
|
-
* and registers a listener so that any changes to that result will cause
|
|
1407
|
-
*
|
|
1508
|
+
* and registers a listener so that any changes to that result will cause a
|
|
1509
|
+
* re-render.
|
|
1408
1510
|
* @param props The props for this component.
|
|
1409
1511
|
* @returns A rendering of the Row, or nothing if not present.
|
|
1410
1512
|
* @category Component
|
|
@@ -1414,8 +1516,8 @@ export const RowView: Component<RowViewProps>;
|
|
|
1414
1516
|
|
|
1415
1517
|
/**
|
|
1416
1518
|
* The SliceView component renders the Row Ids in a named Slice in an Index, and
|
|
1417
|
-
* registers a listener so that any changes to that result will cause
|
|
1418
|
-
*
|
|
1519
|
+
* registers a listener so that any changes to that result will cause a
|
|
1520
|
+
* re-render.
|
|
1419
1521
|
* @param props The props for this component.
|
|
1420
1522
|
* @returns A rendering of the Rows in the Slice.
|
|
1421
1523
|
* @category Component
|
|
@@ -1446,8 +1548,8 @@ export const TableView: Component<TableViewProps>;
|
|
|
1446
1548
|
|
|
1447
1549
|
/**
|
|
1448
1550
|
* The TablesView component renders the contents of all Tables in a Store, and
|
|
1449
|
-
* registers a listener so that any changes to that result will cause
|
|
1450
|
-
*
|
|
1551
|
+
* registers a listener so that any changes to that result will cause a
|
|
1552
|
+
* re-render.
|
|
1451
1553
|
* @param props The props for this component.
|
|
1452
1554
|
* @returns A rendering of all Tables.
|
|
1453
1555
|
* @category Component
|
|
@@ -1457,8 +1559,8 @@ export const TablesView: Component<TablesViewProps>;
|
|
|
1457
1559
|
|
|
1458
1560
|
/**
|
|
1459
1561
|
* The ValueView component renders the value of a single Value in a Store, and
|
|
1460
|
-
* registers a listener so that any changes to that result will cause
|
|
1461
|
-
*
|
|
1562
|
+
* registers a listener so that any changes to that result will cause a
|
|
1563
|
+
* re-render.
|
|
1462
1564
|
* @param props The props for this component.
|
|
1463
1565
|
* @returns A rendering of the Value, or nothing if not present.
|
|
1464
1566
|
* @category Component
|
|
@@ -1477,99 +1579,99 @@ export const ValueView: Component<ValueViewProps>;
|
|
|
1477
1579
|
export const ValuesView: Component<ValuesViewProps>;
|
|
1478
1580
|
|
|
1479
1581
|
/**
|
|
1480
|
-
* The
|
|
1582
|
+
* The hasTables function returns a reactive object indicating whether any
|
|
1481
1583
|
* Tables exist in the Store, and registers a listener so that any changes to
|
|
1482
|
-
* that result will update
|
|
1584
|
+
* that result will update `current`.
|
|
1483
1585
|
* @param storeOrStoreId The Store to use, or its Id in a Provider context.
|
|
1484
1586
|
* @returns A reactive object with a `current` boolean property.
|
|
1485
1587
|
* @category Getter
|
|
1486
1588
|
* @since v8.1.0
|
|
1487
1589
|
*/
|
|
1488
|
-
export function
|
|
1590
|
+
export function hasTables(
|
|
1489
1591
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1490
1592
|
): {
|
|
1491
1593
|
readonly current: boolean;
|
|
1492
1594
|
};
|
|
1493
1595
|
|
|
1494
1596
|
/**
|
|
1495
|
-
* The
|
|
1496
|
-
*
|
|
1497
|
-
* update
|
|
1597
|
+
* The getTables function returns a reactive object reflecting the Tables in the
|
|
1598
|
+
* Store, and registers a listener so that any changes to those Tables will
|
|
1599
|
+
* update `current`.
|
|
1498
1600
|
* @param storeOrStoreId The Store to use, or its Id in a Provider context.
|
|
1499
1601
|
* @returns A reactive object with a `current` Tables property.
|
|
1500
1602
|
* @category Getter
|
|
1501
1603
|
* @since v8.1.0
|
|
1502
1604
|
*/
|
|
1503
|
-
export function
|
|
1605
|
+
export function getTables(
|
|
1504
1606
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1505
1607
|
): {
|
|
1506
1608
|
readonly current: Tables;
|
|
1507
1609
|
};
|
|
1508
1610
|
|
|
1509
1611
|
/**
|
|
1510
|
-
* The
|
|
1511
|
-
*
|
|
1512
|
-
*
|
|
1612
|
+
* The getTableIds function returns a reactive object reflecting the Ids of the
|
|
1613
|
+
* Tables in a Store, and registers a listener so that any changes to those Ids
|
|
1614
|
+
* will update `current`.
|
|
1513
1615
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1514
1616
|
* @returns A reactive object with a `current` Ids property.
|
|
1515
1617
|
* @category Getter
|
|
1516
1618
|
* @since v8.1.0
|
|
1517
1619
|
*/
|
|
1518
|
-
export function
|
|
1620
|
+
export function getTableIds(
|
|
1519
1621
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1520
1622
|
): {
|
|
1521
1623
|
readonly current: Ids;
|
|
1522
1624
|
};
|
|
1523
1625
|
|
|
1524
1626
|
/**
|
|
1525
|
-
* The
|
|
1526
|
-
*
|
|
1527
|
-
*
|
|
1627
|
+
* The hasTable function returns a reactive object indicating whether a Table
|
|
1628
|
+
* exists in the Store, and registers a listener so that any changes to that
|
|
1629
|
+
* result will update `current`.
|
|
1528
1630
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1529
1631
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1530
1632
|
* @returns A reactive object with a `current` boolean property.
|
|
1531
1633
|
* @category Getter
|
|
1532
1634
|
* @since v8.1.0
|
|
1533
1635
|
*/
|
|
1534
|
-
export function
|
|
1636
|
+
export function hasTable(
|
|
1535
1637
|
tableId: MaybeGetter<Id>,
|
|
1536
1638
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1537
1639
|
): {readonly current: boolean};
|
|
1538
1640
|
|
|
1539
1641
|
/**
|
|
1540
|
-
* The
|
|
1541
|
-
* Store, and registers a listener so that any changes to that Table will
|
|
1542
|
-
*
|
|
1642
|
+
* The getTable function returns a reactive object reflecting a Table in a
|
|
1643
|
+
* Store, and registers a listener so that any changes to that Table will update
|
|
1644
|
+
* `current`.
|
|
1543
1645
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1544
1646
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1545
1647
|
* @returns A reactive object with a `current` Table property.
|
|
1546
1648
|
* @category Getter
|
|
1547
1649
|
* @since v8.1.0
|
|
1548
1650
|
*/
|
|
1549
|
-
export function
|
|
1651
|
+
export function getTable(
|
|
1550
1652
|
tableId: MaybeGetter<Id>,
|
|
1551
1653
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1552
1654
|
): {readonly current: Table};
|
|
1553
1655
|
|
|
1554
1656
|
/**
|
|
1555
|
-
* The
|
|
1556
|
-
*
|
|
1557
|
-
*
|
|
1657
|
+
* The getTableCellIds function returns a reactive object reflecting the Ids of
|
|
1658
|
+
* all Cells used across a Table, and registers a listener so that any changes
|
|
1659
|
+
* to those Ids will update `current`.
|
|
1558
1660
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1559
1661
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1560
1662
|
* @returns A reactive object with a `current` Ids property.
|
|
1561
1663
|
* @category Getter
|
|
1562
1664
|
* @since v8.1.0
|
|
1563
1665
|
*/
|
|
1564
|
-
export function
|
|
1666
|
+
export function getTableCellIds(
|
|
1565
1667
|
tableId: MaybeGetter<Id>,
|
|
1566
1668
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1567
1669
|
): {readonly current: Ids};
|
|
1568
1670
|
|
|
1569
1671
|
/**
|
|
1570
|
-
* The
|
|
1571
|
-
*
|
|
1572
|
-
*
|
|
1672
|
+
* The hasTableCell function returns a reactive object indicating whether a
|
|
1673
|
+
* particular Cell is used anywhere in a Table, and registers a listener so that
|
|
1674
|
+
* any changes to that result will update `current`.
|
|
1573
1675
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1574
1676
|
* @param cellId The Id of the Cell (or a getter returning it).
|
|
1575
1677
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
@@ -1577,46 +1679,46 @@ export function createTableCellIds(
|
|
|
1577
1679
|
* @category Getter
|
|
1578
1680
|
* @since v8.1.0
|
|
1579
1681
|
*/
|
|
1580
|
-
export function
|
|
1682
|
+
export function hasTableCell(
|
|
1581
1683
|
tableId: MaybeGetter<Id>,
|
|
1582
1684
|
cellId: MaybeGetter<Id>,
|
|
1583
1685
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1584
1686
|
): {readonly current: boolean};
|
|
1585
1687
|
|
|
1586
1688
|
/**
|
|
1587
|
-
* The
|
|
1588
|
-
*
|
|
1589
|
-
*
|
|
1689
|
+
* The getRowCount function returns a reactive object reflecting the number of
|
|
1690
|
+
* Rows in a Table, and registers a listener so that any changes will update
|
|
1691
|
+
* `current`.
|
|
1590
1692
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1591
1693
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1592
1694
|
* @returns A reactive object with a `current` number property.
|
|
1593
1695
|
* @category Getter
|
|
1594
1696
|
* @since v8.1.0
|
|
1595
1697
|
*/
|
|
1596
|
-
export function
|
|
1698
|
+
export function getRowCount(
|
|
1597
1699
|
tableId: MaybeGetter<Id>,
|
|
1598
1700
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1599
1701
|
): {readonly current: number};
|
|
1600
1702
|
|
|
1601
1703
|
/**
|
|
1602
|
-
* The
|
|
1603
|
-
* Rows in a Table, and registers a listener so that any changes will
|
|
1604
|
-
*
|
|
1704
|
+
* The getRowIds function returns a reactive object reflecting the Ids of the
|
|
1705
|
+
* Rows in a Table, and registers a listener so that any changes will update
|
|
1706
|
+
* `current`.
|
|
1605
1707
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1606
1708
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1607
1709
|
* @returns A reactive object with a `current` Ids property.
|
|
1608
1710
|
* @category Getter
|
|
1609
1711
|
* @since v8.1.0
|
|
1610
1712
|
*/
|
|
1611
|
-
export function
|
|
1713
|
+
export function getRowIds(
|
|
1612
1714
|
tableId: MaybeGetter<Id>,
|
|
1613
1715
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1614
1716
|
): {readonly current: Ids};
|
|
1615
1717
|
|
|
1616
1718
|
/**
|
|
1617
|
-
* The
|
|
1618
|
-
*
|
|
1619
|
-
*
|
|
1719
|
+
* The getSortedRowIds function returns a reactive object reflecting the sorted
|
|
1720
|
+
* Row Ids in a Table, and registers a listener so that any changes will update
|
|
1721
|
+
* `current`.
|
|
1620
1722
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1621
1723
|
* @param cellId The Id of the Cell to sort by (or a getter returning it).
|
|
1622
1724
|
* @param descending Whether to sort descending (or a getter returning it).
|
|
@@ -1627,7 +1729,7 @@ export function createRowIds(
|
|
|
1627
1729
|
* @category Getter
|
|
1628
1730
|
* @since v8.1.0
|
|
1629
1731
|
*/
|
|
1630
|
-
export function
|
|
1732
|
+
export function getSortedRowIds(
|
|
1631
1733
|
tableId: MaybeGetter<Id>,
|
|
1632
1734
|
cellId?: MaybeGetter<Id | undefined>,
|
|
1633
1735
|
descending?: MaybeGetter<boolean>,
|
|
@@ -1637,9 +1739,9 @@ export function createSortedRowIds(
|
|
|
1637
1739
|
): {readonly current: Ids};
|
|
1638
1740
|
|
|
1639
1741
|
/**
|
|
1640
|
-
* The
|
|
1641
|
-
*
|
|
1642
|
-
*
|
|
1742
|
+
* The hasRow function returns a reactive object indicating whether a Row exists
|
|
1743
|
+
* in a Table, and registers a listener so that any changes to that result will
|
|
1744
|
+
* update `current`.
|
|
1643
1745
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1644
1746
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
1645
1747
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
@@ -1647,16 +1749,16 @@ export function createSortedRowIds(
|
|
|
1647
1749
|
* @category Getter
|
|
1648
1750
|
* @since v8.1.0
|
|
1649
1751
|
*/
|
|
1650
|
-
export function
|
|
1752
|
+
export function hasRow(
|
|
1651
1753
|
tableId: MaybeGetter<Id>,
|
|
1652
1754
|
rowId: MaybeGetter<Id>,
|
|
1653
1755
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1654
1756
|
): {readonly current: boolean};
|
|
1655
1757
|
|
|
1656
1758
|
/**
|
|
1657
|
-
* The
|
|
1658
|
-
* and registers a listener so that any changes to that Row will
|
|
1659
|
-
*
|
|
1759
|
+
* The getRow function returns a reactive object reflecting a Row in a Table,
|
|
1760
|
+
* and registers a listener so that any changes to that Row will update
|
|
1761
|
+
* `current`.
|
|
1660
1762
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1661
1763
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
1662
1764
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
@@ -1664,16 +1766,16 @@ export function createHasRow(
|
|
|
1664
1766
|
* @category Getter
|
|
1665
1767
|
* @since v8.1.0
|
|
1666
1768
|
*/
|
|
1667
|
-
export function
|
|
1769
|
+
export function getRow(
|
|
1668
1770
|
tableId: MaybeGetter<Id>,
|
|
1669
1771
|
rowId: MaybeGetter<Id>,
|
|
1670
1772
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1671
1773
|
): {readonly current: Row};
|
|
1672
1774
|
|
|
1673
1775
|
/**
|
|
1674
|
-
* The
|
|
1675
|
-
*
|
|
1676
|
-
*
|
|
1776
|
+
* The getCellIds function returns a reactive object reflecting the Ids of the
|
|
1777
|
+
* Cells in a Row, and registers a listener so that any changes will update
|
|
1778
|
+
* `current`.
|
|
1677
1779
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1678
1780
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
1679
1781
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
@@ -1681,16 +1783,16 @@ export function createRow(
|
|
|
1681
1783
|
* @category Getter
|
|
1682
1784
|
* @since v8.1.0
|
|
1683
1785
|
*/
|
|
1684
|
-
export function
|
|
1786
|
+
export function getCellIds(
|
|
1685
1787
|
tableId: MaybeGetter<Id>,
|
|
1686
1788
|
rowId: MaybeGetter<Id>,
|
|
1687
1789
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1688
1790
|
): {readonly current: Ids};
|
|
1689
1791
|
|
|
1690
1792
|
/**
|
|
1691
|
-
* The
|
|
1692
|
-
*
|
|
1693
|
-
*
|
|
1793
|
+
* The hasCell function returns a reactive object indicating whether a Cell
|
|
1794
|
+
* exists in a Row in a Table, and registers a listener so that any changes to
|
|
1795
|
+
* that result will update `current`.
|
|
1694
1796
|
* @param tableId The Id of the Table (or a getter returning it).
|
|
1695
1797
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
1696
1798
|
* @param cellId The Id of the Cell (or a getter returning it).
|
|
@@ -1699,7 +1801,7 @@ export function createCellIds(
|
|
|
1699
1801
|
* @category Getter
|
|
1700
1802
|
* @since v8.1.0
|
|
1701
1803
|
*/
|
|
1702
|
-
export function
|
|
1804
|
+
export function hasCell(
|
|
1703
1805
|
tableId: MaybeGetter<Id>,
|
|
1704
1806
|
rowId: MaybeGetter<Id>,
|
|
1705
1807
|
cellId: MaybeGetter<Id>,
|
|
@@ -1707,9 +1809,9 @@ export function createHasCell(
|
|
|
1707
1809
|
): {readonly current: boolean};
|
|
1708
1810
|
|
|
1709
1811
|
/**
|
|
1710
|
-
* The
|
|
1711
|
-
*
|
|
1712
|
-
*
|
|
1812
|
+
* The getCell function returns a reactive object reflecting the value of a Cell
|
|
1813
|
+
* in a Row in a Table, and registers a listener so that any changes to that
|
|
1814
|
+
* Cell will update `current`.
|
|
1713
1815
|
*
|
|
1714
1816
|
* Since Cells are mutable leaf values in a Store, the returned object's
|
|
1715
1817
|
* `current` property can also be assigned to write back to the Store.
|
|
@@ -1719,18 +1821,18 @@ export function createHasCell(
|
|
|
1719
1821
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1720
1822
|
* @returns A reactive object with gettable and settable `current`.
|
|
1721
1823
|
* @example
|
|
1722
|
-
* This example uses the
|
|
1824
|
+
* This example uses the getCell function to display a Cell value reactively.
|
|
1723
1825
|
*
|
|
1724
1826
|
* ```ts
|
|
1725
1827
|
* // In a .svelte file:
|
|
1726
1828
|
* // const store = createStore().setCell('pets', 'cat', 'name', 'Fido');
|
|
1727
|
-
* // const name =
|
|
1829
|
+
* // const name = getCell('pets', 'cat', 'name', store);
|
|
1728
1830
|
* // $: console.log(name.current); // 'Fido'
|
|
1729
1831
|
* ```
|
|
1730
1832
|
* @category Getter
|
|
1731
1833
|
* @since v8.1.0
|
|
1732
1834
|
*/
|
|
1733
|
-
export function
|
|
1835
|
+
export function getCell(
|
|
1734
1836
|
tableId: MaybeGetter<Id>,
|
|
1735
1837
|
rowId: MaybeGetter<Id>,
|
|
1736
1838
|
cellId: MaybeGetter<Id>,
|
|
@@ -1738,69 +1840,68 @@ export function createCell(
|
|
|
1738
1840
|
): {get current(): CellOrUndefined; set current(v: Cell)};
|
|
1739
1841
|
|
|
1740
1842
|
/**
|
|
1741
|
-
* The
|
|
1843
|
+
* The hasValues function returns a reactive object indicating whether any
|
|
1742
1844
|
* Values exist in the Store, and registers a listener so that any changes to
|
|
1743
|
-
* that result will update
|
|
1845
|
+
* that result will update `current`.
|
|
1744
1846
|
* @param storeOrStoreId The Store to use, or its Id in a Provider context.
|
|
1745
1847
|
* @returns A reactive object with a `current` boolean property.
|
|
1746
1848
|
* @category Getter
|
|
1747
1849
|
* @since v8.1.0
|
|
1748
1850
|
*/
|
|
1749
|
-
export function
|
|
1851
|
+
export function hasValues(
|
|
1750
1852
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1751
1853
|
): {
|
|
1752
1854
|
readonly current: boolean;
|
|
1753
1855
|
};
|
|
1754
1856
|
|
|
1755
1857
|
/**
|
|
1756
|
-
* The
|
|
1757
|
-
*
|
|
1758
|
-
* update `.current`.
|
|
1858
|
+
* The getValues function returns a reactive object reflecting the Values in the
|
|
1859
|
+
* Store, and registers a listener so that any changes will update `current`.
|
|
1759
1860
|
* @param storeOrStoreId The Store to use, or its Id in a Provider context.
|
|
1760
1861
|
* @returns A reactive object with a `current` Values property.
|
|
1761
1862
|
* @category Getter
|
|
1762
1863
|
* @since v8.1.0
|
|
1763
1864
|
*/
|
|
1764
|
-
export function
|
|
1865
|
+
export function getValues(
|
|
1765
1866
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1766
1867
|
): {
|
|
1767
1868
|
readonly current: Values;
|
|
1768
1869
|
};
|
|
1769
1870
|
|
|
1770
1871
|
/**
|
|
1771
|
-
* The
|
|
1772
|
-
*
|
|
1773
|
-
*
|
|
1872
|
+
* The getValueIds function returns a reactive object reflecting the Ids of the
|
|
1873
|
+
* Values in a Store, and registers a listener so that any changes will update
|
|
1874
|
+
* `current`.
|
|
1774
1875
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1775
1876
|
* @returns A reactive object with a `current` Ids property.
|
|
1776
1877
|
* @category Getter
|
|
1777
1878
|
* @since v8.1.0
|
|
1778
1879
|
*/
|
|
1779
|
-
export function
|
|
1880
|
+
export function getValueIds(
|
|
1780
1881
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1781
1882
|
): {
|
|
1782
1883
|
readonly current: Ids;
|
|
1783
1884
|
};
|
|
1784
1885
|
|
|
1785
1886
|
/**
|
|
1786
|
-
* The
|
|
1787
|
-
*
|
|
1788
|
-
*
|
|
1887
|
+
* The hasValue function returns a reactive object indicating whether a Value
|
|
1888
|
+
* exists in the Store, and registers a listener so that any changes to that
|
|
1889
|
+
* result will update `current`.
|
|
1789
1890
|
* @param valueId The Id of the Value (or a getter returning it).
|
|
1790
1891
|
* @param storeOrStoreId The Store to use (plain value or getter), or its Id.
|
|
1791
1892
|
* @returns A reactive object with a `current` boolean property.
|
|
1792
1893
|
* @category Getter
|
|
1793
1894
|
* @since v8.1.0
|
|
1794
1895
|
*/
|
|
1795
|
-
export function
|
|
1896
|
+
export function hasValue(
|
|
1796
1897
|
valueId: MaybeGetter<Id>,
|
|
1797
1898
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1798
1899
|
): {readonly current: boolean};
|
|
1799
1900
|
|
|
1800
1901
|
/**
|
|
1801
|
-
* The
|
|
1902
|
+
* The getValue function returns a reactive object reflecting the value of a
|
|
1802
1903
|
* Value in a Store, and registers a listener so that any changes to that Value
|
|
1803
|
-
* will update
|
|
1904
|
+
* will update `current`.
|
|
1804
1905
|
*
|
|
1805
1906
|
* Since Values are mutable leaf values in a Store, the returned object's
|
|
1806
1907
|
* `current` property can also be assigned to write back to the Store.
|
|
@@ -1810,7 +1911,7 @@ export function createHasValue(
|
|
|
1810
1911
|
* @category Getter
|
|
1811
1912
|
* @since v8.1.0
|
|
1812
1913
|
*/
|
|
1813
|
-
export function
|
|
1914
|
+
export function getValue(
|
|
1814
1915
|
valueId: MaybeGetter<Id>,
|
|
1815
1916
|
storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
|
|
1816
1917
|
): {get current(): ValueOrUndefined; set current(v: Value)};
|
|
@@ -1838,13 +1939,13 @@ export function resolveStore(
|
|
|
1838
1939
|
): () => Store | undefined;
|
|
1839
1940
|
|
|
1840
1941
|
/**
|
|
1841
|
-
* The
|
|
1842
|
-
*
|
|
1942
|
+
* The getStoreIds function returns a reactive object with the Ids of all Stores
|
|
1943
|
+
* registered in the current Provider context.
|
|
1843
1944
|
* @returns A reactive object with a `current` Ids property.
|
|
1844
1945
|
* @category Getter
|
|
1845
1946
|
* @since v8.1.0
|
|
1846
1947
|
*/
|
|
1847
|
-
export function
|
|
1948
|
+
export function getStoreIds(): {readonly current: Ids};
|
|
1848
1949
|
|
|
1849
1950
|
/**
|
|
1850
1951
|
* The getMetrics function returns the default Metrics object from the current
|
|
@@ -1870,33 +1971,33 @@ export function resolveMetrics(
|
|
|
1870
1971
|
): () => Metrics | undefined;
|
|
1871
1972
|
|
|
1872
1973
|
/**
|
|
1873
|
-
* The
|
|
1974
|
+
* The getMetricsIds function returns a reactive object with the Ids of all
|
|
1874
1975
|
* Metrics objects registered in the current Provider context.
|
|
1875
1976
|
* @returns A reactive object with a `current` Ids property.
|
|
1876
1977
|
* @category Getter
|
|
1877
1978
|
* @since v8.1.0
|
|
1878
1979
|
*/
|
|
1879
|
-
export function
|
|
1980
|
+
export function getMetricsIds(): {readonly current: Ids};
|
|
1880
1981
|
|
|
1881
1982
|
/**
|
|
1882
|
-
* The
|
|
1883
|
-
*
|
|
1884
|
-
* will update
|
|
1983
|
+
* The getMetricIds function returns a reactive object reflecting the Ids of the
|
|
1984
|
+
* Metrics in a Metrics object, and registers a listener so that any changes
|
|
1985
|
+
* will update `current`.
|
|
1885
1986
|
* @param metricsOrMetricsId The Metrics object to use, or its Id.
|
|
1886
1987
|
* @returns A reactive object with a `current` Ids property.
|
|
1887
1988
|
* @category Getter
|
|
1888
1989
|
* @since v8.1.0
|
|
1889
1990
|
*/
|
|
1890
|
-
export function
|
|
1991
|
+
export function getMetricIds(
|
|
1891
1992
|
metricsOrMetricsId?: MaybeGetter<MetricsOrMetricsId | undefined>,
|
|
1892
1993
|
): {
|
|
1893
1994
|
readonly current: Ids;
|
|
1894
1995
|
};
|
|
1895
1996
|
|
|
1896
1997
|
/**
|
|
1897
|
-
* The
|
|
1998
|
+
* The getMetric function returns a reactive object reflecting the value of a
|
|
1898
1999
|
* named Metric in a Metrics object, and registers a listener so that any
|
|
1899
|
-
* changes to that Metric will update
|
|
2000
|
+
* changes to that Metric will update `current`.
|
|
1900
2001
|
* @param metricId The Id of the Metric (or a getter returning it).
|
|
1901
2002
|
* @param metricsOrMetricsId The Metrics object to use (plain or getter), or its
|
|
1902
2003
|
* Id.
|
|
@@ -1904,7 +2005,7 @@ export function createMetricIds(
|
|
|
1904
2005
|
* @category Getter
|
|
1905
2006
|
* @since v8.1.0
|
|
1906
2007
|
*/
|
|
1907
|
-
export function
|
|
2008
|
+
export function getMetric(
|
|
1908
2009
|
metricId: MaybeGetter<Id>,
|
|
1909
2010
|
metricsOrMetricsId?: MaybeGetter<MetricsOrMetricsId | undefined>,
|
|
1910
2011
|
): {readonly current: number | undefined};
|
|
@@ -1947,33 +2048,33 @@ export function getIndexStoreTableId(
|
|
|
1947
2048
|
): {readonly store: Store | undefined; readonly tableId: Id | undefined};
|
|
1948
2049
|
|
|
1949
2050
|
/**
|
|
1950
|
-
* The
|
|
2051
|
+
* The getIndexesIds function returns a reactive object with the Ids of all
|
|
1951
2052
|
* Indexes objects registered in the current Provider context.
|
|
1952
2053
|
* @returns A reactive object with a `current` Ids property.
|
|
1953
2054
|
* @category Getter
|
|
1954
2055
|
* @since v8.1.0
|
|
1955
2056
|
*/
|
|
1956
|
-
export function
|
|
2057
|
+
export function getIndexesIds(): {readonly current: Ids};
|
|
1957
2058
|
|
|
1958
2059
|
/**
|
|
1959
|
-
* The
|
|
1960
|
-
*
|
|
1961
|
-
*
|
|
2060
|
+
* The getIndexIds function returns a reactive object reflecting the Ids of the
|
|
2061
|
+
* Indexes in an Indexes object, and registers a listener so that any changes
|
|
2062
|
+
* will update `current`.
|
|
1962
2063
|
* @param indexesOrIndexesId The Indexes object to use, or its Id.
|
|
1963
2064
|
* @returns A reactive object with a `current` Ids property.
|
|
1964
2065
|
* @category Getter
|
|
1965
2066
|
* @since v8.1.0
|
|
1966
2067
|
*/
|
|
1967
|
-
export function
|
|
2068
|
+
export function getIndexIds(
|
|
1968
2069
|
indexesOrIndexesId?: MaybeGetter<IndexesOrIndexesId | undefined>,
|
|
1969
2070
|
): {
|
|
1970
2071
|
readonly current: Ids;
|
|
1971
2072
|
};
|
|
1972
2073
|
|
|
1973
2074
|
/**
|
|
1974
|
-
* The
|
|
1975
|
-
*
|
|
1976
|
-
*
|
|
2075
|
+
* The getSliceIds function returns a reactive object reflecting the Ids of the
|
|
2076
|
+
* Slices in an Index, and registers a listener so that any changes will update
|
|
2077
|
+
* `current`.
|
|
1977
2078
|
* @param indexId The Id of the Index (or a getter returning it).
|
|
1978
2079
|
* @param indexesOrIndexesId The Indexes object to use (plain or getter), or its
|
|
1979
2080
|
* Id.
|
|
@@ -1981,15 +2082,15 @@ export function createIndexIds(
|
|
|
1981
2082
|
* @category Getter
|
|
1982
2083
|
* @since v8.1.0
|
|
1983
2084
|
*/
|
|
1984
|
-
export function
|
|
2085
|
+
export function getSliceIds(
|
|
1985
2086
|
indexId: MaybeGetter<Id>,
|
|
1986
2087
|
indexesOrIndexesId?: MaybeGetter<IndexesOrIndexesId | undefined>,
|
|
1987
2088
|
): {readonly current: Ids};
|
|
1988
2089
|
|
|
1989
2090
|
/**
|
|
1990
|
-
* The
|
|
1991
|
-
*
|
|
1992
|
-
*
|
|
2091
|
+
* The getSliceRowIds function returns a reactive object reflecting the Ids of
|
|
2092
|
+
* the Rows in a Slice, and registers a listener so that any changes will update
|
|
2093
|
+
* `current`.
|
|
1993
2094
|
* @param indexId The Id of the Index (or a getter returning it).
|
|
1994
2095
|
* @param sliceId The Id of the Slice (or a getter returning it).
|
|
1995
2096
|
* @param indexesOrIndexesId The Indexes object to use (plain or getter), or its
|
|
@@ -1998,7 +2099,7 @@ export function createSliceIds(
|
|
|
1998
2099
|
* @category Getter
|
|
1999
2100
|
* @since v8.1.0
|
|
2000
2101
|
*/
|
|
2001
|
-
export function
|
|
2102
|
+
export function getSliceRowIds(
|
|
2002
2103
|
indexId: MaybeGetter<Id>,
|
|
2003
2104
|
sliceId: MaybeGetter<Id>,
|
|
2004
2105
|
indexesOrIndexesId?: MaybeGetter<IndexesOrIndexesId | undefined>,
|
|
@@ -2028,33 +2129,33 @@ export function resolveQueries(
|
|
|
2028
2129
|
): () => Queries | undefined;
|
|
2029
2130
|
|
|
2030
2131
|
/**
|
|
2031
|
-
* The
|
|
2132
|
+
* The getQueriesIds function returns a reactive object with the Ids of all
|
|
2032
2133
|
* Queries objects registered in the current Provider context.
|
|
2033
2134
|
* @returns A reactive object with a `current` Ids property.
|
|
2034
2135
|
* @category Getter
|
|
2035
2136
|
* @since v8.1.0
|
|
2036
2137
|
*/
|
|
2037
|
-
export function
|
|
2138
|
+
export function getQueriesIds(): {readonly current: Ids};
|
|
2038
2139
|
|
|
2039
2140
|
/**
|
|
2040
|
-
* The
|
|
2041
|
-
*
|
|
2042
|
-
* will update
|
|
2141
|
+
* The getQueryIds function returns a reactive object reflecting the Ids of the
|
|
2142
|
+
* Queries in a Queries object, and registers a listener so that any changes
|
|
2143
|
+
* will update `current`.
|
|
2043
2144
|
* @param queriesOrQueriesId The Queries object to use, or its Id.
|
|
2044
2145
|
* @returns A reactive object with a `current` Ids property.
|
|
2045
2146
|
* @category Getter
|
|
2046
2147
|
* @since v8.1.0
|
|
2047
2148
|
*/
|
|
2048
|
-
export function
|
|
2149
|
+
export function getQueryIds(
|
|
2049
2150
|
queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
|
|
2050
2151
|
): {
|
|
2051
2152
|
readonly current: Ids;
|
|
2052
2153
|
};
|
|
2053
2154
|
|
|
2054
2155
|
/**
|
|
2055
|
-
* The
|
|
2156
|
+
* The getResultTable function returns a reactive object reflecting a result
|
|
2056
2157
|
* Table in a Queries object, and registers a listener so that any changes to
|
|
2057
|
-
* that result will update
|
|
2158
|
+
* that result will update `current`.
|
|
2058
2159
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2059
2160
|
* @param queriesOrQueriesId The Queries object to use (plain or getter), or its
|
|
2060
2161
|
* Id.
|
|
@@ -2062,15 +2163,15 @@ export function createQueryIds(
|
|
|
2062
2163
|
* @category Getter
|
|
2063
2164
|
* @since v8.1.0
|
|
2064
2165
|
*/
|
|
2065
|
-
export function
|
|
2166
|
+
export function getResultTable(
|
|
2066
2167
|
queryId: MaybeGetter<Id>,
|
|
2067
2168
|
queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
|
|
2068
2169
|
): {readonly current: Table};
|
|
2069
2170
|
|
|
2070
2171
|
/**
|
|
2071
|
-
* The
|
|
2072
|
-
*
|
|
2073
|
-
*
|
|
2172
|
+
* The getResultTableCellIds function returns a reactive object reflecting the
|
|
2173
|
+
* Ids of all Cells used across a result Table, and registers a listener so that
|
|
2174
|
+
* any changes will update `current`.
|
|
2074
2175
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2075
2176
|
* @param queriesOrQueriesId The Queries object to use (plain or getter), or its
|
|
2076
2177
|
* Id.
|
|
@@ -2078,15 +2179,15 @@ export function createResultTable(
|
|
|
2078
2179
|
* @category Getter
|
|
2079
2180
|
* @since v8.1.0
|
|
2080
2181
|
*/
|
|
2081
|
-
export function
|
|
2182
|
+
export function getResultTableCellIds(
|
|
2082
2183
|
queryId: MaybeGetter<Id>,
|
|
2083
2184
|
queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
|
|
2084
2185
|
): {readonly current: Ids};
|
|
2085
2186
|
|
|
2086
2187
|
/**
|
|
2087
|
-
* The
|
|
2188
|
+
* The getResultRowCount function returns a reactive object reflecting the
|
|
2088
2189
|
* number of Rows in a result Table, and registers a listener so that any
|
|
2089
|
-
* changes will update
|
|
2190
|
+
* changes will update `current`.
|
|
2090
2191
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2091
2192
|
* @param queriesOrQueriesId The Queries object to use (plain or getter), or its
|
|
2092
2193
|
* Id.
|
|
@@ -2094,15 +2195,15 @@ export function createResultTableCellIds(
|
|
|
2094
2195
|
* @category Getter
|
|
2095
2196
|
* @since v8.1.0
|
|
2096
2197
|
*/
|
|
2097
|
-
export function
|
|
2198
|
+
export function getResultRowCount(
|
|
2098
2199
|
queryId: MaybeGetter<Id>,
|
|
2099
2200
|
queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
|
|
2100
2201
|
): {readonly current: number};
|
|
2101
2202
|
|
|
2102
2203
|
/**
|
|
2103
|
-
* The
|
|
2104
|
-
*
|
|
2105
|
-
*
|
|
2204
|
+
* The getResultRowIds function returns a reactive object reflecting the Ids of
|
|
2205
|
+
* the Rows in a result Table, and registers a listener so that any changes will
|
|
2206
|
+
* update `current`.
|
|
2106
2207
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2107
2208
|
* @param queriesOrQueriesId The Queries object to use (plain or getter), or its
|
|
2108
2209
|
* Id.
|
|
@@ -2110,15 +2211,15 @@ export function createResultRowCount(
|
|
|
2110
2211
|
* @category Getter
|
|
2111
2212
|
* @since v8.1.0
|
|
2112
2213
|
*/
|
|
2113
|
-
export function
|
|
2214
|
+
export function getResultRowIds(
|
|
2114
2215
|
queryId: MaybeGetter<Id>,
|
|
2115
2216
|
queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
|
|
2116
2217
|
): {readonly current: Ids};
|
|
2117
2218
|
|
|
2118
2219
|
/**
|
|
2119
|
-
* The
|
|
2120
|
-
*
|
|
2121
|
-
* changes will update
|
|
2220
|
+
* The getResultSortedRowIds function returns a reactive object reflecting the
|
|
2221
|
+
* sorted Row Ids in a result Table, and registers a listener so that any
|
|
2222
|
+
* changes will update `current`.
|
|
2122
2223
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2123
2224
|
* @param cellId The Id of the Cell to sort by (or a getter returning it).
|
|
2124
2225
|
* @param descending Whether to sort descending (or a getter returning it).
|
|
@@ -2130,7 +2231,7 @@ export function createResultRowIds(
|
|
|
2130
2231
|
* @category Getter
|
|
2131
2232
|
* @since v8.1.0
|
|
2132
2233
|
*/
|
|
2133
|
-
export function
|
|
2234
|
+
export function getResultSortedRowIds(
|
|
2134
2235
|
queryId: MaybeGetter<Id>,
|
|
2135
2236
|
cellId?: MaybeGetter<Id | undefined>,
|
|
2136
2237
|
descending?: MaybeGetter<boolean>,
|
|
@@ -2140,9 +2241,9 @@ export function createResultSortedRowIds(
|
|
|
2140
2241
|
): {readonly current: Ids};
|
|
2141
2242
|
|
|
2142
2243
|
/**
|
|
2143
|
-
* The
|
|
2144
|
-
*
|
|
2145
|
-
*
|
|
2244
|
+
* The getResultRow function returns a reactive object reflecting a result Row
|
|
2245
|
+
* in a result Table, and registers a listener so that any changes will update
|
|
2246
|
+
* `current`.
|
|
2146
2247
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2147
2248
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
2148
2249
|
* @param queriesOrQueriesId The Queries object to use (plain or getter), or its
|
|
@@ -2151,16 +2252,16 @@ export function createResultSortedRowIds(
|
|
|
2151
2252
|
* @category Getter
|
|
2152
2253
|
* @since v8.1.0
|
|
2153
2254
|
*/
|
|
2154
|
-
export function
|
|
2255
|
+
export function getResultRow(
|
|
2155
2256
|
queryId: MaybeGetter<Id>,
|
|
2156
2257
|
rowId: MaybeGetter<Id>,
|
|
2157
2258
|
queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
|
|
2158
2259
|
): {readonly current: Row};
|
|
2159
2260
|
|
|
2160
2261
|
/**
|
|
2161
|
-
* The
|
|
2162
|
-
*
|
|
2163
|
-
*
|
|
2262
|
+
* The getResultCellIds function returns a reactive object reflecting the Ids of
|
|
2263
|
+
* the Cells in a result Row, and registers a listener so that any changes will
|
|
2264
|
+
* update `current`.
|
|
2164
2265
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2165
2266
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
2166
2267
|
* @param queriesOrQueriesId The Queries object to use (plain or getter), or its
|
|
@@ -2169,16 +2270,16 @@ export function createResultRow(
|
|
|
2169
2270
|
* @category Getter
|
|
2170
2271
|
* @since v8.1.0
|
|
2171
2272
|
*/
|
|
2172
|
-
export function
|
|
2273
|
+
export function getResultCellIds(
|
|
2173
2274
|
queryId: MaybeGetter<Id>,
|
|
2174
2275
|
rowId: MaybeGetter<Id>,
|
|
2175
2276
|
queriesOrQueriesId?: MaybeGetter<QueriesOrQueriesId | undefined>,
|
|
2176
2277
|
): {readonly current: Ids};
|
|
2177
2278
|
|
|
2178
2279
|
/**
|
|
2179
|
-
* The
|
|
2180
|
-
*
|
|
2181
|
-
* update
|
|
2280
|
+
* The getResultCell function returns a reactive object reflecting the value of
|
|
2281
|
+
* a Cell in a result Row, and registers a listener so that any changes will
|
|
2282
|
+
* update `current`.
|
|
2182
2283
|
* @param queryId The Id of the Query (or a getter returning it).
|
|
2183
2284
|
* @param rowId The Id of the Row (or a getter returning it).
|
|
2184
2285
|
* @param cellId The Id of the Cell (or a getter returning it).
|
|
@@ -2188,7 +2289,7 @@ export function createResultCellIds(
|
|
|
2188
2289
|
* @category Getter
|
|
2189
2290
|
* @since v8.1.0
|
|
2190
2291
|
*/
|
|
2191
|
-
export function
|
|
2292
|
+
export function getResultCell(
|
|
2192
2293
|
queryId: MaybeGetter<Id>,
|
|
2193
2294
|
rowId: MaybeGetter<Id>,
|
|
2194
2295
|
cellId: MaybeGetter<Id>,
|
|
@@ -2243,34 +2344,34 @@ export function getRelationshipsStoreTableIds(
|
|
|
2243
2344
|
};
|
|
2244
2345
|
|
|
2245
2346
|
/**
|
|
2246
|
-
* The
|
|
2347
|
+
* The getRelationshipsIds function returns a reactive object with the Ids of
|
|
2247
2348
|
* all Relationships objects registered in the current Provider context.
|
|
2248
2349
|
* @returns A reactive object with a `current` Ids property.
|
|
2249
2350
|
* @category Getter
|
|
2250
2351
|
* @since v8.1.0
|
|
2251
2352
|
*/
|
|
2252
|
-
export function
|
|
2353
|
+
export function getRelationshipsIds(): {readonly current: Ids};
|
|
2253
2354
|
|
|
2254
2355
|
/**
|
|
2255
|
-
* The
|
|
2256
|
-
*
|
|
2257
|
-
*
|
|
2356
|
+
* The getRelationshipIds function returns a reactive object reflecting the Ids
|
|
2357
|
+
* of the Relationships in a Relationships object, and registers a listener so
|
|
2358
|
+
* that any changes will update `current`.
|
|
2258
2359
|
* @param relationshipsOrRelationshipsId The Relationships object to use, or its
|
|
2259
2360
|
* Id.
|
|
2260
2361
|
* @returns A reactive object with a `current` Ids property.
|
|
2261
2362
|
* @category Getter
|
|
2262
2363
|
* @since v8.1.0
|
|
2263
2364
|
*/
|
|
2264
|
-
export function
|
|
2365
|
+
export function getRelationshipIds(
|
|
2265
2366
|
relationshipsOrRelationshipsId?: MaybeGetter<
|
|
2266
2367
|
RelationshipsOrRelationshipsId | undefined
|
|
2267
2368
|
>,
|
|
2268
2369
|
): {readonly current: Ids};
|
|
2269
2370
|
|
|
2270
2371
|
/**
|
|
2271
|
-
* The
|
|
2272
|
-
*
|
|
2273
|
-
*
|
|
2372
|
+
* The getRemoteRowId function returns a reactive object reflecting the remote
|
|
2373
|
+
* Row Id for a given local Row in a Relationship, and registers a listener so
|
|
2374
|
+
* that any changes will update `current`.
|
|
2274
2375
|
* @param relationshipId The Id of the Relationship (or a getter returning it).
|
|
2275
2376
|
* @param localRowId The Id of the local Row (or a getter returning it).
|
|
2276
2377
|
* @param relationshipsOrRelationshipsId The Relationships object to use (plain
|
|
@@ -2279,7 +2380,7 @@ export function createRelationshipIds(
|
|
|
2279
2380
|
* @category Getter
|
|
2280
2381
|
* @since v8.1.0
|
|
2281
2382
|
*/
|
|
2282
|
-
export function
|
|
2383
|
+
export function getRemoteRowId(
|
|
2283
2384
|
relationshipId: MaybeGetter<Id>,
|
|
2284
2385
|
localRowId: MaybeGetter<Id>,
|
|
2285
2386
|
relationshipsOrRelationshipsId?: MaybeGetter<
|
|
@@ -2288,9 +2389,9 @@ export function createRemoteRowId(
|
|
|
2288
2389
|
): {readonly current: Id | undefined};
|
|
2289
2390
|
|
|
2290
2391
|
/**
|
|
2291
|
-
* The
|
|
2392
|
+
* The getLocalRowIds function returns a reactive object reflecting the local
|
|
2292
2393
|
* Row Ids for a given remote Row in a Relationship, and registers a listener so
|
|
2293
|
-
* that any changes will update
|
|
2394
|
+
* that any changes will update `current`.
|
|
2294
2395
|
* @param relationshipId The Id of the Relationship (or a getter returning it).
|
|
2295
2396
|
* @param remoteRowId The Id of the remote Row (or a getter returning it).
|
|
2296
2397
|
* @param relationshipsOrRelationshipsId The Relationships object to use (plain
|
|
@@ -2299,7 +2400,7 @@ export function createRemoteRowId(
|
|
|
2299
2400
|
* @category Getter
|
|
2300
2401
|
* @since v8.1.0
|
|
2301
2402
|
*/
|
|
2302
|
-
export function
|
|
2403
|
+
export function getLocalRowIds(
|
|
2303
2404
|
relationshipId: MaybeGetter<Id>,
|
|
2304
2405
|
remoteRowId: MaybeGetter<Id>,
|
|
2305
2406
|
relationshipsOrRelationshipsId?: MaybeGetter<
|
|
@@ -2308,9 +2409,9 @@ export function createLocalRowIds(
|
|
|
2308
2409
|
): {readonly current: Ids};
|
|
2309
2410
|
|
|
2310
2411
|
/**
|
|
2311
|
-
* The
|
|
2312
|
-
*
|
|
2313
|
-
*
|
|
2412
|
+
* The getLinkedRowIds function returns a reactive object reflecting the linked
|
|
2413
|
+
* Row Ids in a Relationship, and registers a listener so that any changes will
|
|
2414
|
+
* update `current`.
|
|
2314
2415
|
* @param relationshipId The Id of the Relationship (or a getter returning it).
|
|
2315
2416
|
* @param firstRowId The Id of the first Row (or a getter returning it).
|
|
2316
2417
|
* @param relationshipsOrRelationshipsId The Relationships object to use (plain
|
|
@@ -2319,7 +2420,7 @@ export function createLocalRowIds(
|
|
|
2319
2420
|
* @category Getter
|
|
2320
2421
|
* @since v8.1.0
|
|
2321
2422
|
*/
|
|
2322
|
-
export function
|
|
2423
|
+
export function getLinkedRowIds(
|
|
2323
2424
|
relationshipId: MaybeGetter<Id>,
|
|
2324
2425
|
firstRowId: MaybeGetter<Id>,
|
|
2325
2426
|
relationshipsOrRelationshipsId?: MaybeGetter<
|
|
@@ -2354,34 +2455,34 @@ export function resolveCheckpoints(
|
|
|
2354
2455
|
): () => Checkpoints | undefined;
|
|
2355
2456
|
|
|
2356
2457
|
/**
|
|
2357
|
-
* The
|
|
2358
|
-
*
|
|
2458
|
+
* The getCheckpointsIds function returns a reactive object with the Ids of all
|
|
2459
|
+
* Checkpoints objects registered in the current Provider context.
|
|
2359
2460
|
* @returns A reactive object with a `current` Ids property.
|
|
2360
2461
|
* @category Getter
|
|
2361
2462
|
* @since v8.1.0
|
|
2362
2463
|
*/
|
|
2363
|
-
export function
|
|
2464
|
+
export function getCheckpointsIds(): {readonly current: Ids};
|
|
2364
2465
|
|
|
2365
2466
|
/**
|
|
2366
|
-
* The
|
|
2467
|
+
* The getCheckpointIds function returns a reactive object reflecting the
|
|
2367
2468
|
* CheckpointIds (backward, current, forward) in a Checkpoints object, and
|
|
2368
|
-
* registers a listener so that any changes will update
|
|
2469
|
+
* registers a listener so that any changes will update `current`.
|
|
2369
2470
|
* @param checkpointsOrCheckpointsId The Checkpoints object to use (plain or
|
|
2370
2471
|
* getter), or its Id.
|
|
2371
2472
|
* @returns A reactive object with a `current` CheckpointIds property.
|
|
2372
2473
|
* @category Getter
|
|
2373
2474
|
* @since v8.1.0
|
|
2374
2475
|
*/
|
|
2375
|
-
export function
|
|
2476
|
+
export function getCheckpointIds(
|
|
2376
2477
|
checkpointsOrCheckpointsId?: MaybeGetter<
|
|
2377
2478
|
CheckpointsOrCheckpointsId | undefined
|
|
2378
2479
|
>,
|
|
2379
2480
|
): {readonly current: CheckpointIds};
|
|
2380
2481
|
|
|
2381
2482
|
/**
|
|
2382
|
-
* The
|
|
2383
|
-
*
|
|
2384
|
-
*
|
|
2483
|
+
* The getCheckpoint function returns a reactive object reflecting the label of
|
|
2484
|
+
* a checkpoint, and registers a listener so that any changes will update
|
|
2485
|
+
* `current`.
|
|
2385
2486
|
* @param checkpointId The Id of the checkpoint (or a getter returning it).
|
|
2386
2487
|
* @param checkpointsOrCheckpointsId The Checkpoints object to use (plain or
|
|
2387
2488
|
* getter), or its Id.
|
|
@@ -2389,7 +2490,7 @@ export function createCheckpointIds(
|
|
|
2389
2490
|
* @category Getter
|
|
2390
2491
|
* @since v8.1.0
|
|
2391
2492
|
*/
|
|
2392
|
-
export function
|
|
2493
|
+
export function getCheckpoint(
|
|
2393
2494
|
checkpointId: MaybeGetter<Id>,
|
|
2394
2495
|
checkpointsOrCheckpointsId?: MaybeGetter<
|
|
2395
2496
|
CheckpointsOrCheckpointsId | undefined
|
|
@@ -2448,24 +2549,24 @@ export function resolvePersister(
|
|
|
2448
2549
|
): () => AnyPersister | undefined;
|
|
2449
2550
|
|
|
2450
2551
|
/**
|
|
2451
|
-
* The
|
|
2552
|
+
* The getPersisterIds function returns a reactive object with the Ids of all
|
|
2452
2553
|
* Persisters registered in the current Provider context.
|
|
2453
2554
|
* @returns A reactive object with a `current` Ids property.
|
|
2454
2555
|
* @category Getter
|
|
2455
2556
|
* @since v8.1.0
|
|
2456
2557
|
*/
|
|
2457
|
-
export function
|
|
2558
|
+
export function getPersisterIds(): {readonly current: Ids};
|
|
2458
2559
|
|
|
2459
2560
|
/**
|
|
2460
|
-
* The
|
|
2561
|
+
* The getPersisterStatus function returns a reactive object reflecting the
|
|
2461
2562
|
* status of a Persister, and registers a listener so that any changes will
|
|
2462
|
-
* update
|
|
2563
|
+
* update `current`.
|
|
2463
2564
|
* @param persisterOrPersisterId The Persister to use, or its Id.
|
|
2464
2565
|
* @returns A reactive object with a `current` Status property.
|
|
2465
2566
|
* @category Getter
|
|
2466
2567
|
* @since v8.1.0
|
|
2467
2568
|
*/
|
|
2468
|
-
export function
|
|
2569
|
+
export function getPersisterStatus(
|
|
2469
2570
|
persisterOrPersisterId?: MaybeGetter<PersisterOrPersisterId | undefined>,
|
|
2470
2571
|
): {readonly current: Status};
|
|
2471
2572
|
|
|
@@ -2495,24 +2596,24 @@ export function resolveSynchronizer(
|
|
|
2495
2596
|
): () => Synchronizer | undefined;
|
|
2496
2597
|
|
|
2497
2598
|
/**
|
|
2498
|
-
* The
|
|
2499
|
-
*
|
|
2599
|
+
* The getSynchronizerIds function returns a reactive object with the Ids of all
|
|
2600
|
+
* Synchronizers registered in the current Provider context.
|
|
2500
2601
|
* @returns A reactive object with a `current` Ids property.
|
|
2501
2602
|
* @category Getter
|
|
2502
2603
|
* @since v8.1.0
|
|
2503
2604
|
*/
|
|
2504
|
-
export function
|
|
2605
|
+
export function getSynchronizerIds(): {readonly current: Ids};
|
|
2505
2606
|
|
|
2506
2607
|
/**
|
|
2507
|
-
* The
|
|
2508
|
-
*
|
|
2509
|
-
*
|
|
2608
|
+
* The getSynchronizerStatus function returns a reactive object reflecting the
|
|
2609
|
+
* status of a Synchronizer, and registers a listener so that any changes will
|
|
2610
|
+
* update `current`.
|
|
2510
2611
|
* @param synchronizerOrSynchronizerId The Synchronizer to use, or its Id.
|
|
2511
2612
|
* @returns A reactive object with a `current` Status property.
|
|
2512
2613
|
* @category Getter
|
|
2513
2614
|
* @since v8.1.0
|
|
2514
2615
|
*/
|
|
2515
|
-
export function
|
|
2616
|
+
export function getSynchronizerStatus(
|
|
2516
2617
|
synchronizerOrSynchronizerId?: MaybeGetter<
|
|
2517
2618
|
SynchronizerOrSynchronizerId | undefined
|
|
2518
2619
|
>,
|