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