tinybase 3.1.0-beta.5 → 3.1.1
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/lib/checkpoints.js +1 -1
- package/lib/checkpoints.js.gz +0 -0
- package/lib/cjs/checkpoints.cjs +1 -1
- package/lib/cjs/checkpoints.cjs.gz +0 -0
- package/lib/cjs/indexes.cjs +1 -1
- package/lib/cjs/indexes.cjs.gz +0 -0
- package/lib/cjs/metrics.cjs +1 -1
- package/lib/cjs/metrics.cjs.gz +0 -0
- package/lib/cjs/relationships.cjs +1 -1
- package/lib/cjs/relationships.cjs.gz +0 -0
- package/lib/cjs/store.cjs +1 -1
- package/lib/cjs/store.cjs.gz +0 -0
- package/lib/cjs/tinybase.cjs +1 -1
- package/lib/cjs/tinybase.cjs.gz +0 -0
- package/lib/cjs/tools.cjs +1 -1
- package/lib/cjs/tools.cjs.gz +0 -0
- package/lib/cjs/ui-react.cjs +1 -1
- package/lib/cjs/ui-react.cjs.gz +0 -0
- package/lib/cjs-es6/checkpoints.cjs +1 -1
- package/lib/cjs-es6/checkpoints.cjs.gz +0 -0
- package/lib/cjs-es6/indexes.cjs +1 -1
- package/lib/cjs-es6/indexes.cjs.gz +0 -0
- package/lib/cjs-es6/metrics.cjs +1 -1
- package/lib/cjs-es6/metrics.cjs.gz +0 -0
- package/lib/cjs-es6/relationships.cjs +1 -1
- package/lib/cjs-es6/relationships.cjs.gz +0 -0
- package/lib/cjs-es6/store.cjs +1 -1
- package/lib/cjs-es6/store.cjs.gz +0 -0
- package/lib/cjs-es6/tinybase.cjs +1 -1
- package/lib/cjs-es6/tinybase.cjs.gz +0 -0
- package/lib/cjs-es6/tools.cjs +1 -1
- package/lib/cjs-es6/tools.cjs.gz +0 -0
- package/lib/cjs-es6/ui-react.cjs +1 -1
- package/lib/cjs-es6/ui-react.cjs.gz +0 -0
- package/lib/debug/checkpoints.js +2 -2
- package/lib/debug/indexes.js +2 -2
- package/lib/debug/metrics.js +2 -2
- package/lib/debug/relationships.js +2 -2
- package/lib/debug/store.js +7 -7
- package/lib/debug/tinybase.js +7 -7
- package/lib/debug/tools.js +5 -4
- package/lib/debug/ui-react.js +3 -2
- package/lib/es6/checkpoints.js +1 -1
- package/lib/es6/checkpoints.js.gz +0 -0
- package/lib/es6/indexes.js +1 -1
- package/lib/es6/indexes.js.gz +0 -0
- package/lib/es6/metrics.js +1 -1
- package/lib/es6/metrics.js.gz +0 -0
- package/lib/es6/relationships.js +1 -1
- package/lib/es6/relationships.js.gz +0 -0
- package/lib/es6/store.js +1 -1
- package/lib/es6/store.js.gz +0 -0
- package/lib/es6/tinybase.js +1 -1
- package/lib/es6/tinybase.js.gz +0 -0
- package/lib/es6/tools.js +1 -1
- package/lib/es6/tools.js.gz +0 -0
- package/lib/es6/ui-react.js +1 -1
- package/lib/es6/ui-react.js.gz +0 -0
- package/lib/indexes.js +1 -1
- package/lib/indexes.js.gz +0 -0
- package/lib/metrics.js +1 -1
- package/lib/metrics.js.gz +0 -0
- package/lib/relationships.js +1 -1
- package/lib/relationships.js.gz +0 -0
- package/lib/store.js +1 -1
- package/lib/store.js.gz +0 -0
- package/lib/tinybase.js +1 -1
- package/lib/tinybase.js.gz +0 -0
- package/lib/tools.js +1 -1
- package/lib/tools.js.gz +0 -0
- package/lib/types/checkpoints.d.ts +2 -0
- package/lib/types/indexes.d.ts +2 -0
- package/lib/types/metrics.d.ts +2 -0
- package/lib/types/persisters.d.ts +2 -0
- package/lib/types/queries.d.ts +2 -0
- package/lib/types/relationships.d.ts +2 -0
- package/lib/types/store.d.ts +60 -1
- package/lib/types/tools.d.ts +5 -0
- package/lib/types/ui-react.d.ts +11 -0
- package/lib/types/with-schemas/checkpoints.d.ts +84 -0
- package/lib/types/with-schemas/indexes.d.ts +105 -0
- package/lib/types/with-schemas/metrics.d.ts +61 -0
- package/lib/types/with-schemas/persisters.d.ts +98 -0
- package/lib/types/with-schemas/queries.d.ts +258 -0
- package/lib/types/with-schemas/relationships.d.ts +122 -0
- package/lib/types/with-schemas/store.d.ts +742 -8
- package/lib/types/with-schemas/tools.d.ts +14 -0
- package/lib/types/with-schemas/ui-react.d.ts +1066 -0
- package/lib/ui-react.js +1 -1
- package/lib/ui-react.js.gz +0 -0
- package/lib/umd/checkpoints.js +1 -1
- package/lib/umd/checkpoints.js.gz +0 -0
- package/lib/umd/indexes.js +1 -1
- package/lib/umd/indexes.js.gz +0 -0
- package/lib/umd/metrics.js +1 -1
- package/lib/umd/metrics.js.gz +0 -0
- package/lib/umd/relationships.js +1 -1
- package/lib/umd/relationships.js.gz +0 -0
- package/lib/umd/store.js +1 -1
- package/lib/umd/store.js.gz +0 -0
- package/lib/umd/tinybase.js +1 -1
- package/lib/umd/tinybase.js.gz +0 -0
- package/lib/umd/tools.js +1 -1
- package/lib/umd/tools.js.gz +0 -0
- package/lib/umd/ui-react.js +1 -1
- package/lib/umd/ui-react.js.gz +0 -0
- package/lib/umd-es6/checkpoints.js +1 -1
- package/lib/umd-es6/checkpoints.js.gz +0 -0
- package/lib/umd-es6/indexes.js +1 -1
- package/lib/umd-es6/indexes.js.gz +0 -0
- package/lib/umd-es6/metrics.js +1 -1
- package/lib/umd-es6/metrics.js.gz +0 -0
- package/lib/umd-es6/relationships.js +1 -1
- package/lib/umd-es6/relationships.js.gz +0 -0
- package/lib/umd-es6/store.js +1 -1
- package/lib/umd-es6/store.js.gz +0 -0
- package/lib/umd-es6/tinybase.js +1 -1
- package/lib/umd-es6/tinybase.js.gz +0 -0
- package/lib/umd-es6/tools.js +1 -1
- package/lib/umd-es6/tools.js.gz +0 -0
- package/lib/umd-es6/ui-react.js +1 -1
- package/lib/umd-es6/ui-react.js.gz +0 -0
- package/package.json +2 -2
- package/readme.md +14 -14
|
@@ -122,6 +122,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
122
122
|
* The StoreOrStoreId type is used when you need to refer to a Store in a React
|
|
123
123
|
* hook or component.
|
|
124
124
|
*
|
|
125
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
126
|
+
*
|
|
127
|
+
* ```ts override
|
|
128
|
+
* Store | Id;
|
|
129
|
+
* ```
|
|
130
|
+
*
|
|
125
131
|
* In some simple cases you will already have a direct reference to the Store.
|
|
126
132
|
*
|
|
127
133
|
* This module also includes a Provider component that can be used to wrap
|
|
@@ -139,6 +145,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
139
145
|
* The MetricsOrMetricsId type is used when you need to refer to a Metrics
|
|
140
146
|
* object in a React hook or component.
|
|
141
147
|
*
|
|
148
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
149
|
+
*
|
|
150
|
+
* ```ts override
|
|
151
|
+
* Metrics | Id;
|
|
152
|
+
* ```
|
|
153
|
+
*
|
|
142
154
|
* In some simple cases you will already have a direct reference to the Metrics
|
|
143
155
|
* object.
|
|
144
156
|
*
|
|
@@ -158,6 +170,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
158
170
|
* The IndexesOrIndexesId type is used when you need to refer to a Indexes
|
|
159
171
|
* object in a React hook or component.
|
|
160
172
|
*
|
|
173
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
174
|
+
*
|
|
175
|
+
* ```ts override
|
|
176
|
+
* Indexes | Id;
|
|
177
|
+
* ```
|
|
178
|
+
*
|
|
161
179
|
* In some simple cases you will already have a direct reference to the Indexes
|
|
162
180
|
* object.
|
|
163
181
|
*
|
|
@@ -177,6 +195,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
177
195
|
* The RelationshipsOrRelationshipsId type is used when you need to refer to a
|
|
178
196
|
* Relationships object in a React hook or component.
|
|
179
197
|
*
|
|
198
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
199
|
+
*
|
|
200
|
+
* ```ts override
|
|
201
|
+
* Relationships | Id;
|
|
202
|
+
* ```
|
|
203
|
+
*
|
|
180
204
|
* In some simple cases you will already have a direct reference to the
|
|
181
205
|
* Relationships object.
|
|
182
206
|
*
|
|
@@ -196,6 +220,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
196
220
|
* The QueriesOrQueriesId type is used when you need to refer to a Queries
|
|
197
221
|
* object in a React hook or component.
|
|
198
222
|
*
|
|
223
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
224
|
+
*
|
|
225
|
+
* ```ts override
|
|
226
|
+
* Queries | Id;
|
|
227
|
+
* ```
|
|
228
|
+
*
|
|
199
229
|
* In some simple cases you will already have a direct reference to the Queries
|
|
200
230
|
* object.
|
|
201
231
|
*
|
|
@@ -216,6 +246,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
216
246
|
* The CheckpointsOrCheckpointsId type is used when you need to refer to a
|
|
217
247
|
* Checkpoints object in a React hook or component.
|
|
218
248
|
*
|
|
249
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
250
|
+
*
|
|
251
|
+
* ```ts override
|
|
252
|
+
* Checkpoints | Id;
|
|
253
|
+
* ```
|
|
254
|
+
*
|
|
219
255
|
* In some simple cases you will already have a direct reference to the
|
|
220
256
|
* Checkpoints object.
|
|
221
257
|
*
|
|
@@ -248,6 +284,15 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
248
284
|
* The useCreateStore hook is used to create a Store within a React application
|
|
249
285
|
* with convenient memoization.
|
|
250
286
|
*
|
|
287
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
288
|
+
*
|
|
289
|
+
* ```ts override
|
|
290
|
+
* useCreateStore(
|
|
291
|
+
* create: () => Store,
|
|
292
|
+
* createDeps?: React.DependencyList,
|
|
293
|
+
* ): Store;
|
|
294
|
+
* ```
|
|
295
|
+
*
|
|
251
296
|
* It is possible to create a Store outside of the React app with the regular
|
|
252
297
|
* createStore function and pass it in, but you may prefer to create it within
|
|
253
298
|
* the app, perhaps inside the top-level component. To defend against a new
|
|
@@ -334,6 +379,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
334
379
|
* The useStore hook is used to get a reference to a Store from within a
|
|
335
380
|
* Provider component context.
|
|
336
381
|
*
|
|
382
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
383
|
+
*
|
|
384
|
+
* ```ts override
|
|
385
|
+
* useStore(id?: Id): Store | undefined;
|
|
386
|
+
* ```
|
|
387
|
+
*
|
|
337
388
|
* A Provider component is used to wrap part of an application in a context. It
|
|
338
389
|
* can contain a default Store (or a set of Store objects named by Id) that can
|
|
339
390
|
* be easily accessed without having to be passed down as props through every
|
|
@@ -396,6 +447,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
396
447
|
* Store, and registers a listener so that any changes to that result will cause
|
|
397
448
|
* a re-render.
|
|
398
449
|
*
|
|
450
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
451
|
+
*
|
|
452
|
+
* ```ts override
|
|
453
|
+
* useTables(storeOrStoreId?: StoreOrStoreId): Tables;
|
|
454
|
+
* ```
|
|
455
|
+
*
|
|
399
456
|
* A Provider component is used to wrap part of an application in a context, and
|
|
400
457
|
* it can contain a default Store or a set of Store objects named by Id. The
|
|
401
458
|
* useTables hook lets you indicate which Store to get data for: omit the
|
|
@@ -473,6 +530,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
473
530
|
* The useTableIds hook returns the Ids of every Table in a Store, and registers
|
|
474
531
|
* a listener so that any changes to that result will cause a re-render.
|
|
475
532
|
*
|
|
533
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
534
|
+
*
|
|
535
|
+
* ```ts override
|
|
536
|
+
* useTableIds(storeOrStoreId?: StoreOrStoreId): Ids;
|
|
537
|
+
* ```
|
|
538
|
+
*
|
|
476
539
|
* A Provider component is used to wrap part of an application in a context, and
|
|
477
540
|
* it can contain a default Store or a set of Store objects named by Id. The
|
|
478
541
|
* useTableIds hook lets you indicate which Store to get data for: omit the
|
|
@@ -552,6 +615,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
552
615
|
* a Store, and registers a listener so that any changes to that result will
|
|
553
616
|
* cause a re-render.
|
|
554
617
|
*
|
|
618
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
619
|
+
*
|
|
620
|
+
* ```ts override
|
|
621
|
+
* useTable(tableId: Id, storeOrStoreId?: StoreOrStoreId): Table;
|
|
622
|
+
* ```
|
|
623
|
+
*
|
|
555
624
|
* A Provider component is used to wrap part of an application in a context, and
|
|
556
625
|
* it can contain a default Store or a set of Store objects named by Id. The
|
|
557
626
|
* useTable hook lets you indicate which Store to get data for: omit the final
|
|
@@ -635,6 +704,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
635
704
|
* registers a listener so that any changes to that result will cause a
|
|
636
705
|
* re-render.
|
|
637
706
|
*
|
|
707
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
708
|
+
*
|
|
709
|
+
* ```ts override
|
|
710
|
+
* useRowIds(tableId: Id, storeOrStoreId?: StoreOrStoreId): Ids;
|
|
711
|
+
* ```
|
|
712
|
+
*
|
|
638
713
|
* A Provider component is used to wrap part of an application in a context, and
|
|
639
714
|
* it can contain a default Store or a set of Store objects named by Id. The
|
|
640
715
|
* useRowIds hook lets you indicate which Store to get data for: omit the
|
|
@@ -718,6 +793,19 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
718
793
|
* of every Row in a given Table, and registers a listener so that any changes
|
|
719
794
|
* to that result will cause a re-render.
|
|
720
795
|
*
|
|
796
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
797
|
+
*
|
|
798
|
+
* ```ts override
|
|
799
|
+
* useSortedRowIds(
|
|
800
|
+
* tableId: Id,
|
|
801
|
+
* cellId?: Id,
|
|
802
|
+
* descending?: boolean,
|
|
803
|
+
* offset?: number,
|
|
804
|
+
* limit?: number,
|
|
805
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
806
|
+
* ): Ids;
|
|
807
|
+
* ```
|
|
808
|
+
*
|
|
721
809
|
* A Provider component is used to wrap part of an application in a context, and
|
|
722
810
|
* it can contain a default Store or a set of Store objects named by Id. The
|
|
723
811
|
* useSortedRowIds hook lets you indicate which Store to get data for: omit the
|
|
@@ -839,6 +927,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
839
927
|
* given Table, and registers a listener so that any changes to that result will
|
|
840
928
|
* cause a re-render.
|
|
841
929
|
*
|
|
930
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
931
|
+
*
|
|
932
|
+
* ```ts override
|
|
933
|
+
* useRow(
|
|
934
|
+
* tableId: Id,
|
|
935
|
+
* rowId: Id,
|
|
936
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
937
|
+
* ): Row;
|
|
938
|
+
* ```
|
|
939
|
+
*
|
|
842
940
|
* A Provider component is used to wrap part of an application in a context, and
|
|
843
941
|
* it can contain a default Store or a set of Store objects named by Id. The
|
|
844
942
|
* useRow hook lets you indicate which Store to get data for: omit the final
|
|
@@ -926,6 +1024,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
926
1024
|
* Table, and registers a listener so that any changes to that result will cause
|
|
927
1025
|
* a re-render.
|
|
928
1026
|
*
|
|
1027
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
1028
|
+
*
|
|
1029
|
+
* ```ts override
|
|
1030
|
+
* useCellIds(
|
|
1031
|
+
* tableId: Id,
|
|
1032
|
+
* rowId: Id,
|
|
1033
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
1034
|
+
* ): Ids;
|
|
1035
|
+
* ```
|
|
1036
|
+
*
|
|
929
1037
|
* A Provider component is used to wrap part of an application in a context, and
|
|
930
1038
|
* it can contain a default Store or a set of Store objects named by Id. The
|
|
931
1039
|
* useCellIds hook lets you indicate which Store to get data for: omit the
|
|
@@ -1018,6 +1126,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1018
1126
|
* given Row, in a given Table, and registers a listener so that any changes to
|
|
1019
1127
|
* that result will cause a re-render.
|
|
1020
1128
|
*
|
|
1129
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
1130
|
+
*
|
|
1131
|
+
* ```ts override
|
|
1132
|
+
* useCell(
|
|
1133
|
+
* tableId: Id,
|
|
1134
|
+
* rowId: Id,
|
|
1135
|
+
* cellId: Id,
|
|
1136
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
1137
|
+
* ): CellOrUndefined;
|
|
1138
|
+
* ```
|
|
1139
|
+
*
|
|
1021
1140
|
* A Provider component is used to wrap part of an application in a context, and
|
|
1022
1141
|
* it can contain a default Store or a set of Store objects named by Id. The
|
|
1023
1142
|
* useCell hook lets you indicate which Store to get data for: omit the final
|
|
@@ -1108,6 +1227,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1108
1227
|
* a Store, and registers a listener so that any changes to that result will
|
|
1109
1228
|
* cause a re-render.
|
|
1110
1229
|
*
|
|
1230
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
1231
|
+
*
|
|
1232
|
+
* ```ts override
|
|
1233
|
+
* useValues(storeOrStoreId?: StoreOrStoreId): Values;
|
|
1234
|
+
* ```
|
|
1235
|
+
*
|
|
1111
1236
|
* A Provider component is used to wrap part of an application in a context, and
|
|
1112
1237
|
* it can contain a default Store or a set of Store objects named by Id. The
|
|
1113
1238
|
* useValues hook lets you indicate which Store to get data for: omit the
|
|
@@ -1185,6 +1310,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1185
1310
|
* The useValueIds hook returns the Ids of every Value in a Store, and registers
|
|
1186
1311
|
* a listener so that any changes to that result will cause a re-render.
|
|
1187
1312
|
*
|
|
1313
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
1314
|
+
*
|
|
1315
|
+
* ```ts override
|
|
1316
|
+
* useValueIds(storeOrStoreId?: StoreOrStoreId): Ids;
|
|
1317
|
+
* ```
|
|
1318
|
+
*
|
|
1188
1319
|
* A Provider component is used to wrap part of an application in a context, and
|
|
1189
1320
|
* it can contain a default Store or a set of Store objects named by Id. The
|
|
1190
1321
|
* useValueIds hook lets you indicate which Store to get data for: omit the
|
|
@@ -1265,6 +1396,15 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1265
1396
|
* a Store, and registers a listener so that any changes to that result will
|
|
1266
1397
|
* cause a re-render.
|
|
1267
1398
|
*
|
|
1399
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
1400
|
+
*
|
|
1401
|
+
* ```ts override
|
|
1402
|
+
* useValue(
|
|
1403
|
+
* valueId: Id,
|
|
1404
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
1405
|
+
* ): ValueOrUndefined;
|
|
1406
|
+
* ```
|
|
1407
|
+
*
|
|
1268
1408
|
* A Provider component is used to wrap part of an application in a context, and
|
|
1269
1409
|
* it can contain a default Store or a set of Store objects named by Id. The
|
|
1270
1410
|
* useValue hook lets you indicate which Store to get data for: omit the final
|
|
@@ -1348,6 +1488,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1348
1488
|
* The useSetTablesCallback hook returns a parameterized callback that can be
|
|
1349
1489
|
* used to set the tabular data of a Store.
|
|
1350
1490
|
*
|
|
1491
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
1492
|
+
*
|
|
1493
|
+
* ```ts override
|
|
1494
|
+
* useSetTablesCallback<Parameter>(
|
|
1495
|
+
* getTables: (parameter: Parameter, store: Store) => Tables,
|
|
1496
|
+
* getTablesDeps?: React.DependencyList,
|
|
1497
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
1498
|
+
* then?: (store: Store, tables: Tables) => void,
|
|
1499
|
+
* thenDeps?: React.DependencyList,
|
|
1500
|
+
* ): ParameterizedCallback<Parameter>;
|
|
1501
|
+
* ```
|
|
1502
|
+
*
|
|
1351
1503
|
* This hook is useful, for example, when creating an event handler that will
|
|
1352
1504
|
* mutate the data in the Store. In this case, the parameter will likely be the
|
|
1353
1505
|
* event, so that you can use data from it as part of the mutation.
|
|
@@ -1434,6 +1586,19 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1434
1586
|
* The useSetTableCallback hook returns a parameterized callback that can be
|
|
1435
1587
|
* used to set the data of a single Table in a Store.
|
|
1436
1588
|
*
|
|
1589
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
1590
|
+
*
|
|
1591
|
+
* ```ts override
|
|
1592
|
+
* useSetTableCallback<Parameter>(
|
|
1593
|
+
* tableId: Id,
|
|
1594
|
+
* getTable: (parameter: Parameter, store: Store) => Table,
|
|
1595
|
+
* getTableDeps?: React.DependencyList,
|
|
1596
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
1597
|
+
* then?: (store: Store, table: Table) => void,
|
|
1598
|
+
* thenDeps?: React.DependencyList,
|
|
1599
|
+
* ): ParameterizedCallback<Parameter>;
|
|
1600
|
+
* ```
|
|
1601
|
+
*
|
|
1437
1602
|
* This hook is useful, for example, when creating an event handler that will
|
|
1438
1603
|
* mutate the data in the Store. In this case, the parameter will likely be the
|
|
1439
1604
|
* event, so that you can use data from it as part of the mutation.
|
|
@@ -1527,6 +1692,20 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1527
1692
|
* The useSetRowCallback hook returns a parameterized callback that can be used
|
|
1528
1693
|
* to set the data of a single Row in a Store.
|
|
1529
1694
|
*
|
|
1695
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
1696
|
+
*
|
|
1697
|
+
* ```ts override
|
|
1698
|
+
* useSetRowCallback<Parameter>(
|
|
1699
|
+
* tableId: Id,
|
|
1700
|
+
* rowId: Id,
|
|
1701
|
+
* getRow: (parameter: Parameter, store: Store) => Row,
|
|
1702
|
+
* getRowDeps?: React.DependencyList,
|
|
1703
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
1704
|
+
* then?: (store: Store, row: Row) => void,
|
|
1705
|
+
* thenDeps?: React.DependencyList,
|
|
1706
|
+
* ): ParameterizedCallback<Parameter>;
|
|
1707
|
+
* ```
|
|
1708
|
+
*
|
|
1530
1709
|
* This hook is useful, for example, when creating an event handler that will
|
|
1531
1710
|
* mutate the data in the Store. In this case, the parameter will likely be the
|
|
1532
1711
|
* event, so that you can use data from it as part of the mutation.
|
|
@@ -1620,6 +1799,20 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1620
1799
|
* The useAddRowCallback hook returns a parameterized callback that can be used
|
|
1621
1800
|
* to create a new Row in a Store.
|
|
1622
1801
|
*
|
|
1802
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
1803
|
+
*
|
|
1804
|
+
* ```ts override
|
|
1805
|
+
* useAddRowCallback<Parameter>(
|
|
1806
|
+
* tableId: Id,
|
|
1807
|
+
* getRow: (parameter: Parameter, store: Store) => Row,
|
|
1808
|
+
* getRowDeps?: React.DependencyList,
|
|
1809
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
1810
|
+
* then?: (rowId: Id | undefined, store: Store, row: Row) => void,
|
|
1811
|
+
* thenDeps?: React.DependencyList,
|
|
1812
|
+
* reuseRowIds?: boolean,
|
|
1813
|
+
* ): ParameterizedCallback<Parameter>;
|
|
1814
|
+
* ```
|
|
1815
|
+
*
|
|
1623
1816
|
* This hook is useful, for example, when creating an event handler that will
|
|
1624
1817
|
* mutate the data in the Store. In this case, the parameter will likely be the
|
|
1625
1818
|
* event, so that you can use data from it as part of the mutation.
|
|
@@ -1641,6 +1834,13 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1641
1834
|
* hook's `storeOrStoreId` parameter) is always automatically used as a hook
|
|
1642
1835
|
* dependency for the callback.
|
|
1643
1836
|
*
|
|
1837
|
+
* The `reuseRowIds` parameter defaults to `true`, which means that if you
|
|
1838
|
+
* delete a Row and then add another, the Id will be re-used - unless you delete
|
|
1839
|
+
* the entire Table, in which case all Row Ids will reset. Otherwise, if you
|
|
1840
|
+
* specify `reuseRowIds` to be `false`, then the Id will be a monotonically
|
|
1841
|
+
* increasing string representation of an increasing integer, regardless of any
|
|
1842
|
+
* you may have previously deleted.
|
|
1843
|
+
*
|
|
1644
1844
|
* @param tableId The Id of the Table in the Store.
|
|
1645
1845
|
* @param getRow A function which returns the Row object that will be used to
|
|
1646
1846
|
* update the Store, based on the parameter the callback will receive (and which
|
|
@@ -1656,6 +1856,9 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1656
1856
|
* @param thenDeps An optional array of dependencies for the `then` function,
|
|
1657
1857
|
* which, if any change, result in the regeneration of the callback. This
|
|
1658
1858
|
* parameter defaults to an empty array.
|
|
1859
|
+
* @param reuseRowIds Whether Ids should be recycled from previously deleted Row
|
|
1860
|
+
* objects, defaulting to `true`.
|
|
1861
|
+
*
|
|
1659
1862
|
* @returns A parameterized callback for subsequent use.
|
|
1660
1863
|
* @example
|
|
1661
1864
|
* This example uses the useAddRowCallback hook to create an event handler which
|
|
@@ -1704,6 +1907,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1704
1907
|
storeOrStoreId?: StoreOrStoreId<Schemas>,
|
|
1705
1908
|
then?: (rowId: Id | undefined, store: Store<Schemas>, row: AddRow) => void,
|
|
1706
1909
|
thenDeps?: React.DependencyList,
|
|
1910
|
+
reuseRowIds?: boolean,
|
|
1707
1911
|
) => ParameterizedCallback<Parameter>;
|
|
1708
1912
|
|
|
1709
1913
|
/**
|
|
@@ -1711,6 +1915,20 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1711
1915
|
* be used to set partial data of a single Row in the Store, leaving other Cell
|
|
1712
1916
|
* values unaffected.
|
|
1713
1917
|
*
|
|
1918
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
1919
|
+
*
|
|
1920
|
+
* ```ts override
|
|
1921
|
+
* useSetPartialRowCallback<Parameter>(
|
|
1922
|
+
* tableId: Id,
|
|
1923
|
+
* rowId: Id,
|
|
1924
|
+
* getPartialRow: (parameter: Parameter, store: Store) => Row,
|
|
1925
|
+
* getPartialRowDeps?: React.DependencyList,
|
|
1926
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
1927
|
+
* then?: (store: Store, partialRow: Row) => void,
|
|
1928
|
+
* thenDeps?: React.DependencyList,
|
|
1929
|
+
* ): ParameterizedCallback<Parameter>;
|
|
1930
|
+
* ```
|
|
1931
|
+
*
|
|
1714
1932
|
* This hook is useful, for example, when creating an event handler that will
|
|
1715
1933
|
* mutate the data in Store. In this case, the parameter will likely be the
|
|
1716
1934
|
* event, so that you can use data from it as part of the mutation.
|
|
@@ -1808,6 +2026,21 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1808
2026
|
* The useSetCellCallback hook returns a parameterized callback that can be used
|
|
1809
2027
|
* to set the value of a single Cell in a Store.
|
|
1810
2028
|
*
|
|
2029
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
2030
|
+
*
|
|
2031
|
+
* ```ts override
|
|
2032
|
+
* useSetCellCallback<Parameter>(
|
|
2033
|
+
* tableId: Id,
|
|
2034
|
+
* rowId: Id,
|
|
2035
|
+
* cellId: Id,
|
|
2036
|
+
* getCell: (parameter: Parameter, store: Store) => Cell | MapCell,
|
|
2037
|
+
* getCellDeps?: React.DependencyList,
|
|
2038
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
2039
|
+
* then?: (store: Store, cell: Cell | MapCell) => void,
|
|
2040
|
+
* thenDeps?: React.DependencyList,
|
|
2041
|
+
* ): ParameterizedCallback<Parameter>;
|
|
2042
|
+
* ```
|
|
2043
|
+
*
|
|
1811
2044
|
* This hook is useful, for example, when creating an event handler that will
|
|
1812
2045
|
* mutate the data in the Store. In this case, the parameter will likely be the
|
|
1813
2046
|
* event, so that you can use data from it as part of the mutation.
|
|
@@ -1947,6 +2180,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
1947
2180
|
* The useSetValuesCallback hook returns a parameterized callback that can be
|
|
1948
2181
|
* used to set the keyed value data of a Store.
|
|
1949
2182
|
*
|
|
2183
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
2184
|
+
*
|
|
2185
|
+
* ```ts override
|
|
2186
|
+
* useSetValuesCallback<Parameter>(
|
|
2187
|
+
* getValues: (parameter: Parameter, store: Store) => Values,
|
|
2188
|
+
* getValuesDeps?: React.DependencyList,
|
|
2189
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
2190
|
+
* then?: (store: Store, values: Values) => void,
|
|
2191
|
+
* thenDeps?: React.DependencyList,
|
|
2192
|
+
* ): ParameterizedCallback<Parameter>;
|
|
2193
|
+
* ```
|
|
2194
|
+
*
|
|
1950
2195
|
* This hook is useful, for example, when creating an event handler that will
|
|
1951
2196
|
* mutate the data in the Store. In this case, the parameter will likely be the
|
|
1952
2197
|
* event, so that you can use data from it as part of the mutation.
|
|
@@ -2035,6 +2280,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2035
2280
|
* can be used to set partial Values data in the Store, leaving other Values
|
|
2036
2281
|
* unaffected.
|
|
2037
2282
|
*
|
|
2283
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
2284
|
+
*
|
|
2285
|
+
* ```ts override
|
|
2286
|
+
* useSetPartialValuesCallback<Parameter>(
|
|
2287
|
+
* getPartialValues: (parameter: Parameter, store: Store) => Values,
|
|
2288
|
+
* getPartialValuesDeps?: React.DependencyList,
|
|
2289
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
2290
|
+
* then?: (store: Store, partialValues: Values) => void,
|
|
2291
|
+
* thenDeps?: React.DependencyList,
|
|
2292
|
+
* ): ParameterizedCallback<Parameter>;
|
|
2293
|
+
* ```
|
|
2294
|
+
*
|
|
2038
2295
|
* This hook is useful, for example, when creating an event handler that will
|
|
2039
2296
|
* mutate the data in the Store. In this case, the parameter will likely be the
|
|
2040
2297
|
* event, so that you can use data from it as part of the mutation.
|
|
@@ -2126,6 +2383,19 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2126
2383
|
* The useSetValueCallback hook returns a parameterized callback that can be
|
|
2127
2384
|
* used to set the data of a single Value in a Store.
|
|
2128
2385
|
*
|
|
2386
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
2387
|
+
*
|
|
2388
|
+
* ```ts override
|
|
2389
|
+
* useSetValueCallback<Parameter>(
|
|
2390
|
+
* valueId: Id,
|
|
2391
|
+
* getValue: (parameter: Parameter, store: Store) => Value | MapValue,
|
|
2392
|
+
* getValueDeps?: React.DependencyList,
|
|
2393
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
2394
|
+
* then?: (store: Store, value: Value | MapValue) => void,
|
|
2395
|
+
* thenDeps?: React.DependencyList,
|
|
2396
|
+
* ): ParameterizedCallback<Parameter>;
|
|
2397
|
+
* ```
|
|
2398
|
+
*
|
|
2129
2399
|
* This hook is useful, for example, when creating an event handler that will
|
|
2130
2400
|
* mutate the data in the Store. In this case, the parameter will likely be the
|
|
2131
2401
|
* event, so that you can use data from it as part of the mutation.
|
|
@@ -2220,6 +2490,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2220
2490
|
* The useDelTablesCallback hook returns a callback that can be used to remove
|
|
2221
2491
|
* all of the tabular data in a Store.
|
|
2222
2492
|
*
|
|
2493
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
2494
|
+
*
|
|
2495
|
+
* ```ts override
|
|
2496
|
+
* useDelTablesCallback(
|
|
2497
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
2498
|
+
* then?: (store: Store) => void,
|
|
2499
|
+
* thenDeps?: React.DependencyList,
|
|
2500
|
+
* ): Callback;
|
|
2501
|
+
* ```
|
|
2502
|
+
*
|
|
2223
2503
|
* This hook is useful, for example, when creating an event handler that will
|
|
2224
2504
|
* delete data in a Store.
|
|
2225
2505
|
*
|
|
@@ -2283,6 +2563,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2283
2563
|
* The useDelTableCallback hook returns a callback that can be used to remove a
|
|
2284
2564
|
* single Table from a Store.
|
|
2285
2565
|
*
|
|
2566
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
2567
|
+
*
|
|
2568
|
+
* ```ts override
|
|
2569
|
+
* useDelTableCallback(
|
|
2570
|
+
* tableId: Id,
|
|
2571
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
2572
|
+
* then?: (store: Store) => void,
|
|
2573
|
+
* thenDeps?: React.DependencyList,
|
|
2574
|
+
* ): Callback;
|
|
2575
|
+
* ```
|
|
2576
|
+
*
|
|
2286
2577
|
* This hook is useful, for example, when creating an event handler that will
|
|
2287
2578
|
* delete data in a Store.
|
|
2288
2579
|
*
|
|
@@ -2348,6 +2639,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2348
2639
|
* The useDelRowCallback hook returns a callback that can be used to remove a
|
|
2349
2640
|
* single Row from a Table.
|
|
2350
2641
|
*
|
|
2642
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
2643
|
+
*
|
|
2644
|
+
* ```ts override
|
|
2645
|
+
* useDelRowCallback(
|
|
2646
|
+
* tableId: Id,
|
|
2647
|
+
* rowId: Id,
|
|
2648
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
2649
|
+
* then?: (store: Store) => void,
|
|
2650
|
+
* thenDeps?: React.DependencyList,
|
|
2651
|
+
* ): Callback;
|
|
2652
|
+
* ```
|
|
2653
|
+
*
|
|
2351
2654
|
* This hook is useful, for example, when creating an event handler that will
|
|
2352
2655
|
* delete data in a Store.
|
|
2353
2656
|
*
|
|
@@ -2415,6 +2718,20 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2415
2718
|
* The useDelCellCallback hook returns a callback that can be used to remove a
|
|
2416
2719
|
* single Cell from a Row.
|
|
2417
2720
|
*
|
|
2721
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
2722
|
+
*
|
|
2723
|
+
* ```ts override
|
|
2724
|
+
* useDelCellCallback(
|
|
2725
|
+
* tableId: Id,
|
|
2726
|
+
* rowId: Id,
|
|
2727
|
+
* cellId: Id,
|
|
2728
|
+
* forceDel?: boolean,
|
|
2729
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
2730
|
+
* then?: (store: Store) => void,
|
|
2731
|
+
* thenDeps?: React.DependencyList,
|
|
2732
|
+
* ): Callback;
|
|
2733
|
+
* ```
|
|
2734
|
+
*
|
|
2418
2735
|
* This hook is useful, for example, when creating an event handler that will
|
|
2419
2736
|
* delete data in a Store.
|
|
2420
2737
|
*
|
|
@@ -2496,6 +2813,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2496
2813
|
* The useDelValuesCallback hook returns a callback that can be used to remove
|
|
2497
2814
|
* all of the keyed value data in a Store.
|
|
2498
2815
|
*
|
|
2816
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
2817
|
+
*
|
|
2818
|
+
* ```ts override
|
|
2819
|
+
* useDelValuesCallback(
|
|
2820
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
2821
|
+
* then?: (store: Store) => void,
|
|
2822
|
+
* thenDeps?: React.DependencyList,
|
|
2823
|
+
* ): Callback;
|
|
2824
|
+
* ```
|
|
2825
|
+
*
|
|
2499
2826
|
* This hook is useful, for example, when creating an event handler that will
|
|
2500
2827
|
* delete data in a Store.
|
|
2501
2828
|
*
|
|
@@ -2560,6 +2887,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2560
2887
|
* The useDelValueCallback hook returns a callback that can be used to remove a
|
|
2561
2888
|
* single Value from a Store.
|
|
2562
2889
|
*
|
|
2890
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
2891
|
+
*
|
|
2892
|
+
* ```ts override
|
|
2893
|
+
* useDelValueCallback(
|
|
2894
|
+
* valueId: Id,
|
|
2895
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
2896
|
+
* then?: (store: Store) => void,
|
|
2897
|
+
* thenDeps?: React.DependencyList,
|
|
2898
|
+
* ): Callback;
|
|
2899
|
+
* ```
|
|
2900
|
+
*
|
|
2563
2901
|
* This hook is useful, for example, when creating an event handler that will
|
|
2564
2902
|
* delete data in a Store.
|
|
2565
2903
|
*
|
|
@@ -2626,6 +2964,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2626
2964
|
* The useTablesListener hook registers a listener function with a Store that
|
|
2627
2965
|
* will be called whenever tabular data in it changes.
|
|
2628
2966
|
*
|
|
2967
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
2968
|
+
*
|
|
2969
|
+
* ```ts override
|
|
2970
|
+
* useTablesListener(
|
|
2971
|
+
* listener: TablesListener,
|
|
2972
|
+
* listenerDeps?: React.DependencyList,
|
|
2973
|
+
* mutator?: boolean,
|
|
2974
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
2975
|
+
* ): void;
|
|
2976
|
+
* ```
|
|
2977
|
+
*
|
|
2629
2978
|
* This hook is useful for situations where a component needs to register its
|
|
2630
2979
|
* own specific listener to do more than simply tracking the value (which is
|
|
2631
2980
|
* more easily done with the useTables hook).
|
|
@@ -2688,6 +3037,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2688
3037
|
* The useTableIdsListener hook registers a listener function with a Store that
|
|
2689
3038
|
* will be called whenever the Table Ids in it change.
|
|
2690
3039
|
*
|
|
3040
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
3041
|
+
*
|
|
3042
|
+
* ```ts override
|
|
3043
|
+
* useTableIdsListener(
|
|
3044
|
+
* listener: TableIdsListener,
|
|
3045
|
+
* listenerDeps?: React.DependencyList,
|
|
3046
|
+
* mutator?: boolean,
|
|
3047
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
3048
|
+
* ): void;
|
|
3049
|
+
* ```
|
|
3050
|
+
*
|
|
2691
3051
|
* This hook is useful for situations where a component needs to register its
|
|
2692
3052
|
* own specific listener to do more than simply tracking the value (which is
|
|
2693
3053
|
* more easily done with the useTableIds hook).
|
|
@@ -2751,6 +3111,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2751
3111
|
* The useTableListener hook registers a listener function with a Store that
|
|
2752
3112
|
* will be called whenever data in a Table changes.
|
|
2753
3113
|
*
|
|
3114
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
3115
|
+
*
|
|
3116
|
+
* ```ts override
|
|
3117
|
+
* useTableListener(
|
|
3118
|
+
* tableId: IdOrNull,
|
|
3119
|
+
* listener: TableListener,
|
|
3120
|
+
* listenerDeps?: React.DependencyList,
|
|
3121
|
+
* mutator?: boolean,
|
|
3122
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
3123
|
+
* ): void;
|
|
3124
|
+
* ```
|
|
3125
|
+
*
|
|
2754
3126
|
* This hook is useful for situations where a component needs to register its
|
|
2755
3127
|
* own specific listener to do more than simply tracking the value (which is
|
|
2756
3128
|
* more easily done with the useTable hook).
|
|
@@ -2820,6 +3192,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2820
3192
|
* The useRowIdsListener hook registers a listener function with a Store that
|
|
2821
3193
|
* will be called whenever the Row Ids in a Table change.
|
|
2822
3194
|
*
|
|
3195
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
3196
|
+
*
|
|
3197
|
+
* ```ts override
|
|
3198
|
+
* useRowIdsListener(
|
|
3199
|
+
* tableId: IdOrNull,
|
|
3200
|
+
* listener: RowIdsListener,
|
|
3201
|
+
* listenerDeps?: React.DependencyList,
|
|
3202
|
+
* mutator?: boolean,
|
|
3203
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
3204
|
+
* ): void;
|
|
3205
|
+
* ```
|
|
3206
|
+
*
|
|
2823
3207
|
* This hook is useful for situations where a component needs to register its
|
|
2824
3208
|
* own specific listener to do more than simply tracking the value (which is
|
|
2825
3209
|
* more easily done with the useRowIds hook).
|
|
@@ -2890,6 +3274,22 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2890
3274
|
* that will be called whenever sorted (and optionally, paginated) Row Ids in a
|
|
2891
3275
|
* Table change.
|
|
2892
3276
|
*
|
|
3277
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
3278
|
+
*
|
|
3279
|
+
* ```ts override
|
|
3280
|
+
* useSortedRowIdsListener(
|
|
3281
|
+
* tableId: Id,
|
|
3282
|
+
* cellId: Id | undefined,
|
|
3283
|
+
* descending: boolean,
|
|
3284
|
+
* offset: number,
|
|
3285
|
+
* limit: number | undefined,
|
|
3286
|
+
* listener: SortedRowIdsListener,
|
|
3287
|
+
* listenerDeps?: React.DependencyList,
|
|
3288
|
+
* mutator?: boolean,
|
|
3289
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
3290
|
+
* ): void;
|
|
3291
|
+
* ```
|
|
3292
|
+
*
|
|
2893
3293
|
* This hook is useful for situations where a component needs to register its
|
|
2894
3294
|
* own specific listener to do more than simply tracking the value (which is
|
|
2895
3295
|
* more easily done with the useSortedRowIds hook).
|
|
@@ -2985,6 +3385,19 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
2985
3385
|
* The useRowListener hook registers a listener function with a Store that will
|
|
2986
3386
|
* be called whenever data in a Row changes.
|
|
2987
3387
|
*
|
|
3388
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
3389
|
+
*
|
|
3390
|
+
* ```ts override
|
|
3391
|
+
* useRowListener(
|
|
3392
|
+
* tableId: IdOrNull,
|
|
3393
|
+
* rowId: IdOrNull,
|
|
3394
|
+
* listener: RowListener,
|
|
3395
|
+
* listenerDeps?: React.DependencyList,
|
|
3396
|
+
* mutator?: boolean,
|
|
3397
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
3398
|
+
* ): void;
|
|
3399
|
+
* ```
|
|
3400
|
+
*
|
|
2988
3401
|
* This hook is useful for situations where a component needs to register its
|
|
2989
3402
|
* own specific listener to do more than simply tracking the value (which is
|
|
2990
3403
|
* more easily done with the useRow hook).
|
|
@@ -3063,6 +3476,19 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
3063
3476
|
* The useCellIdsListener hook registers a listener function with a Store that
|
|
3064
3477
|
* will be called whenever the Cell Ids in a Row change.
|
|
3065
3478
|
*
|
|
3479
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
3480
|
+
*
|
|
3481
|
+
* ```ts override
|
|
3482
|
+
* useCellIdsListener(
|
|
3483
|
+
* tableId: IdOrNull,
|
|
3484
|
+
* rowId: IdOrNull,
|
|
3485
|
+
* listener: CellIdsListener,
|
|
3486
|
+
* listenerDeps?: React.DependencyList,
|
|
3487
|
+
* mutator?: boolean,
|
|
3488
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
3489
|
+
* ): void;
|
|
3490
|
+
* ```
|
|
3491
|
+
*
|
|
3066
3492
|
* This hook is useful for situations where a component needs to register its
|
|
3067
3493
|
* own specific listener to do more than simply tracking the value (which is
|
|
3068
3494
|
* more easily done with the useCellIds hook).
|
|
@@ -3144,6 +3570,20 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
3144
3570
|
* The useCellListener hook registers a listener function with a Store that will
|
|
3145
3571
|
* be called whenever data in a Cell changes.
|
|
3146
3572
|
*
|
|
3573
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
3574
|
+
*
|
|
3575
|
+
* ```ts override
|
|
3576
|
+
* useCellListener(
|
|
3577
|
+
* tableId: IdOrNull,
|
|
3578
|
+
* rowId: IdOrNull,
|
|
3579
|
+
* cellId: IdOrNull,
|
|
3580
|
+
* listener: CellListener,
|
|
3581
|
+
* listenerDeps?: React.DependencyList,
|
|
3582
|
+
* mutator?: boolean,
|
|
3583
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
3584
|
+
* ): void;
|
|
3585
|
+
* ```
|
|
3586
|
+
*
|
|
3147
3587
|
* This hook is useful for situations where a component needs to register its
|
|
3148
3588
|
* own specific listener to do more than simply tracking the value (which is
|
|
3149
3589
|
* more easily done with the useCell hook).
|
|
@@ -3231,6 +3671,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
3231
3671
|
* The useValuesListener hook registers a listener function with a Store that
|
|
3232
3672
|
* will be called whenever keyed value data in it changes.
|
|
3233
3673
|
*
|
|
3674
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
3675
|
+
*
|
|
3676
|
+
* ```ts override
|
|
3677
|
+
* useValuesListener(
|
|
3678
|
+
* listener: ValuesListener,
|
|
3679
|
+
* listenerDeps?: React.DependencyList,
|
|
3680
|
+
* mutator?: boolean,
|
|
3681
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
3682
|
+
* ): void;
|
|
3683
|
+
* ```
|
|
3684
|
+
*
|
|
3234
3685
|
* This hook is useful for situations where a component needs to register its
|
|
3235
3686
|
* own specific listener to do more than simply tracking the value (which is
|
|
3236
3687
|
* more easily done with the useValues hook).
|
|
@@ -3294,6 +3745,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
3294
3745
|
* The useValueIdsListener hook registers a listener function with a Store that
|
|
3295
3746
|
* will be called whenever the Value Ids in it change.
|
|
3296
3747
|
*
|
|
3748
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
3749
|
+
*
|
|
3750
|
+
* ```ts override
|
|
3751
|
+
* useValueIdsListener(
|
|
3752
|
+
* listener: ValueIdsListener,
|
|
3753
|
+
* listenerDeps?: React.DependencyList,
|
|
3754
|
+
* mutator?: boolean,
|
|
3755
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
3756
|
+
* ): void;
|
|
3757
|
+
* ```
|
|
3758
|
+
*
|
|
3297
3759
|
* This hook is useful for situations where a component needs to register its
|
|
3298
3760
|
* own specific listener to do more than simply tracking the value (which is
|
|
3299
3761
|
* more easily done with the useValueIds hook).
|
|
@@ -3358,6 +3820,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
3358
3820
|
* The useValueListener hook registers a listener function with a Store that
|
|
3359
3821
|
* will be called whenever data in a Value changes.
|
|
3360
3822
|
*
|
|
3823
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
3824
|
+
*
|
|
3825
|
+
* ```ts override
|
|
3826
|
+
* useValueListener(
|
|
3827
|
+
* valueId: IdOrNull,
|
|
3828
|
+
* listener: ValueListener,
|
|
3829
|
+
* listenerDeps?: React.DependencyList,
|
|
3830
|
+
* mutator?: boolean,
|
|
3831
|
+
* storeOrStoreId?: StoreOrStoreId,
|
|
3832
|
+
* ): void;
|
|
3833
|
+
* ```
|
|
3834
|
+
*
|
|
3361
3835
|
* This hook is useful for situations where a component needs to register its
|
|
3362
3836
|
* own specific listener to do more than simply tracking the value (which is
|
|
3363
3837
|
* more easily done with the useValue hook).
|
|
@@ -3428,6 +3902,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
3428
3902
|
* The useCreateMetrics hook is used to create a Metrics object within a React
|
|
3429
3903
|
* application with convenient memoization.
|
|
3430
3904
|
*
|
|
3905
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
3906
|
+
*
|
|
3907
|
+
* ```ts override
|
|
3908
|
+
* useCreateMetrics(
|
|
3909
|
+
* store: Store,
|
|
3910
|
+
* create: (store: Store) => Metrics,
|
|
3911
|
+
* createDeps?: React.DependencyList,
|
|
3912
|
+
* ): Metrics;
|
|
3913
|
+
* ```
|
|
3914
|
+
*
|
|
3431
3915
|
* It is possible to create a Metrics object outside of the React app with the
|
|
3432
3916
|
* regular createMetrics function and pass it in, but you may prefer to create
|
|
3433
3917
|
* it within the app, perhaps inside the top-level component. To defend against
|
|
@@ -3539,6 +4023,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
3539
4023
|
* The useMetrics hook is used to get a reference to a Metrics object from
|
|
3540
4024
|
* within a Provider component context.
|
|
3541
4025
|
*
|
|
4026
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
4027
|
+
*
|
|
4028
|
+
* ```ts override
|
|
4029
|
+
* useMetrics(id?: Id): Metrics | undefined;
|
|
4030
|
+
* ```
|
|
4031
|
+
*
|
|
3542
4032
|
* A Provider component is used to wrap part of an application in a context. It
|
|
3543
4033
|
* can contain a default Metrics object (or a set of Metrics objects named by
|
|
3544
4034
|
* Id) that can be easily accessed without having to be passed down as props
|
|
@@ -3602,6 +4092,15 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
3602
4092
|
* The useMetric hook gets the current value of a Metric, and registers a
|
|
3603
4093
|
* listener so that any changes to that result will cause a re-render.
|
|
3604
4094
|
*
|
|
4095
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
4096
|
+
*
|
|
4097
|
+
* ```ts override
|
|
4098
|
+
* useMetric(
|
|
4099
|
+
* metricId: Id,
|
|
4100
|
+
* metricsOrMetricsId?: MetricsOrMetricsId,
|
|
4101
|
+
* ): number | undefined;
|
|
4102
|
+
* ```
|
|
4103
|
+
*
|
|
3605
4104
|
* A Provider component is used to wrap part of an application in a context, and
|
|
3606
4105
|
* it can contain a default Metrics object or a set of Metrics objects named by
|
|
3607
4106
|
* Id. The useMetric hook lets you indicate which Metrics object to get data
|
|
@@ -3703,6 +4202,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
3703
4202
|
* The useMetricListener hook registers a listener function with the Metrics
|
|
3704
4203
|
* object that will be called whenever the value of a specified Metric changes.
|
|
3705
4204
|
*
|
|
4205
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
4206
|
+
*
|
|
4207
|
+
* ```ts override
|
|
4208
|
+
* useMetricListener(
|
|
4209
|
+
* metricId: IdOrNull,
|
|
4210
|
+
* listener: MetricListener,
|
|
4211
|
+
* listenerDeps?: React.DependencyList,
|
|
4212
|
+
* metricsOrMetricsId?: MetricsOrMetricsId,
|
|
4213
|
+
* ): void;
|
|
4214
|
+
* ```
|
|
4215
|
+
*
|
|
3706
4216
|
* This hook is useful for situations where a component needs to register its
|
|
3707
4217
|
* own specific listener to do more than simply tracking the value (which is
|
|
3708
4218
|
* more easily done with the useMetric hook).
|
|
@@ -3775,6 +4285,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
3775
4285
|
* The useCreateIndexes hook is used to create an Indexes object within a React
|
|
3776
4286
|
* application with convenient memoization.
|
|
3777
4287
|
*
|
|
4288
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
4289
|
+
*
|
|
4290
|
+
* ```ts override
|
|
4291
|
+
* useCreateIndexes(
|
|
4292
|
+
* store: Store,
|
|
4293
|
+
* create: (store: Store) => Indexes,
|
|
4294
|
+
* createDeps?: React.DependencyList,
|
|
4295
|
+
* ): Indexes;
|
|
4296
|
+
* ```
|
|
4297
|
+
*
|
|
3778
4298
|
* It is possible to create an Indexes object outside of the React app with the
|
|
3779
4299
|
* regular createIndexes function and pass it in, but you may prefer to create
|
|
3780
4300
|
* it within the app, perhaps inside the top-level component. To defend against
|
|
@@ -3894,6 +4414,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
3894
4414
|
* The useIndexes hook is used to get a reference to an Indexes object from
|
|
3895
4415
|
* within a Provider component context.
|
|
3896
4416
|
*
|
|
4417
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
4418
|
+
*
|
|
4419
|
+
* ```ts override
|
|
4420
|
+
* useIndexes(id?: Id): Indexes | undefined;
|
|
4421
|
+
* ```
|
|
4422
|
+
*
|
|
3897
4423
|
* A Provider component is used to wrap part of an application in a context. It
|
|
3898
4424
|
* can contain a default Indexes object (or a set of Indexes objects named by
|
|
3899
4425
|
* Id) that can be easily accessed without having to be passed down as props
|
|
@@ -3957,6 +4483,15 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
3957
4483
|
* The useSliceIds hook gets the list of Slice Ids in an Index, and registers a
|
|
3958
4484
|
* listener so that any changes to that result will cause a re-render.
|
|
3959
4485
|
*
|
|
4486
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
4487
|
+
*
|
|
4488
|
+
* ```ts override
|
|
4489
|
+
* useSliceIds(
|
|
4490
|
+
* indexId: Id,
|
|
4491
|
+
* indexesOrIndexesId?: IndexesOrIndexesId,
|
|
4492
|
+
* ): Ids;
|
|
4493
|
+
* ```
|
|
4494
|
+
*
|
|
3960
4495
|
* A Provider component is used to wrap part of an application in a context, and
|
|
3961
4496
|
* it can contain a default Indexes object or a set of Indexes objects named by
|
|
3962
4497
|
* Id. The useSliceIds hook lets you indicate which Indexes object to get data
|
|
@@ -4063,6 +4598,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
4063
4598
|
* registers a listener so that any changes to that result will cause a
|
|
4064
4599
|
* re-render.
|
|
4065
4600
|
*
|
|
4601
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
4602
|
+
*
|
|
4603
|
+
* ```ts override
|
|
4604
|
+
* useSliceRowIds(
|
|
4605
|
+
* indexId: Id,
|
|
4606
|
+
* sliceId: Id,
|
|
4607
|
+
* indexesOrIndexesId?: IndexesOrIndexesId,
|
|
4608
|
+
* ): Ids;
|
|
4609
|
+
* ```
|
|
4610
|
+
*
|
|
4066
4611
|
* A Provider component is used to wrap part of an application in a context, and
|
|
4067
4612
|
* it can contain a default Indexes object or a set of Indexes objects named by
|
|
4068
4613
|
* Id. The useSliceRowIds hook lets you indicate which Indexes object to get
|
|
@@ -4176,6 +4721,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
4176
4721
|
* The useSliceIdsListener hook registers a listener function with the Indexes
|
|
4177
4722
|
* object that will be called whenever the Slice Ids in an Index change.
|
|
4178
4723
|
*
|
|
4724
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
4725
|
+
*
|
|
4726
|
+
* ```ts override
|
|
4727
|
+
* useSliceIdsListener(
|
|
4728
|
+
* indexId: IdOrNull,
|
|
4729
|
+
* listener: SliceIdsListener,
|
|
4730
|
+
* listenerDeps?: React.DependencyList,
|
|
4731
|
+
* indexesOrIndexesId?: IndexesOrIndexesId,
|
|
4732
|
+
* ): void;
|
|
4733
|
+
* ```
|
|
4734
|
+
*
|
|
4179
4735
|
* This hook is useful for situations where a component needs to register its
|
|
4180
4736
|
* own specific listener to do more than simply tracking the value (which is
|
|
4181
4737
|
* more easily done with the useSliceIds hook).
|
|
@@ -4249,6 +4805,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
4249
4805
|
* The useSliceRowIdsListener hook registers a listener function with the
|
|
4250
4806
|
* Indexes object that will be called whenever the Row Ids in a Slice change.
|
|
4251
4807
|
*
|
|
4808
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
4809
|
+
*
|
|
4810
|
+
* ```ts override
|
|
4811
|
+
* useSliceRowIdsListener(
|
|
4812
|
+
* indexId: IdOrNull,
|
|
4813
|
+
* sliceId: IdOrNull,
|
|
4814
|
+
* listener: SliceRowIdsListener,
|
|
4815
|
+
* listenerDeps?: React.DependencyList,
|
|
4816
|
+
* indexesOrIndexesId?: IndexesOrIndexesId,
|
|
4817
|
+
* ): void;
|
|
4818
|
+
* ```
|
|
4819
|
+
*
|
|
4252
4820
|
* This hook is useful for situations where a component needs to register its
|
|
4253
4821
|
* own specific listener to do more than simply tracking the value (which is
|
|
4254
4822
|
* more easily done with the useSliceRowIds hook).
|
|
@@ -4331,6 +4899,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
4331
4899
|
* The useCreateRelationships hook is used to create a Relationships object
|
|
4332
4900
|
* within a React application with convenient memoization.
|
|
4333
4901
|
*
|
|
4902
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
4903
|
+
*
|
|
4904
|
+
* ```ts override
|
|
4905
|
+
* useCreateRelationships(
|
|
4906
|
+
* store: Store,
|
|
4907
|
+
* create: (store: Store) => Relationships,
|
|
4908
|
+
* createDeps?: React.DependencyList,
|
|
4909
|
+
* ): Relationships;
|
|
4910
|
+
* ```
|
|
4911
|
+
*
|
|
4334
4912
|
* It is possible to create a Relationships object outside of the React app with
|
|
4335
4913
|
* the regular createRelationships function and pass it in, but you may prefer
|
|
4336
4914
|
* to create it within the app, perhaps inside the top-level component. To
|
|
@@ -4458,6 +5036,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
4458
5036
|
* The useRelationships hook is used to get a reference to a Relationships
|
|
4459
5037
|
* object from within a Provider component context.
|
|
4460
5038
|
*
|
|
5039
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
5040
|
+
*
|
|
5041
|
+
* ```ts override
|
|
5042
|
+
* useRelationships(id?: Id): Relationships | undefined;
|
|
5043
|
+
* ```
|
|
5044
|
+
*
|
|
4461
5045
|
* A Provider component is used to wrap part of an application in a context. It
|
|
4462
5046
|
* can contain a default Relationships object (or a set of Relationships objects
|
|
4463
5047
|
* named by Id) that can be easily accessed without having to be passed down as
|
|
@@ -4530,6 +5114,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
4530
5114
|
* Relationship, and registers a listener so that any changes to that result
|
|
4531
5115
|
* will cause a re-render.
|
|
4532
5116
|
*
|
|
5117
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
5118
|
+
*
|
|
5119
|
+
* ```ts override
|
|
5120
|
+
* useRemoteRowId(
|
|
5121
|
+
* relationshipId: Id,
|
|
5122
|
+
* localRowId: Id,
|
|
5123
|
+
* relationshipsOrRelationshipsId?: RelationshipsOrRelationshipsId,
|
|
5124
|
+
* ): Id | undefined;
|
|
5125
|
+
* ```
|
|
5126
|
+
*
|
|
4533
5127
|
* A Provider component is used to wrap part of an application in a context, and
|
|
4534
5128
|
* it can contain a default Relationships object or a set of Relationships
|
|
4535
5129
|
* objects named by Id. The useRemoteRowId hook lets you indicate which
|
|
@@ -4639,6 +5233,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
4639
5233
|
* Relationship, and registers a listener so that any changes to that result
|
|
4640
5234
|
* will cause a re-render.
|
|
4641
5235
|
*
|
|
5236
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
5237
|
+
*
|
|
5238
|
+
* ```ts override
|
|
5239
|
+
* useLocalRowIds(
|
|
5240
|
+
* relationshipId: Id,
|
|
5241
|
+
* remoteRowId: Id,
|
|
5242
|
+
* relationshipsOrRelationshipsId?: RelationshipsOrRelationshipsId,
|
|
5243
|
+
* ): Ids;
|
|
5244
|
+
* ```
|
|
5245
|
+
*
|
|
4642
5246
|
* A Provider component is used to wrap part of an application in a context, and
|
|
4643
5247
|
* it can contain a default Relationships object or a set of Relationships
|
|
4644
5248
|
* objects named by Id. The useLocalRowIds hook lets you indicate which
|
|
@@ -4756,6 +5360,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
4756
5360
|
* list Relationship, and registers a listener so that any changes to that
|
|
4757
5361
|
* result will cause a re-render.
|
|
4758
5362
|
*
|
|
5363
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
5364
|
+
*
|
|
5365
|
+
* ```ts override
|
|
5366
|
+
* useLinkedRowIds(
|
|
5367
|
+
* relationshipId: Id,
|
|
5368
|
+
* firstRowId: Id,
|
|
5369
|
+
* relationshipsOrRelationshipsId?: RelationshipsOrRelationshipsId,
|
|
5370
|
+
* ): Ids;
|
|
5371
|
+
* ```
|
|
5372
|
+
*
|
|
4759
5373
|
* A Provider component is used to wrap part of an application in a context, and
|
|
4760
5374
|
* it can contain a default Relationships object or a set of Relationships
|
|
4761
5375
|
* objects named by Id. The useLinkedRowIds hook lets you indicate which
|
|
@@ -4880,6 +5494,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
4880
5494
|
* Relationships object that will be called whenever a remote Row Id in a
|
|
4881
5495
|
* Relationship changes.
|
|
4882
5496
|
*
|
|
5497
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
5498
|
+
*
|
|
5499
|
+
* ```ts override
|
|
5500
|
+
* useRemoteRowIdListener(
|
|
5501
|
+
* relationshipId: IdOrNull,
|
|
5502
|
+
* localRowId: IdOrNull,
|
|
5503
|
+
* listener: RemoteRowIdListener,
|
|
5504
|
+
* listenerDeps?: React.DependencyList,
|
|
5505
|
+
* relationshipsOrRelationshipsId?: RelationshipsOrRelationshipsId,
|
|
5506
|
+
* ): void;
|
|
5507
|
+
* ```
|
|
5508
|
+
*
|
|
4883
5509
|
* This hook is useful for situations where a component needs to register its
|
|
4884
5510
|
* own specific listener to do more than simply tracking the value (which is
|
|
4885
5511
|
* more easily done with the useRemoteRowId hook).
|
|
@@ -4969,6 +5595,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
4969
5595
|
* Relationships object that will be called whenever the local Row Ids in a
|
|
4970
5596
|
* Relationship change.
|
|
4971
5597
|
*
|
|
5598
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
5599
|
+
*
|
|
5600
|
+
* ```ts override
|
|
5601
|
+
* useLocalRowIdsListener(
|
|
5602
|
+
* relationshipId: IdOrNull,
|
|
5603
|
+
* remoteRowId: IdOrNull,
|
|
5604
|
+
* listener: LocalRowIdsListener,
|
|
5605
|
+
* listenerDeps?: React.DependencyList,
|
|
5606
|
+
* relationshipsOrRelationshipsId?: RelationshipsOrRelationshipsId,
|
|
5607
|
+
* ): void;
|
|
5608
|
+
* ```
|
|
5609
|
+
*
|
|
4972
5610
|
* This hook is useful for situations where a component needs to register its
|
|
4973
5611
|
* own specific listener to do more than simply tracking the value (which is
|
|
4974
5612
|
* more easily done with the useLocalRowsId hook).
|
|
@@ -5058,6 +5696,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
5058
5696
|
* Relationships object that will be called whenever the linked Row Ids in a
|
|
5059
5697
|
* Relationship change.
|
|
5060
5698
|
*
|
|
5699
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
5700
|
+
*
|
|
5701
|
+
* ```ts override
|
|
5702
|
+
* useLinkedRowIdsListener(
|
|
5703
|
+
* relationshipId: Id,
|
|
5704
|
+
* firstRowId: Id,
|
|
5705
|
+
* listener: LinkedRowIdsListener,
|
|
5706
|
+
* listenerDeps?: React.DependencyList,
|
|
5707
|
+
* relationshipsOrRelationshipsId?: RelationshipsOrRelationshipsId,
|
|
5708
|
+
* ): void;
|
|
5709
|
+
* ```
|
|
5710
|
+
*
|
|
5061
5711
|
* This hook is useful for situations where a component needs to register its
|
|
5062
5712
|
* own specific listener to do more than simply tracking the value (which is
|
|
5063
5713
|
* more easily done with the useLinkedRowsId hook).
|
|
@@ -5143,6 +5793,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
5143
5793
|
* The useCreateQueries hook is used to create a Queries object within a React
|
|
5144
5794
|
* application with convenient memoization.
|
|
5145
5795
|
*
|
|
5796
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
5797
|
+
*
|
|
5798
|
+
* ```ts override
|
|
5799
|
+
* useCreateQueries(
|
|
5800
|
+
* store: Store,
|
|
5801
|
+
* create: (store: Store) => Queries,
|
|
5802
|
+
* createDeps?: React.DependencyList,
|
|
5803
|
+
* ): Queries;
|
|
5804
|
+
* ```
|
|
5805
|
+
*
|
|
5146
5806
|
* It is possible to create a Queries object outside of the React app with the
|
|
5147
5807
|
* regular createQueries function and pass it in, but you may prefer to create
|
|
5148
5808
|
* it within the app, perhaps inside the top-level component. To defend against
|
|
@@ -5265,6 +5925,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
5265
5925
|
* The useQueries hook is used to get a reference to a Queries object from
|
|
5266
5926
|
* within a Provider component context.
|
|
5267
5927
|
*
|
|
5928
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
5929
|
+
*
|
|
5930
|
+
* ```ts override
|
|
5931
|
+
* useQueries(id?: Id): Queries | undefined;
|
|
5932
|
+
* ```
|
|
5933
|
+
*
|
|
5268
5934
|
* A Provider component is used to wrap part of an application in a context. It
|
|
5269
5935
|
* can contain a default Queries object (or a set of Queries objects named by
|
|
5270
5936
|
* Id) that can be easily accessed without having to be passed down as props
|
|
@@ -5330,6 +5996,15 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
5330
5996
|
* result Table of the given query, and registers a listener so that any changes
|
|
5331
5997
|
* to that result will cause a re-render.
|
|
5332
5998
|
*
|
|
5999
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
6000
|
+
*
|
|
6001
|
+
* ```ts override
|
|
6002
|
+
* useResultTable(
|
|
6003
|
+
* queryId: Id,
|
|
6004
|
+
* queriesOrQueriesId?: QueriesOrQueriesId,
|
|
6005
|
+
* ): Table;
|
|
6006
|
+
* ```
|
|
6007
|
+
*
|
|
5333
6008
|
* A Provider component is used to wrap part of an application in a context, and
|
|
5334
6009
|
* it can contain a default Queries object or a set of Queries objects named by
|
|
5335
6010
|
* Id. The useResultTable hook lets you indicate which Queries object to get
|
|
@@ -5450,6 +6125,15 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
5450
6125
|
* the given query, and registers a listener so that any changes to those Ids
|
|
5451
6126
|
* will cause a re-render.
|
|
5452
6127
|
*
|
|
6128
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
6129
|
+
*
|
|
6130
|
+
* ```ts override
|
|
6131
|
+
* useResultRowIds(
|
|
6132
|
+
* queryId: Id,
|
|
6133
|
+
* queriesOrQueriesId?: QueriesOrQueriesId,
|
|
6134
|
+
* ): Ids;
|
|
6135
|
+
* ```
|
|
6136
|
+
*
|
|
5453
6137
|
* A Provider component is used to wrap part of an application in a context, and
|
|
5454
6138
|
* it can contain a default Queries object or a set of Queries objects named by
|
|
5455
6139
|
* Id. The useResultRowIds hook lets you indicate which Queries object to get
|
|
@@ -5571,6 +6255,19 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
5571
6255
|
* Ids of every Row in the result Table of the given query, and registers a
|
|
5572
6256
|
* listener so that any changes to those Ids will cause a re-render.
|
|
5573
6257
|
*
|
|
6258
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
6259
|
+
*
|
|
6260
|
+
* ```ts override
|
|
6261
|
+
* useResultSortedRowIds(
|
|
6262
|
+
* queryId: Id,
|
|
6263
|
+
* cellId?: Id,
|
|
6264
|
+
* descending?: boolean,
|
|
6265
|
+
* offset?: number,
|
|
6266
|
+
* limit?: number,
|
|
6267
|
+
* queriesOrQueriesId?: QueriesOrQueriesId,
|
|
6268
|
+
* ): Ids;
|
|
6269
|
+
* ```
|
|
6270
|
+
*
|
|
5574
6271
|
* A Provider component is used to wrap part of an application in a context, and
|
|
5575
6272
|
* it can contain a default Queries object or a set of Queries objects named by
|
|
5576
6273
|
* Id. The useResultSortedRowIds hook lets you indicate which Queries object to
|
|
@@ -5724,6 +6421,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
5724
6421
|
* single Row in the result Table of the given query, and registers a listener
|
|
5725
6422
|
* so that any changes to that Row will cause a re-render.
|
|
5726
6423
|
*
|
|
6424
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
6425
|
+
*
|
|
6426
|
+
* ```ts override
|
|
6427
|
+
* useResultRow(
|
|
6428
|
+
* queryId: Id,
|
|
6429
|
+
* rowId: Id,
|
|
6430
|
+
* queriesOrQueriesId?: QueriesOrQueriesId,
|
|
6431
|
+
* ): Row;
|
|
6432
|
+
* ```
|
|
6433
|
+
*
|
|
5727
6434
|
* A Provider component is used to wrap part of an application in a context, and
|
|
5728
6435
|
* it can contain a default Queries object or a set of Queries objects named by
|
|
5729
6436
|
* Id. The useResultRow hook lets you indicate which Queries object to get data
|
|
@@ -5849,6 +6556,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
5849
6556
|
* result Table of the given query, and registers a listener so that any changes
|
|
5850
6557
|
* to those Ids will cause a re-render.
|
|
5851
6558
|
*
|
|
6559
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
6560
|
+
*
|
|
6561
|
+
* ```ts override
|
|
6562
|
+
* useResultCellIds(
|
|
6563
|
+
* queryId: Id,
|
|
6564
|
+
* rowId: Id,
|
|
6565
|
+
* queriesOrQueriesId?: QueriesOrQueriesId,
|
|
6566
|
+
* ): Ids;
|
|
6567
|
+
* ```
|
|
6568
|
+
*
|
|
5852
6569
|
* A Provider component is used to wrap part of an application in a context, and
|
|
5853
6570
|
* it can contain a default Queries object or a set of Queries objects named by
|
|
5854
6571
|
* Id. The useResultCellIds hook lets you indicate which Queries object to get
|
|
@@ -5980,6 +6697,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
5980
6697
|
* the result Table of the given query, and registers a listener so that any
|
|
5981
6698
|
* changes to that value will cause a re-render.
|
|
5982
6699
|
*
|
|
6700
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
6701
|
+
*
|
|
6702
|
+
* ```ts override
|
|
6703
|
+
* useResultCell(
|
|
6704
|
+
* queryId: Id,
|
|
6705
|
+
* rowId: Id,
|
|
6706
|
+
* cellId: Id,
|
|
6707
|
+
* queriesOrQueriesId?: QueriesOrQueriesId,
|
|
6708
|
+
* ): Cell | undefined;
|
|
6709
|
+
* ```
|
|
6710
|
+
*
|
|
5983
6711
|
* A Provider component is used to wrap part of an application in a context, and
|
|
5984
6712
|
* it can contain a default Queries object or a set of Queries objects named by
|
|
5985
6713
|
* Id. The useResultCell hook lets you indicate which Queries object to get data
|
|
@@ -6107,6 +6835,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
6107
6835
|
* The useResultTableListener hook registers a listener function with a Queries
|
|
6108
6836
|
* object that will be called whenever data in a result Table changes.
|
|
6109
6837
|
*
|
|
6838
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
6839
|
+
*
|
|
6840
|
+
* ```ts override
|
|
6841
|
+
* useResultTableListener(
|
|
6842
|
+
* queryId: IdOrNull,
|
|
6843
|
+
* listener: ResultTableListener,
|
|
6844
|
+
* listenerDeps?: React.DependencyList,
|
|
6845
|
+
* queriesOrQueriesId?: QueriesOrQueriesId,
|
|
6846
|
+
* ): void;
|
|
6847
|
+
* ```
|
|
6848
|
+
*
|
|
6110
6849
|
* This hook is useful for situations where a component needs to register its
|
|
6111
6850
|
* own specific listener to do more than simply tracking the value (which is
|
|
6112
6851
|
* more easily done with the useResultTable hook).
|
|
@@ -6185,6 +6924,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
6185
6924
|
* The useResultRowIdsListener hook registers a listener function with a Queries
|
|
6186
6925
|
* object that will be called whenever the Row Ids in a result Table change.
|
|
6187
6926
|
*
|
|
6927
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
6928
|
+
*
|
|
6929
|
+
* ```ts override
|
|
6930
|
+
* useResultRowIdsListener(
|
|
6931
|
+
* queryId: IdOrNull,
|
|
6932
|
+
* listener: ResultRowIdsListener,
|
|
6933
|
+
* listenerDeps?: React.DependencyList,
|
|
6934
|
+
* queriesOrQueriesId?: QueriesOrQueriesId,
|
|
6935
|
+
* ): void;
|
|
6936
|
+
* ```
|
|
6937
|
+
*
|
|
6188
6938
|
* This hook is useful for situations where a component needs to register its
|
|
6189
6939
|
* own specific listener to do more than simply tracking the value (which is
|
|
6190
6940
|
* more easily done with the useResultRowIds hook).
|
|
@@ -6264,6 +7014,21 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
6264
7014
|
* Queries object that will be called whenever the sorted (and optionally,
|
|
6265
7015
|
* paginated) Row Ids in a result Table change.
|
|
6266
7016
|
*
|
|
7017
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
7018
|
+
*
|
|
7019
|
+
* ```ts override
|
|
7020
|
+
* useResultSortedRowIdsListener(
|
|
7021
|
+
* queryId: Id,
|
|
7022
|
+
* cellId: Id | undefined,
|
|
7023
|
+
* descending: boolean,
|
|
7024
|
+
* offset: number,
|
|
7025
|
+
* limit: number | undefined,
|
|
7026
|
+
* listener: ResultRowIdsListener,
|
|
7027
|
+
* listenerDeps?: React.DependencyList,
|
|
7028
|
+
* queriesOrQueriesId?: QueriesOrQueriesId,
|
|
7029
|
+
* ): void;
|
|
7030
|
+
* ```
|
|
7031
|
+
*
|
|
6267
7032
|
* This hook is useful for situations where a component needs to register its
|
|
6268
7033
|
* own specific listener to do more than simply tracking the value (which is
|
|
6269
7034
|
* more easily done with the useResultSortedRowIds hook).
|
|
@@ -6352,6 +7117,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
6352
7117
|
* The useResultRowListener hook registers a listener function with a Queries
|
|
6353
7118
|
* object that will be called whenever data in a result Row changes.
|
|
6354
7119
|
*
|
|
7120
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
7121
|
+
*
|
|
7122
|
+
* ```ts override
|
|
7123
|
+
* useResultRowListener(
|
|
7124
|
+
* queryId: IdOrNull,
|
|
7125
|
+
* rowId: IdOrNull,
|
|
7126
|
+
* listener: ResultRowListener,
|
|
7127
|
+
* listenerDeps?: React.DependencyList,
|
|
7128
|
+
* queriesOrQueriesId?: QueriesOrQueriesId,
|
|
7129
|
+
* ): void;
|
|
7130
|
+
* ```
|
|
7131
|
+
*
|
|
6355
7132
|
* This hook is useful for situations where a component needs to register its
|
|
6356
7133
|
* own specific listener to do more than simply tracking the value (which is
|
|
6357
7134
|
* more easily done with the useResultRow hook).
|
|
@@ -6438,6 +7215,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
6438
7215
|
* Queries object that will be called whenever the Cell Ids in a result Row
|
|
6439
7216
|
* change.
|
|
6440
7217
|
*
|
|
7218
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
7219
|
+
*
|
|
7220
|
+
* ```ts override
|
|
7221
|
+
* useResultCellIdsListener(
|
|
7222
|
+
* queryId: IdOrNull,
|
|
7223
|
+
* rowId: IdOrNull,
|
|
7224
|
+
* listener: ResultCellIdsListener,
|
|
7225
|
+
* listenerDeps?: React.DependencyList,
|
|
7226
|
+
* queriesOrQueriesId?: QueriesOrQueriesId,
|
|
7227
|
+
* ): void;
|
|
7228
|
+
* ```
|
|
7229
|
+
*
|
|
6441
7230
|
* This hook is useful for situations where a component needs to register its
|
|
6442
7231
|
* own specific listener to do more than simply tracking the value (which is
|
|
6443
7232
|
* more easily done with the useResultCellIds hook).
|
|
@@ -6522,6 +7311,19 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
6522
7311
|
* The useResultCellListener hook registers a listener function with a Queries
|
|
6523
7312
|
* object that will be called whenever data in a Cell changes.
|
|
6524
7313
|
*
|
|
7314
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
7315
|
+
*
|
|
7316
|
+
* ```ts override
|
|
7317
|
+
* useResultCellListener(
|
|
7318
|
+
* queryId: IdOrNull,
|
|
7319
|
+
* rowId: IdOrNull,
|
|
7320
|
+
* cellId: IdOrNull,
|
|
7321
|
+
* listener: ResultCellListener,
|
|
7322
|
+
* listenerDeps?: React.DependencyList,
|
|
7323
|
+
* queriesOrQueriesId?: QueriesOrQueriesId,
|
|
7324
|
+
* ): void;
|
|
7325
|
+
* ```
|
|
7326
|
+
*
|
|
6525
7327
|
* This hook is useful for situations where a component needs to register its
|
|
6526
7328
|
* own specific listener to do more than simply tracking the value (which is
|
|
6527
7329
|
* more easily done with the useResultCell hook).
|
|
@@ -6610,6 +7412,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
6610
7412
|
* The useCreateCheckpoints hook is used to create a Checkpoints object within a
|
|
6611
7413
|
* React application with convenient memoization.
|
|
6612
7414
|
*
|
|
7415
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
7416
|
+
*
|
|
7417
|
+
* ```ts override
|
|
7418
|
+
* useCreateCheckpoints(
|
|
7419
|
+
* store: Store,
|
|
7420
|
+
* create: (store: Store) => Checkpoints,
|
|
7421
|
+
* createDeps?: React.DependencyList,
|
|
7422
|
+
* ): Checkpoints;
|
|
7423
|
+
* ```
|
|
7424
|
+
*
|
|
6613
7425
|
* It is possible to create a Checkpoints object outside of the React app with
|
|
6614
7426
|
* the regular createCheckpoints function and pass it in, but you may prefer to
|
|
6615
7427
|
* create it within the app, perhaps inside the top-level component. To defend
|
|
@@ -6711,6 +7523,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
6711
7523
|
* The useCheckpoints hook is used to get a reference to a Checkpoints object
|
|
6712
7524
|
* from within a Provider component context.
|
|
6713
7525
|
*
|
|
7526
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
7527
|
+
*
|
|
7528
|
+
* ```ts override
|
|
7529
|
+
* useCheckpoints(id?: Id): Checkpoints | undefined;
|
|
7530
|
+
* ```
|
|
7531
|
+
*
|
|
6714
7532
|
* A Provider component is used to wrap part of an application in a context. It
|
|
6715
7533
|
* can contain a default Checkpoints object (or a set of Checkpoints objects
|
|
6716
7534
|
* named by Id) that can be easily accessed without having to be passed down as
|
|
@@ -6781,6 +7599,14 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
6781
7599
|
* managed by this Checkpoints object, and registers a listener so that any
|
|
6782
7600
|
* changes to that result will cause a re-render.
|
|
6783
7601
|
*
|
|
7602
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
7603
|
+
*
|
|
7604
|
+
* ```ts override
|
|
7605
|
+
* useCheckpointIds(
|
|
7606
|
+
* checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId,
|
|
7607
|
+
* ): CheckpointIds;
|
|
7608
|
+
* ```
|
|
7609
|
+
*
|
|
6784
7610
|
*
|
|
6785
7611
|
* A Provider component is used to wrap part of an application in a context, and
|
|
6786
7612
|
* it can contain a default Checkpoints object or a set of Checkpoints objects
|
|
@@ -6881,6 +7707,15 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
6881
7707
|
* The useCheckpoint hook returns the label for a checkpoint, and registers a
|
|
6882
7708
|
* listener so that any changes to that result will cause a re-render.
|
|
6883
7709
|
*
|
|
7710
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
7711
|
+
*
|
|
7712
|
+
* ```ts override
|
|
7713
|
+
* useCheckpoint(
|
|
7714
|
+
* checkpointId: Id,
|
|
7715
|
+
* checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId,
|
|
7716
|
+
* ): string | undefined;
|
|
7717
|
+
* ```
|
|
7718
|
+
*
|
|
6884
7719
|
* A Provider component is used to wrap part of an application in a context, and
|
|
6885
7720
|
* it can contain a default Checkpoints object or a set of Checkpoints objects
|
|
6886
7721
|
* named by Id. The useCheckpoint hook lets you indicate which Checkpoints
|
|
@@ -6976,6 +7811,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
6976
7811
|
* be used to record a checkpoint of a Store into a Checkpoints object that can
|
|
6977
7812
|
* be reverted to in the future.
|
|
6978
7813
|
*
|
|
7814
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
7815
|
+
*
|
|
7816
|
+
* ```ts override
|
|
7817
|
+
* useSetCheckpointCallback<Parameter>(
|
|
7818
|
+
* getCheckpoint?: (parameter: Parameter) => string,
|
|
7819
|
+
* getCheckpointDeps?: React.DependencyList,
|
|
7820
|
+
* checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId,
|
|
7821
|
+
* then?: (checkpointId: Id, checkpoints: Checkpoints, label?: string) => void,
|
|
7822
|
+
* thenDeps?: React.DependencyList,
|
|
7823
|
+
* ): ParameterizedCallback<Parameter>;
|
|
7824
|
+
* ```
|
|
7825
|
+
*
|
|
6979
7826
|
* This hook is useful, for example, when creating an event handler that will
|
|
6980
7827
|
* set the checkpoint. In this case, the parameter will likely be the event, so
|
|
6981
7828
|
* that you can use data from it as the checkpoint label.
|
|
@@ -7063,6 +7910,14 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
7063
7910
|
* underlying Store back to the previous checkpoint, effectively performing an
|
|
7064
7911
|
* 'undo' on the Store data.
|
|
7065
7912
|
*
|
|
7913
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
7914
|
+
*
|
|
7915
|
+
* ```ts override
|
|
7916
|
+
* useGoBackwardCallback(
|
|
7917
|
+
* checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId,
|
|
7918
|
+
* ): Callback;
|
|
7919
|
+
* ```
|
|
7920
|
+
*
|
|
7066
7921
|
* This hook is useful, for example, when creating an event handler that will go
|
|
7067
7922
|
* backward to the previous checkpoint - such as when clicking an undo button.
|
|
7068
7923
|
*
|
|
@@ -7111,6 +7966,14 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
7111
7966
|
* underlying Store forwards to a future checkpoint, effectively performing an
|
|
7112
7967
|
* 'redo' on the Store data.
|
|
7113
7968
|
*
|
|
7969
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
7970
|
+
*
|
|
7971
|
+
* ```ts override
|
|
7972
|
+
* useGoForwardCallback(
|
|
7973
|
+
* checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId,
|
|
7974
|
+
* ): Callback;
|
|
7975
|
+
* ```
|
|
7976
|
+
*
|
|
7114
7977
|
* This hook is useful, for example, when creating an event handler that will go
|
|
7115
7978
|
* forward to the next checkpoint - such as when clicking an redo button.
|
|
7116
7979
|
*
|
|
@@ -7163,6 +8026,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
7163
8026
|
* move the state of the underlying Store backwards or forwards to a specified
|
|
7164
8027
|
* checkpoint.
|
|
7165
8028
|
*
|
|
8029
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
8030
|
+
*
|
|
8031
|
+
* ```ts override
|
|
8032
|
+
* useGoToCallback<Parameter>(
|
|
8033
|
+
* getCheckpointId: (parameter: Parameter) => Id,
|
|
8034
|
+
* getCheckpointIdDeps?: React.DependencyList,
|
|
8035
|
+
* checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId,
|
|
8036
|
+
* then?: (checkpoints: Checkpoints, checkpointId: Id) => void,
|
|
8037
|
+
* thenDeps?: React.DependencyList,
|
|
8038
|
+
* ): ParameterizedCallback<Parameter>;
|
|
8039
|
+
* ```
|
|
8040
|
+
*
|
|
7166
8041
|
* This hook is useful, for example, when creating an event handler that will
|
|
7167
8042
|
* move the checkpoint. In this case, the parameter will likely be the event, so
|
|
7168
8043
|
* that you can use data from it as the checkpoint Id to move to.
|
|
@@ -7243,6 +8118,14 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
7243
8118
|
* indicates if and how you can move the state of the underlying Store backward
|
|
7244
8119
|
* to the previous checkpoint.
|
|
7245
8120
|
*
|
|
8121
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
8122
|
+
*
|
|
8123
|
+
* ```ts override
|
|
8124
|
+
* useUndoInformation(
|
|
8125
|
+
* checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId,
|
|
8126
|
+
* ): UndoOrRedoInformation;
|
|
8127
|
+
* ```
|
|
8128
|
+
*
|
|
7246
8129
|
* This hook is useful if you are building an undo button: the information
|
|
7247
8130
|
* contains whether an undo action is available (to enable the button), the
|
|
7248
8131
|
* callback to perform the undo action, the current checkpoint Id that will be
|
|
@@ -7289,6 +8172,14 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
7289
8172
|
* indicates if and how you can move the state of the underlying Store forwards
|
|
7290
8173
|
* to a future checkpoint.
|
|
7291
8174
|
*
|
|
8175
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
8176
|
+
*
|
|
8177
|
+
* ```ts override
|
|
8178
|
+
* useRedoInformation(
|
|
8179
|
+
* checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId,
|
|
8180
|
+
* ): UndoOrRedoInformation;
|
|
8181
|
+
* ```
|
|
8182
|
+
*
|
|
7292
8183
|
* This hook is useful if you are building an redo button: the information
|
|
7293
8184
|
* contains whether a redo action is available (to enable the button), the
|
|
7294
8185
|
* callback to perform the redo action, the checkpoint Id that will be redone,
|
|
@@ -7336,6 +8227,16 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
7336
8227
|
* Checkpoints object that will be called whenever its set of checkpoints
|
|
7337
8228
|
* changes.
|
|
7338
8229
|
*
|
|
8230
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
8231
|
+
*
|
|
8232
|
+
* ```ts override
|
|
8233
|
+
* useCheckpointIdsListener(
|
|
8234
|
+
* listener: CheckpointIdsListener,
|
|
8235
|
+
* listenerDeps?: React.DependencyList,
|
|
8236
|
+
* checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId,
|
|
8237
|
+
* ): void;
|
|
8238
|
+
* ```
|
|
8239
|
+
*
|
|
7339
8240
|
* This hook is useful for situations where a component needs to register its
|
|
7340
8241
|
* own specific listener to do more than simply tracking the value (which is
|
|
7341
8242
|
* more easily done with the useCheckpointIds hook).
|
|
@@ -7401,6 +8302,17 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
7401
8302
|
* Checkpoints object that will be called whenever the label of a checkpoint
|
|
7402
8303
|
* changes.
|
|
7403
8304
|
*
|
|
8305
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
8306
|
+
*
|
|
8307
|
+
* ```ts override
|
|
8308
|
+
* useCheckpointListener(
|
|
8309
|
+
* checkpointId: IdOrNull,
|
|
8310
|
+
* listener: CheckpointListener,
|
|
8311
|
+
* listenerDeps?: React.DependencyList,
|
|
8312
|
+
* checkpointsOrCheckpointsId?: CheckpointsOrCheckpointsId,
|
|
8313
|
+
* ): void;
|
|
8314
|
+
* ```
|
|
8315
|
+
*
|
|
7404
8316
|
* This hook is useful for situations where a component needs to register its
|
|
7405
8317
|
* own specific listener to do more than simply tracking the value (which is
|
|
7406
8318
|
* more easily done with the useCheckpoint hook).
|
|
@@ -7472,6 +8384,18 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
7472
8384
|
* The useCreatePersister hook is used to create a Persister within a React
|
|
7473
8385
|
* application along with convenient memoization and callbacks.
|
|
7474
8386
|
*
|
|
8387
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
8388
|
+
*
|
|
8389
|
+
* ```ts override
|
|
8390
|
+
* useCreatePersister(
|
|
8391
|
+
* store: Store,
|
|
8392
|
+
* create: (store: Store) => Persister,
|
|
8393
|
+
* createDeps?: React.DependencyList,
|
|
8394
|
+
* then?: (persister: Persister) => Promise<void>,
|
|
8395
|
+
* thenDeps?: React.DependencyList,
|
|
8396
|
+
* ): Persister;
|
|
8397
|
+
* ```
|
|
8398
|
+
*
|
|
7475
8399
|
* It is possible to create a Persister outside of the React app with the
|
|
7476
8400
|
* regular createPersister function and pass it in, but you may prefer to create
|
|
7477
8401
|
* it within the app, perhaps inside the top-level component. To defend against
|
|
@@ -7817,6 +8741,14 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
7817
8741
|
* The Provider component is used to wrap part of an application in a context
|
|
7818
8742
|
* that provides default objects to be used by hooks and components within.
|
|
7819
8743
|
*
|
|
8744
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
8745
|
+
*
|
|
8746
|
+
* ```ts override
|
|
8747
|
+
* Provider(
|
|
8748
|
+
* props: ProviderProps & {children: React.ReactNode},
|
|
8749
|
+
* ): ComponentReturnType;
|
|
8750
|
+
* ```
|
|
8751
|
+
*
|
|
7820
8752
|
* Store, Metrics, Indexes, Relationships, Queries, and Checkpoints objects can
|
|
7821
8753
|
* be passed into the context of an application and used throughout. One of each
|
|
7822
8754
|
* type of object can be provided as a default within the context. Additionally,
|
|
@@ -7918,6 +8850,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
7918
8850
|
* a given Table, and registers a listener so that any changes to that result
|
|
7919
8851
|
* will cause a re-render.
|
|
7920
8852
|
*
|
|
8853
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
8854
|
+
*
|
|
8855
|
+
* ```ts override
|
|
8856
|
+
* CellView(props: CellProps): ComponentReturnType;
|
|
8857
|
+
* ```
|
|
8858
|
+
*
|
|
7921
8859
|
* The component's props identify which Cell to render based on Table Id, Row
|
|
7922
8860
|
* Id, Cell Id, and Store (which is either the default context Store, a named
|
|
7923
8861
|
* context Store, or an explicit reference).
|
|
@@ -8009,6 +8947,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
8009
8947
|
* and registers a listener so that any changes to that result will cause a
|
|
8010
8948
|
* re-render.
|
|
8011
8949
|
*
|
|
8950
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
8951
|
+
*
|
|
8952
|
+
* ```ts override
|
|
8953
|
+
* RowView(props: RowProps): ComponentReturnType;
|
|
8954
|
+
* ```
|
|
8955
|
+
*
|
|
8012
8956
|
* The component's props identify which Row to render based on Table Id, Row Id,
|
|
8013
8957
|
* and Store (which is either the default context Store, a named context Store,
|
|
8014
8958
|
* or an explicit reference).
|
|
@@ -8123,6 +9067,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
8123
9067
|
* in a Store, and registers a listener so that any changes to that result will
|
|
8124
9068
|
* cause a re-render.
|
|
8125
9069
|
*
|
|
9070
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
9071
|
+
*
|
|
9072
|
+
* ```ts override
|
|
9073
|
+
* SortedTableView(props: SortedTableProps): ComponentReturnType;
|
|
9074
|
+
* ```
|
|
9075
|
+
*
|
|
8126
9076
|
* The component's props identify which Table to render based on Table Id, and
|
|
8127
9077
|
* Store (which is either the default context Store, a named context Store, or
|
|
8128
9078
|
* by explicit reference). It also takes a Cell Id to sort by and a boolean to
|
|
@@ -8253,6 +9203,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
8253
9203
|
* and registers a listener so that any changes to that result will cause a
|
|
8254
9204
|
* re-render.
|
|
8255
9205
|
*
|
|
9206
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
9207
|
+
*
|
|
9208
|
+
* ```ts override
|
|
9209
|
+
* TableView(props: TableProps): ComponentReturnType;
|
|
9210
|
+
* ```
|
|
9211
|
+
*
|
|
8256
9212
|
* The component's props identify which Table to render based on Table Id, and
|
|
8257
9213
|
* Store (which is either the default context Store, a named context Store, or
|
|
8258
9214
|
* by explicit reference).
|
|
@@ -8365,6 +9321,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
8365
9321
|
* registers a listener so that any changes to that result will cause a
|
|
8366
9322
|
* re-render.
|
|
8367
9323
|
*
|
|
9324
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
9325
|
+
*
|
|
9326
|
+
* ```ts override
|
|
9327
|
+
* TablesView(props: TablesProps): ComponentReturnType;
|
|
9328
|
+
* ```
|
|
9329
|
+
*
|
|
8368
9330
|
* The component's props can identify which Store to render - either the default
|
|
8369
9331
|
* context Store, a named context Store, or an explicit reference.
|
|
8370
9332
|
*
|
|
@@ -8472,6 +9434,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
8472
9434
|
* The ValueView component renders the value of a single Value, and registers a
|
|
8473
9435
|
* listener so that any changes to that result will cause a re-render.
|
|
8474
9436
|
*
|
|
9437
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
9438
|
+
*
|
|
9439
|
+
* ```ts override
|
|
9440
|
+
* ValueView(props: ValueProps): ComponentReturnType;
|
|
9441
|
+
* ```
|
|
9442
|
+
*
|
|
8475
9443
|
* The component's props identify which Value to render based on Value Id and
|
|
8476
9444
|
* Store (which is either the default context Store, a named context Store, or
|
|
8477
9445
|
* an explicit reference).
|
|
@@ -8564,6 +9532,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
8564
9532
|
* registers a listener so that any changes to that result will cause a
|
|
8565
9533
|
* re-render.
|
|
8566
9534
|
*
|
|
9535
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
9536
|
+
*
|
|
9537
|
+
* ```ts override
|
|
9538
|
+
* ValuesView(props: ValuesProps): ComponentReturnType;
|
|
9539
|
+
* ```
|
|
9540
|
+
*
|
|
8567
9541
|
* The component's props can identify which Store to render - either the default
|
|
8568
9542
|
* context Store, a named context Store, or an explicit reference.
|
|
8569
9543
|
*
|
|
@@ -8669,6 +9643,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
8669
9643
|
* The MetricView component renders the current value of a Metric, and registers
|
|
8670
9644
|
* a listener so that any changes to that result will cause a re-render.
|
|
8671
9645
|
*
|
|
9646
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
9647
|
+
*
|
|
9648
|
+
* ```ts override
|
|
9649
|
+
* MetricView(props: MetricProps): ComponentReturnType;
|
|
9650
|
+
* ```
|
|
9651
|
+
*
|
|
8672
9652
|
* The component's props can identify which Metrics object to get data for: omit
|
|
8673
9653
|
* the optional final parameter for the default context Metrics object, provide
|
|
8674
9654
|
* an Id for a named context Metrics object, or by explicit reference.
|
|
@@ -8774,6 +9754,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
8774
9754
|
* The SliceView component renders the contents of a Slice, and registers a
|
|
8775
9755
|
* listener so that any changes to that result will cause a re-render.
|
|
8776
9756
|
*
|
|
9757
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
9758
|
+
*
|
|
9759
|
+
* ```ts override
|
|
9760
|
+
* SliceView(props: SliceProps): ComponentReturnType;
|
|
9761
|
+
* ```
|
|
9762
|
+
*
|
|
8777
9763
|
* The component's props identify which Slice to render based on Index Id, Slice
|
|
8778
9764
|
* Id, and Indexes object (which is either the default context Indexes object, a
|
|
8779
9765
|
* named context Indexes object, or an explicit reference).
|
|
@@ -8900,6 +9886,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
8900
9886
|
* The IndexView component renders the contents of a Index, and registers a
|
|
8901
9887
|
* listener so that any changes to that result will cause a re-render.
|
|
8902
9888
|
*
|
|
9889
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
9890
|
+
*
|
|
9891
|
+
* ```ts override
|
|
9892
|
+
* IndexView(props: IndexProps): ComponentReturnType;
|
|
9893
|
+
* ```
|
|
9894
|
+
*
|
|
8903
9895
|
* The component's props identify which Index to render based on Index Id, and
|
|
8904
9896
|
* Indexes object (which is either the default context Indexes object, a named
|
|
8905
9897
|
* context Indexes object, or an explicit reference).
|
|
@@ -9022,6 +10014,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
9022
10014
|
* in a Relationship, and registers a listener so that any changes to that
|
|
9023
10015
|
* result will cause a re-render.
|
|
9024
10016
|
*
|
|
10017
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
10018
|
+
*
|
|
10019
|
+
* ```ts override
|
|
10020
|
+
* RemoteRowView(props: RemoteRowProps): ComponentReturnType;
|
|
10021
|
+
* ```
|
|
10022
|
+
*
|
|
9025
10023
|
* The component's props identify which remote Row to render based on
|
|
9026
10024
|
* Relationship Id, local Row Id, and Relationships object (which is either the
|
|
9027
10025
|
* default context Relationships object, a named context Relationships object,
|
|
@@ -9156,6 +10154,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
9156
10154
|
* Row in a Relationship, and registers a listener so that any changes to that
|
|
9157
10155
|
* result will cause a re-render.
|
|
9158
10156
|
*
|
|
10157
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
10158
|
+
*
|
|
10159
|
+
* ```ts override
|
|
10160
|
+
* LocalRowsView(props: LocalRowsProps): ComponentReturnType;
|
|
10161
|
+
* ```
|
|
10162
|
+
*
|
|
9159
10163
|
* The component's props identify which local Rows to render based on
|
|
9160
10164
|
* Relationship Id, remote Row Id, and Relationships object (which is either the
|
|
9161
10165
|
* default context Relationships object, a named context Relationships object,
|
|
@@ -9291,6 +10295,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
9291
10295
|
* Row in a Relationship, and registers a listener so that any changes to that
|
|
9292
10296
|
* result will cause a re-render.
|
|
9293
10297
|
*
|
|
10298
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
10299
|
+
*
|
|
10300
|
+
* ```ts override
|
|
10301
|
+
* LinkedRowsView(props: LinkedRowsProps): ComponentReturnType;
|
|
10302
|
+
* ```
|
|
10303
|
+
*
|
|
9294
10304
|
* The component's props identify which local Rows to render based on
|
|
9295
10305
|
* Relationship Id, remote Row Id, and Relationships object (which is either the
|
|
9296
10306
|
* default context Relationships object, a named context Relationships object,
|
|
@@ -9431,6 +10441,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
9431
10441
|
* Row, in a given query's result Table, and registers a listener so that any
|
|
9432
10442
|
* changes to that result will cause a re-render.
|
|
9433
10443
|
*
|
|
10444
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
10445
|
+
*
|
|
10446
|
+
* ```ts override
|
|
10447
|
+
* ResultCellView(props: ResultCellProps): ComponentReturnType;
|
|
10448
|
+
* ```
|
|
10449
|
+
*
|
|
9434
10450
|
* The component's props identify which Cell to render based on query Id, Row
|
|
9435
10451
|
* Id, Cell Id, and Queries object (which is either the default context Queries
|
|
9436
10452
|
* object, a named context Queries object, or an explicit reference).
|
|
@@ -9554,6 +10570,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
9554
10570
|
* query's result Table, and registers a listener so that any changes to that
|
|
9555
10571
|
* result will cause a re-render.
|
|
9556
10572
|
*
|
|
10573
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
10574
|
+
*
|
|
10575
|
+
* ```ts override
|
|
10576
|
+
* ResultRowView(props: ResultRowProps): ComponentReturnType;
|
|
10577
|
+
* ```
|
|
10578
|
+
*
|
|
9557
10579
|
* The component's props identify which Row to render based on query Id, Row Id,
|
|
9558
10580
|
* and Queries object (which is either the default context Queries object, a
|
|
9559
10581
|
* named context Queries object, or an explicit reference).
|
|
@@ -9701,6 +10723,14 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
9701
10723
|
* sorted result Table in a Queries object, and registers a listener so that any
|
|
9702
10724
|
* changes to that result will cause a re-render.
|
|
9703
10725
|
*
|
|
10726
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
10727
|
+
*
|
|
10728
|
+
* ```ts override
|
|
10729
|
+
* ResultSortedTableView(
|
|
10730
|
+
* props: ResultSortedTableProps,
|
|
10731
|
+
* ): ComponentReturnType;
|
|
10732
|
+
* ```
|
|
10733
|
+
*
|
|
9704
10734
|
* The component's props identify which Table to render based on query Id, and
|
|
9705
10735
|
* Queries object (which is either the default context Queries object, a named
|
|
9706
10736
|
* context Queries object, or by explicit reference). It also takes a Cell Id to
|
|
@@ -9841,6 +10871,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
9841
10871
|
* Table in a Queries object, and registers a listener so that any changes to
|
|
9842
10872
|
* that result will cause a re-render.
|
|
9843
10873
|
*
|
|
10874
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
10875
|
+
*
|
|
10876
|
+
* ```ts override
|
|
10877
|
+
* ResultTableView(props: ResultTableProps): ComponentReturnType;
|
|
10878
|
+
* ```
|
|
10879
|
+
*
|
|
9844
10880
|
* The component's props identify which Table to render based on query Id, and
|
|
9845
10881
|
* Queries object (which is either the default context Queries object, a named
|
|
9846
10882
|
* context Queries object, or by explicit reference).
|
|
@@ -9962,6 +10998,12 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
9962
10998
|
/**
|
|
9963
10999
|
* The CheckpointView component simply renders the label of a checkpoint.
|
|
9964
11000
|
*
|
|
11001
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
11002
|
+
*
|
|
11003
|
+
* ```ts override
|
|
11004
|
+
* CheckpointView(props: CheckpointProps): ComponentReturnType;
|
|
11005
|
+
* ```
|
|
11006
|
+
*
|
|
9965
11007
|
* The component's props identify which checkpoint to render based on Checkpoint
|
|
9966
11008
|
* Id and Checkpoints object (which is either the default context Checkpoints
|
|
9967
11009
|
* object, a named context Checkpoints object, or an explicit reference).
|
|
@@ -10014,6 +11056,14 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
10014
11056
|
* The BackwardCheckpointsView component renders a list of previous checkpoints
|
|
10015
11057
|
* that the underlying Store can go back to.
|
|
10016
11058
|
*
|
|
11059
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
11060
|
+
*
|
|
11061
|
+
* ```ts override
|
|
11062
|
+
* BackwardCheckpointsView(
|
|
11063
|
+
* props: BackwardCheckpointsProps,
|
|
11064
|
+
* ): ComponentReturnType;
|
|
11065
|
+
* ```
|
|
11066
|
+
*
|
|
10017
11067
|
* The component's props identify which previous checkpoints to render based on
|
|
10018
11068
|
* the Checkpoints object (which is either the default context Checkpoints
|
|
10019
11069
|
* object, a named context Checkpoints object, or an explicit reference).
|
|
@@ -10151,6 +11201,14 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
10151
11201
|
* The CurrentCheckpointView component renders the current checkpoint that the
|
|
10152
11202
|
* underlying Store is currently on.
|
|
10153
11203
|
*
|
|
11204
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
11205
|
+
*
|
|
11206
|
+
* ```ts override
|
|
11207
|
+
* CurrentCheckpointView(
|
|
11208
|
+
* props: CurrentCheckpointProps,
|
|
11209
|
+
* ): ComponentReturnType;
|
|
11210
|
+
* ```
|
|
11211
|
+
*
|
|
10154
11212
|
* The component's props identify which current checkpoint to render based on
|
|
10155
11213
|
* the Checkpoints object (which is either the default context Checkpoints
|
|
10156
11214
|
* object, a named context Checkpoints object, or an explicit reference).
|
|
@@ -10288,6 +11346,14 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
|
|
|
10288
11346
|
* The ForwardCheckpointsView component renders a list of future checkpoints
|
|
10289
11347
|
* that the underlying Store can go forwards to.
|
|
10290
11348
|
*
|
|
11349
|
+
* This has schema-based typing. The following is a simplified representation:
|
|
11350
|
+
*
|
|
11351
|
+
* ```ts override
|
|
11352
|
+
* ForwardCheckpointsView(
|
|
11353
|
+
* props: ForwardCheckpointsProps,
|
|
11354
|
+
* ): ComponentReturnType;
|
|
11355
|
+
* ```
|
|
11356
|
+
*
|
|
10291
11357
|
* The component's props identify which future checkpoints to render based on
|
|
10292
11358
|
* the Checkpoints object (which is either the default context Checkpoints
|
|
10293
11359
|
* object, a named context Checkpoints object, or an explicit reference).
|