tinybase 5.0.0-beta.27 → 5.0.0-beta.28
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/@types/_internal/ui-react/with-schemas/index.d.cts +274 -0
- package/@types/_internal/ui-react/with-schemas/index.d.ts +274 -0
- package/@types/checkpoints/index.d.cts +30 -1
- package/@types/checkpoints/index.d.ts +30 -1
- package/@types/checkpoints/with-schemas/index.d.cts +30 -1
- package/@types/checkpoints/with-schemas/index.d.ts +30 -1
- package/@types/common/index.d.cts +9 -0
- package/@types/common/index.d.ts +9 -0
- package/@types/common/with-schemas/index.d.cts +9 -0
- package/@types/common/with-schemas/index.d.ts +9 -0
- package/@types/index.d.cts +1 -0
- package/@types/index.d.ts +1 -0
- package/@types/indexes/index.d.cts +32 -1
- package/@types/indexes/index.d.ts +32 -1
- package/@types/indexes/with-schemas/index.d.cts +32 -1
- package/@types/indexes/with-schemas/index.d.ts +32 -1
- package/@types/mergeable-store/index.d.cts +0 -2
- package/@types/mergeable-store/index.d.ts +0 -2
- package/@types/mergeable-store/with-schemas/index.d.cts +2 -2
- package/@types/mergeable-store/with-schemas/index.d.ts +2 -2
- package/@types/metrics/index.d.cts +30 -4
- package/@types/metrics/index.d.ts +30 -4
- package/@types/metrics/with-schemas/index.d.cts +30 -4
- package/@types/metrics/with-schemas/index.d.ts +30 -4
- package/@types/persisters/index.d.cts +87 -25
- package/@types/persisters/index.d.ts +87 -25
- package/@types/persisters/persister-automerge/index.d.cts +4 -4
- package/@types/persisters/persister-automerge/index.d.ts +4 -4
- package/@types/persisters/persister-automerge/with-schemas/index.d.cts +4 -4
- package/@types/persisters/persister-automerge/with-schemas/index.d.ts +4 -4
- package/@types/persisters/persister-browser/index.d.cts +7 -4
- package/@types/persisters/persister-browser/index.d.ts +7 -4
- package/@types/persisters/persister-browser/with-schemas/index.d.cts +7 -4
- package/@types/persisters/persister-browser/with-schemas/index.d.ts +7 -4
- package/@types/persisters/persister-cr-sqlite-wasm/index.d.cts +4 -4
- package/@types/persisters/persister-cr-sqlite-wasm/index.d.ts +4 -4
- package/@types/persisters/persister-cr-sqlite-wasm/with-schemas/index.d.cts +4 -4
- package/@types/persisters/persister-cr-sqlite-wasm/with-schemas/index.d.ts +4 -4
- package/@types/persisters/persister-electric-sql/index.d.cts +4 -4
- package/@types/persisters/persister-electric-sql/index.d.ts +4 -4
- package/@types/persisters/persister-electric-sql/with-schemas/index.d.cts +4 -4
- package/@types/persisters/persister-electric-sql/with-schemas/index.d.ts +4 -4
- package/@types/persisters/persister-expo-sqlite/index.d.cts +4 -4
- package/@types/persisters/persister-expo-sqlite/index.d.ts +4 -4
- package/@types/persisters/persister-expo-sqlite/with-schemas/index.d.cts +4 -4
- package/@types/persisters/persister-expo-sqlite/with-schemas/index.d.ts +4 -4
- package/@types/persisters/persister-file/index.d.cts +6 -4
- package/@types/persisters/persister-file/index.d.ts +6 -4
- package/@types/persisters/persister-file/with-schemas/index.d.cts +6 -4
- package/@types/persisters/persister-file/with-schemas/index.d.ts +6 -4
- package/@types/persisters/persister-indexed-db/index.d.cts +5 -4
- package/@types/persisters/persister-indexed-db/index.d.ts +5 -4
- package/@types/persisters/persister-indexed-db/with-schemas/index.d.cts +5 -4
- package/@types/persisters/persister-indexed-db/with-schemas/index.d.ts +5 -4
- package/@types/persisters/persister-libsql/index.d.cts +5 -4
- package/@types/persisters/persister-libsql/index.d.ts +5 -4
- package/@types/persisters/persister-libsql/with-schemas/index.d.cts +5 -4
- package/@types/persisters/persister-libsql/with-schemas/index.d.ts +5 -4
- package/@types/persisters/persister-partykit-client/index.d.cts +12 -6
- package/@types/persisters/persister-partykit-client/index.d.ts +12 -6
- package/@types/persisters/persister-partykit-client/with-schemas/index.d.cts +12 -6
- package/@types/persisters/persister-partykit-client/with-schemas/index.d.ts +12 -6
- package/@types/persisters/persister-partykit-server/index.d.cts +11 -3
- package/@types/persisters/persister-partykit-server/index.d.ts +11 -3
- package/@types/persisters/persister-partykit-server/with-schemas/index.d.cts +11 -3
- package/@types/persisters/persister-partykit-server/with-schemas/index.d.ts +11 -3
- package/@types/persisters/persister-powersync/index.d.cts +5 -4
- package/@types/persisters/persister-powersync/index.d.ts +5 -4
- package/@types/persisters/persister-powersync/with-schemas/index.d.cts +5 -4
- package/@types/persisters/persister-powersync/with-schemas/index.d.ts +5 -4
- package/@types/persisters/persister-remote/index.d.cts +6 -4
- package/@types/persisters/persister-remote/index.d.ts +6 -4
- package/@types/persisters/persister-remote/with-schemas/index.d.cts +6 -4
- package/@types/persisters/persister-remote/with-schemas/index.d.ts +6 -4
- package/@types/persisters/persister-sqlite-wasm/index.d.cts +4 -4
- package/@types/persisters/persister-sqlite-wasm/index.d.ts +4 -4
- package/@types/persisters/persister-sqlite-wasm/with-schemas/index.d.cts +4 -4
- package/@types/persisters/persister-sqlite-wasm/with-schemas/index.d.ts +4 -4
- package/@types/persisters/persister-sqlite3/index.d.cts +4 -4
- package/@types/persisters/persister-sqlite3/index.d.ts +4 -4
- package/@types/persisters/persister-sqlite3/with-schemas/index.d.cts +4 -4
- package/@types/persisters/persister-sqlite3/with-schemas/index.d.ts +4 -4
- package/@types/persisters/persister-yjs/index.d.cts +4 -4
- package/@types/persisters/persister-yjs/index.d.ts +4 -4
- package/@types/persisters/persister-yjs/with-schemas/index.d.cts +4 -4
- package/@types/persisters/persister-yjs/with-schemas/index.d.ts +4 -4
- package/@types/persisters/with-schemas/index.d.cts +87 -25
- package/@types/persisters/with-schemas/index.d.ts +87 -25
- package/@types/queries/index.d.cts +64 -4
- package/@types/queries/index.d.ts +64 -4
- package/@types/queries/with-schemas/index.d.cts +64 -4
- package/@types/queries/with-schemas/index.d.ts +64 -4
- package/@types/relationships/index.d.cts +34 -1
- package/@types/relationships/index.d.ts +34 -1
- package/@types/relationships/with-schemas/index.d.cts +34 -1
- package/@types/relationships/with-schemas/index.d.ts +34 -1
- package/@types/store/index.d.cts +125 -0
- package/@types/store/index.d.ts +125 -0
- package/@types/store/with-schemas/index.d.cts +125 -0
- package/@types/store/with-schemas/index.d.ts +125 -0
- package/@types/synchronizers/index.d.cts +32 -10
- package/@types/synchronizers/index.d.ts +32 -10
- package/@types/synchronizers/synchronizer-broadcast-channel/index.d.cts +114 -0
- package/@types/synchronizers/synchronizer-broadcast-channel/index.d.ts +114 -0
- package/@types/synchronizers/synchronizer-broadcast-channel/with-schemas/index.d.cts +128 -0
- package/@types/synchronizers/synchronizer-broadcast-channel/with-schemas/index.d.ts +128 -0
- package/@types/synchronizers/synchronizer-local/index.d.cts +16 -17
- package/@types/synchronizers/synchronizer-local/index.d.ts +16 -17
- package/@types/synchronizers/synchronizer-local/with-schemas/index.d.cts +16 -17
- package/@types/synchronizers/synchronizer-local/with-schemas/index.d.ts +16 -17
- package/@types/synchronizers/synchronizer-ws-client/index.d.cts +66 -6
- package/@types/synchronizers/synchronizer-ws-client/index.d.ts +66 -6
- package/@types/synchronizers/synchronizer-ws-client/with-schemas/index.d.cts +77 -6
- package/@types/synchronizers/synchronizer-ws-client/with-schemas/index.d.ts +77 -6
- package/@types/synchronizers/synchronizer-ws-server/index.d.cts +486 -7
- package/@types/synchronizers/synchronizer-ws-server/index.d.ts +486 -7
- package/@types/synchronizers/synchronizer-ws-server/with-schemas/index.d.cts +486 -7
- package/@types/synchronizers/synchronizer-ws-server/with-schemas/index.d.ts +486 -7
- package/@types/synchronizers/with-schemas/index.d.cts +29 -11
- package/@types/synchronizers/with-schemas/index.d.ts +29 -11
- package/@types/tools/index.d.cts +22 -0
- package/@types/tools/index.d.ts +22 -0
- package/@types/tools/with-schemas/index.d.cts +22 -0
- package/@types/tools/with-schemas/index.d.ts +22 -0
- package/@types/ui-react/index.d.cts +375 -1
- package/@types/ui-react/index.d.ts +375 -1
- package/@types/ui-react/with-schemas/index.d.cts +100 -1
- package/@types/ui-react/with-schemas/index.d.ts +100 -1
- package/@types/ui-react-dom/index.d.cts +112 -0
- package/@types/ui-react-dom/index.d.ts +112 -0
- package/@types/ui-react-dom/with-schemas/index.d.cts +112 -0
- package/@types/ui-react-dom/with-schemas/index.d.ts +112 -0
- package/@types/ui-react-inspector/index.d.cts +6 -2
- package/@types/ui-react-inspector/index.d.ts +6 -2
- package/@types/ui-react-inspector/with-schemas/index.d.cts +118 -2
- package/@types/ui-react-inspector/with-schemas/index.d.ts +118 -2
- package/@types/with-schemas/index.d.cts +1 -0
- package/@types/with-schemas/index.d.ts +1 -0
- package/cjs/es6/index.cjs +2 -2
- package/cjs/es6/min/synchronizers/synchronizer-broadcast-channel/index.cjs +1 -0
- package/cjs/es6/min/synchronizers/synchronizer-broadcast-channel/index.cjs.gz +0 -0
- package/cjs/es6/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.cjs +1 -0
- package/cjs/es6/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.cjs.gz +0 -0
- package/cjs/es6/min/synchronizers/synchronizer-ws-client/index.cjs +1 -1
- package/cjs/es6/min/synchronizers/synchronizer-ws-client/index.cjs.gz +0 -0
- package/cjs/es6/min/synchronizers/synchronizer-ws-client/with-schemas/index.cjs +1 -1
- package/cjs/es6/min/synchronizers/synchronizer-ws-client/with-schemas/index.cjs.gz +0 -0
- package/cjs/es6/synchronizers/index.cjs +2 -2
- package/cjs/es6/synchronizers/synchronizer-broadcast-channel/index.cjs +628 -0
- package/cjs/es6/synchronizers/synchronizer-broadcast-channel/with-schemas/index.cjs +628 -0
- package/cjs/es6/synchronizers/synchronizer-local/index.cjs +4 -4
- package/cjs/es6/synchronizers/synchronizer-local/with-schemas/index.cjs +4 -4
- package/cjs/es6/synchronizers/synchronizer-ws-client/index.cjs +15 -21
- package/cjs/es6/synchronizers/synchronizer-ws-client/with-schemas/index.cjs +15 -21
- package/cjs/es6/synchronizers/with-schemas/index.cjs +2 -2
- package/cjs/es6/with-schemas/index.cjs +2 -2
- package/cjs/index.cjs +2 -2
- package/cjs/min/synchronizers/synchronizer-broadcast-channel/index.cjs +1 -0
- package/cjs/min/synchronizers/synchronizer-broadcast-channel/index.cjs.gz +0 -0
- package/cjs/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.cjs +1 -0
- package/cjs/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.cjs.gz +0 -0
- package/cjs/min/synchronizers/synchronizer-ws-client/index.cjs +1 -1
- package/cjs/min/synchronizers/synchronizer-ws-client/index.cjs.gz +0 -0
- package/cjs/min/synchronizers/synchronizer-ws-client/with-schemas/index.cjs +1 -1
- package/cjs/min/synchronizers/synchronizer-ws-client/with-schemas/index.cjs.gz +0 -0
- package/cjs/synchronizers/index.cjs +2 -2
- package/cjs/synchronizers/synchronizer-broadcast-channel/index.cjs +500 -0
- package/cjs/synchronizers/synchronizer-broadcast-channel/with-schemas/index.cjs +500 -0
- package/cjs/synchronizers/synchronizer-local/index.cjs +4 -4
- package/cjs/synchronizers/synchronizer-local/with-schemas/index.cjs +4 -4
- package/cjs/synchronizers/synchronizer-ws-client/index.cjs +15 -21
- package/cjs/synchronizers/synchronizer-ws-client/with-schemas/index.cjs +15 -21
- package/cjs/synchronizers/with-schemas/index.cjs +2 -2
- package/cjs/with-schemas/index.cjs +2 -2
- package/es6/index.js +2 -2
- package/es6/min/synchronizers/synchronizer-broadcast-channel/index.js +1 -0
- package/es6/min/synchronizers/synchronizer-broadcast-channel/index.js.gz +0 -0
- package/es6/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js +1 -0
- package/es6/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js.gz +0 -0
- package/es6/min/synchronizers/synchronizer-ws-client/index.js +1 -1
- package/es6/min/synchronizers/synchronizer-ws-client/index.js.gz +0 -0
- package/es6/min/synchronizers/synchronizer-ws-client/with-schemas/index.js +1 -1
- package/es6/min/synchronizers/synchronizer-ws-client/with-schemas/index.js.gz +0 -0
- package/es6/synchronizers/index.js +2 -2
- package/es6/synchronizers/synchronizer-broadcast-channel/index.js +626 -0
- package/es6/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js +626 -0
- package/es6/synchronizers/synchronizer-local/index.js +4 -4
- package/es6/synchronizers/synchronizer-local/with-schemas/index.js +4 -4
- package/es6/synchronizers/synchronizer-ws-client/index.js +15 -21
- package/es6/synchronizers/synchronizer-ws-client/with-schemas/index.js +15 -21
- package/es6/synchronizers/with-schemas/index.js +2 -2
- package/es6/with-schemas/index.js +2 -2
- package/index.js +2 -2
- package/min/synchronizers/synchronizer-broadcast-channel/index.js +1 -0
- package/min/synchronizers/synchronizer-broadcast-channel/index.js.gz +0 -0
- package/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js +1 -0
- package/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js.gz +0 -0
- package/min/synchronizers/synchronizer-ws-client/index.js +1 -1
- package/min/synchronizers/synchronizer-ws-client/index.js.gz +0 -0
- package/min/synchronizers/synchronizer-ws-client/with-schemas/index.js +1 -1
- package/min/synchronizers/synchronizer-ws-client/with-schemas/index.js.gz +0 -0
- package/package.json +105 -1
- package/readme.md +9 -9
- package/releases.md +4 -4
- package/synchronizers/index.js +2 -2
- package/synchronizers/synchronizer-broadcast-channel/index.js +498 -0
- package/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js +498 -0
- package/synchronizers/synchronizer-local/index.js +4 -4
- package/synchronizers/synchronizer-local/with-schemas/index.js +4 -4
- package/synchronizers/synchronizer-ws-client/index.js +15 -21
- package/synchronizers/synchronizer-ws-client/with-schemas/index.js +15 -21
- package/synchronizers/with-schemas/index.js +2 -2
- package/umd/es6/index.js +2 -2
- package/umd/es6/min/synchronizers/synchronizer-broadcast-channel/index.js +1 -0
- package/umd/es6/min/synchronizers/synchronizer-broadcast-channel/index.js.gz +0 -0
- package/umd/es6/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js +1 -0
- package/umd/es6/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js.gz +0 -0
- package/umd/es6/min/synchronizers/synchronizer-ws-client/index.js +1 -1
- package/umd/es6/min/synchronizers/synchronizer-ws-client/index.js.gz +0 -0
- package/umd/es6/min/synchronizers/synchronizer-ws-client/with-schemas/index.js +1 -1
- package/umd/es6/min/synchronizers/synchronizer-ws-client/with-schemas/index.js.gz +0 -0
- package/umd/es6/synchronizers/index.js +2 -2
- package/umd/es6/synchronizers/synchronizer-broadcast-channel/index.js +654 -0
- package/umd/es6/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js +654 -0
- package/umd/es6/synchronizers/synchronizer-local/index.js +4 -4
- package/umd/es6/synchronizers/synchronizer-local/with-schemas/index.js +4 -4
- package/umd/es6/synchronizers/synchronizer-ws-client/index.js +15 -21
- package/umd/es6/synchronizers/synchronizer-ws-client/with-schemas/index.js +15 -21
- package/umd/es6/synchronizers/with-schemas/index.js +2 -2
- package/umd/es6/with-schemas/index.js +2 -2
- package/umd/index.js +2 -2
- package/umd/min/synchronizers/synchronizer-broadcast-channel/index.js +1 -0
- package/umd/min/synchronizers/synchronizer-broadcast-channel/index.js.gz +0 -0
- package/umd/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js +1 -0
- package/umd/min/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js.gz +0 -0
- package/umd/min/synchronizers/synchronizer-ws-client/index.js +1 -1
- package/umd/min/synchronizers/synchronizer-ws-client/index.js.gz +0 -0
- package/umd/min/synchronizers/synchronizer-ws-client/with-schemas/index.js +1 -1
- package/umd/min/synchronizers/synchronizer-ws-client/with-schemas/index.js.gz +0 -0
- package/umd/synchronizers/index.js +2 -2
- package/umd/synchronizers/synchronizer-broadcast-channel/index.js +516 -0
- package/umd/synchronizers/synchronizer-broadcast-channel/with-schemas/index.js +516 -0
- package/umd/synchronizers/synchronizer-local/index.js +4 -4
- package/umd/synchronizers/synchronizer-local/with-schemas/index.js +4 -4
- package/umd/synchronizers/synchronizer-ws-client/index.js +15 -21
- package/umd/synchronizers/synchronizer-ws-client/with-schemas/index.js +15 -21
- package/umd/synchronizers/with-schemas/index.js +2 -2
- package/umd/with-schemas/index.js +2 -2
- package/with-schemas/index.js +2 -2
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
* tabular data within.
|
|
9
9
|
* @packageDocumentation
|
|
10
10
|
* @module store
|
|
11
|
+
* @since v1.0.0
|
|
11
12
|
*/
|
|
12
13
|
|
|
13
14
|
import type {
|
|
@@ -52,6 +53,7 @@ import type {
|
|
|
52
53
|
* };
|
|
53
54
|
* ```
|
|
54
55
|
* @category Schema
|
|
56
|
+
* @since v1.0.0
|
|
55
57
|
*/
|
|
56
58
|
export type TablesSchema = {[tableId: Id]: {[cellId: Id]: CellSchema}};
|
|
57
59
|
|
|
@@ -82,6 +84,7 @@ export type TablesSchema = {[tableId: Id]: {[cellId: Id]: CellSchema}};
|
|
|
82
84
|
* };
|
|
83
85
|
* ```
|
|
84
86
|
* @category Schema
|
|
87
|
+
* @since v1.0.0
|
|
85
88
|
*/
|
|
86
89
|
export type CellSchema =
|
|
87
90
|
| {type: 'string'; default?: string}
|
|
@@ -148,6 +151,7 @@ export type ValueSchema =
|
|
|
148
151
|
* The NoTablesSchema type is a TablesSchema-like type for when one has not been
|
|
149
152
|
* provided.
|
|
150
153
|
* @category Schema
|
|
154
|
+
* @since v1.0.0
|
|
151
155
|
*/
|
|
152
156
|
export type NoTablesSchema = {[tableId: Id]: {[cellId: Id]: {type: 'any'}}};
|
|
153
157
|
|
|
@@ -155,6 +159,7 @@ export type NoTablesSchema = {[tableId: Id]: {[cellId: Id]: {type: 'any'}}};
|
|
|
155
159
|
* The NoValuesSchema type is a ValuesSchema-like type for when one has not been
|
|
156
160
|
* provided.
|
|
157
161
|
* @category Schema
|
|
162
|
+
* @since v1.0.0
|
|
158
163
|
*/
|
|
159
164
|
export type NoValuesSchema = {[valueId: Id]: {type: 'any'}};
|
|
160
165
|
|
|
@@ -162,6 +167,7 @@ export type NoValuesSchema = {[valueId: Id]: {type: 'any'}};
|
|
|
162
167
|
* The OptionalTablesSchema type is used by generic types that can optionally
|
|
163
168
|
* take a TablesSchema.
|
|
164
169
|
* @category Schema
|
|
170
|
+
* @since v1.0.0
|
|
165
171
|
*/
|
|
166
172
|
export type OptionalTablesSchema = TablesSchema | NoTablesSchema;
|
|
167
173
|
|
|
@@ -169,6 +175,7 @@ export type OptionalTablesSchema = TablesSchema | NoTablesSchema;
|
|
|
169
175
|
* The OptionalValuesSchema type is used by generic types that can optionally
|
|
170
176
|
* take a ValuesSchema.
|
|
171
177
|
* @category Schema
|
|
178
|
+
* @since v1.0.0
|
|
172
179
|
*/
|
|
173
180
|
export type OptionalValuesSchema = ValuesSchema | NoValuesSchema;
|
|
174
181
|
|
|
@@ -176,6 +183,7 @@ export type OptionalValuesSchema = ValuesSchema | NoValuesSchema;
|
|
|
176
183
|
* The OptionalSchemas type is used by generic types that can optionally take
|
|
177
184
|
* either or both of a TablesSchema and ValuesSchema.
|
|
178
185
|
* @category Schema
|
|
186
|
+
* @since v1.0.0
|
|
179
187
|
*/
|
|
180
188
|
export type OptionalSchemas = [OptionalTablesSchema, OptionalValuesSchema];
|
|
181
189
|
|
|
@@ -183,6 +191,7 @@ export type OptionalSchemas = [OptionalTablesSchema, OptionalValuesSchema];
|
|
|
183
191
|
* The NoSchemas type is used as a default by generic types that can optionally
|
|
184
192
|
* take either or both of a TablesSchema and ValuesSchema.
|
|
185
193
|
* @category Schema
|
|
194
|
+
* @since v1.0.0
|
|
186
195
|
*/
|
|
187
196
|
export type NoSchemas = [NoTablesSchema, NoValuesSchema];
|
|
188
197
|
|
|
@@ -256,6 +265,7 @@ export type Content<
|
|
|
256
265
|
* };
|
|
257
266
|
* ```
|
|
258
267
|
* @category Store
|
|
268
|
+
* @since v1.0.0
|
|
259
269
|
*/
|
|
260
270
|
export type Tables<
|
|
261
271
|
Schema extends OptionalTablesSchema,
|
|
@@ -291,6 +301,7 @@ export type Tables<
|
|
|
291
301
|
* };
|
|
292
302
|
* ```
|
|
293
303
|
* @category Store
|
|
304
|
+
* @since v1.0.0
|
|
294
305
|
*/
|
|
295
306
|
export type Table<
|
|
296
307
|
Schema extends OptionalTablesSchema,
|
|
@@ -317,6 +328,7 @@ export type Table<
|
|
|
317
328
|
* export const row: Row = {species: 'dog', color: 'brown'};
|
|
318
329
|
* ```
|
|
319
330
|
* @category Store
|
|
331
|
+
* @since v1.0.0
|
|
320
332
|
*/
|
|
321
333
|
export type Row<
|
|
322
334
|
Schema extends OptionalTablesSchema,
|
|
@@ -363,6 +375,7 @@ export type Row<
|
|
|
363
375
|
* export const cell: Cell = 'dog';
|
|
364
376
|
* ```
|
|
365
377
|
* @category Store
|
|
378
|
+
* @since v1.0.0
|
|
366
379
|
*/
|
|
367
380
|
export type Cell<
|
|
368
381
|
Schema extends OptionalTablesSchema,
|
|
@@ -391,6 +404,7 @@ export type Cell<
|
|
|
391
404
|
* such as when it has been deleted, or when describing a previous state where
|
|
392
405
|
* the Cell value has since been added.
|
|
393
406
|
* @category Store
|
|
407
|
+
* @since v1.0.0
|
|
394
408
|
*/
|
|
395
409
|
export type CellOrUndefined<
|
|
396
410
|
Schema extends OptionalTablesSchema,
|
|
@@ -518,6 +532,7 @@ export type ValueOrUndefined<
|
|
|
518
532
|
* @param forEachRow A function that will let you iterate over the Row objects
|
|
519
533
|
* in this Table.
|
|
520
534
|
* @category Callback
|
|
535
|
+
* @since v1.0.0
|
|
521
536
|
*/
|
|
522
537
|
export type TableCallback<
|
|
523
538
|
Schema extends OptionalTablesSchema,
|
|
@@ -549,6 +564,7 @@ export type TableCallback<
|
|
|
549
564
|
* @param cellId The Id of the Cell that the callback can operate on.
|
|
550
565
|
* @param count The number of times this Cell is used across a whole Table.
|
|
551
566
|
* @category Callback
|
|
567
|
+
* @since v1.0.0
|
|
552
568
|
*/
|
|
553
569
|
export type TableCellCallback<
|
|
554
570
|
Schema extends OptionalTablesSchema,
|
|
@@ -575,6 +591,7 @@ export type TableCellCallback<
|
|
|
575
591
|
* @param forEachRow A function that will let you iterate over the Cell values
|
|
576
592
|
* in this Row.
|
|
577
593
|
* @category Callback
|
|
594
|
+
* @since v1.0.0
|
|
578
595
|
*/
|
|
579
596
|
export type RowCallback<
|
|
580
597
|
Schema extends OptionalTablesSchema,
|
|
@@ -604,6 +621,7 @@ export type RowCallback<
|
|
|
604
621
|
* @param cellId The Id of the Cell that the callback can operate on.
|
|
605
622
|
* @param cell The value of the Cell.
|
|
606
623
|
* @category Callback
|
|
624
|
+
* @since v1.0.0
|
|
607
625
|
*/
|
|
608
626
|
export type CellCallback<
|
|
609
627
|
Schema extends OptionalTablesSchema,
|
|
@@ -673,6 +691,7 @@ export type ValueCallback<
|
|
|
673
691
|
* examples.
|
|
674
692
|
* @param cell The current value of the Cell to map to a new value.
|
|
675
693
|
* @category Callback
|
|
694
|
+
* @since v1.0.0
|
|
676
695
|
*/
|
|
677
696
|
export type MapCell<
|
|
678
697
|
Schema extends OptionalTablesSchema,
|
|
@@ -719,6 +738,7 @@ export type MapValue<
|
|
|
719
738
|
* method of an Indexes object. See those methods for specific examples.
|
|
720
739
|
* @param cellId The Id of the Cell to fetch the value for.
|
|
721
740
|
* @category Callback
|
|
741
|
+
* @since v1.0.0
|
|
722
742
|
*/
|
|
723
743
|
export type GetCell<
|
|
724
744
|
Schema extends OptionalTablesSchema,
|
|
@@ -870,6 +890,7 @@ export type ChangedValueIds<Schema extends OptionalValuesSchema> = {
|
|
|
870
890
|
* Store directly to decide whether to do the rollback.
|
|
871
891
|
* @param store A reference to the Store that is completing a transaction.
|
|
872
892
|
* @category Callback
|
|
893
|
+
* @since v1.0.0
|
|
873
894
|
*/
|
|
874
895
|
export type DoRollback<Schemas extends OptionalSchemas> = (
|
|
875
896
|
store: Store<Schemas>,
|
|
@@ -897,6 +918,7 @@ export type DoRollback<Schemas extends OptionalSchemas> = (
|
|
|
897
918
|
* transaction.
|
|
898
919
|
* @param store A reference to the Store that is completing a transaction.
|
|
899
920
|
* @category Listener
|
|
921
|
+
* @since v1.0.0
|
|
900
922
|
*/
|
|
901
923
|
export type TransactionListener<
|
|
902
924
|
Schemas extends OptionalSchemas,
|
|
@@ -959,6 +981,7 @@ export type HasTablesListener<
|
|
|
959
981
|
* @param getCellChange A function that returns information about any Cell's
|
|
960
982
|
* changes.
|
|
961
983
|
* @category Listener
|
|
984
|
+
* @since v1.0.0
|
|
962
985
|
*/
|
|
963
986
|
export type TablesListener<
|
|
964
987
|
Schemas extends OptionalSchemas,
|
|
@@ -992,6 +1015,7 @@ export type TablesListener<
|
|
|
992
1015
|
* @param getIdChanges A function that returns information about the Id changes,
|
|
993
1016
|
* since v3.3.
|
|
994
1017
|
* @category Listener
|
|
1018
|
+
* @since v1.0.0
|
|
995
1019
|
*/
|
|
996
1020
|
export type TableIdsListener<
|
|
997
1021
|
Schemas extends OptionalSchemas,
|
|
@@ -1069,6 +1093,7 @@ export type HasTableListener<
|
|
|
1069
1093
|
* @param getCellChange A function that returns information about any Cell's
|
|
1070
1094
|
* changes.
|
|
1071
1095
|
* @category Listener
|
|
1096
|
+
* @since v1.0.0
|
|
1072
1097
|
*/
|
|
1073
1098
|
export type TableListener<
|
|
1074
1099
|
Schemas extends OptionalSchemas,
|
|
@@ -1267,6 +1292,7 @@ export type RowCountListener<
|
|
|
1267
1292
|
* @param getIdChanges A function that returns information about the Id changes,
|
|
1268
1293
|
* since v3.3.
|
|
1269
1294
|
* @category Listener
|
|
1295
|
+
* @since v1.0.0
|
|
1270
1296
|
*/
|
|
1271
1297
|
export type RowIdsListener<
|
|
1272
1298
|
Schemas extends OptionalSchemas,
|
|
@@ -1410,6 +1436,7 @@ export type HasRowListener<
|
|
|
1410
1436
|
* @param getCellChange A function that returns information about any Cell's
|
|
1411
1437
|
* changes.
|
|
1412
1438
|
* @category Listener
|
|
1439
|
+
* @since v1.0.0
|
|
1413
1440
|
*/
|
|
1414
1441
|
export type RowListener<
|
|
1415
1442
|
Schemas extends OptionalSchemas,
|
|
@@ -1454,6 +1481,7 @@ export type RowListener<
|
|
|
1454
1481
|
* @param getIdChanges A function that returns information about the Id changes,
|
|
1455
1482
|
* since v3.3.
|
|
1456
1483
|
* @category Listener
|
|
1484
|
+
* @since v1.0.0
|
|
1457
1485
|
*/
|
|
1458
1486
|
export type CellIdsListener<
|
|
1459
1487
|
Schemas extends OptionalSchemas,
|
|
@@ -1608,6 +1636,7 @@ export type HasCellListener<
|
|
|
1608
1636
|
* @param getCellChange A function that returns information about any Cell's
|
|
1609
1637
|
* changes.
|
|
1610
1638
|
* @category Listener
|
|
1639
|
+
* @since v1.0.0
|
|
1611
1640
|
*/
|
|
1612
1641
|
export type CellListener<
|
|
1613
1642
|
Schemas extends OptionalSchemas,
|
|
@@ -1728,6 +1757,7 @@ export type HasValuesListener<
|
|
|
1728
1757
|
* @param getValueChange A function that returns information about any Value's
|
|
1729
1758
|
* changes.
|
|
1730
1759
|
* @category Listener
|
|
1760
|
+
* @since v1.0.0
|
|
1731
1761
|
*/
|
|
1732
1762
|
export type ValuesListener<
|
|
1733
1763
|
Schemas extends OptionalSchemas,
|
|
@@ -1761,6 +1791,7 @@ export type ValuesListener<
|
|
|
1761
1791
|
* @param getIdChanges A function that returns information about the Id changes,
|
|
1762
1792
|
* since v3.3.
|
|
1763
1793
|
* @category Listener
|
|
1794
|
+
* @since v1.0.0
|
|
1764
1795
|
*/
|
|
1765
1796
|
export type ValueIdsListener<
|
|
1766
1797
|
Schemas extends OptionalSchemas,
|
|
@@ -2000,6 +2031,7 @@ export type GetIdChanges<ValidId extends Id> = () => {
|
|
|
2000
2031
|
* @param cellId The Id of the Cell to inspect.
|
|
2001
2032
|
* @returns A CellChange array containing information about the Cell's changes.
|
|
2002
2033
|
* @category Listener
|
|
2034
|
+
* @since v1.0.0
|
|
2003
2035
|
*/
|
|
2004
2036
|
export type GetCellChange<Schema extends OptionalTablesSchema> = <
|
|
2005
2037
|
TableId extends TableIdFromSchema<Schema>,
|
|
@@ -2028,6 +2060,7 @@ export type GetCellChange<Schema extends OptionalTablesSchema> = <
|
|
|
2028
2060
|
* the current transaction, the new value after it, and a convenience flag that
|
|
2029
2061
|
* indicates that the value has changed.
|
|
2030
2062
|
* @category Listener
|
|
2063
|
+
* @since v1.0.0
|
|
2031
2064
|
*/
|
|
2032
2065
|
export type CellChange<
|
|
2033
2066
|
Schema extends OptionalTablesSchema,
|
|
@@ -2054,6 +2087,7 @@ export type CellChange<
|
|
|
2054
2087
|
* @returns A ValueChange array containing information about the Value's
|
|
2055
2088
|
* changes.
|
|
2056
2089
|
* @category Listener
|
|
2090
|
+
* @since v1.0.0
|
|
2057
2091
|
*/
|
|
2058
2092
|
export type GetValueChange<Schema extends OptionalValuesSchema> = <
|
|
2059
2093
|
ValueId extends ValueIdFromSchema<Schema>,
|
|
@@ -2079,6 +2113,7 @@ export type GetValueChange<Schema extends OptionalValuesSchema> = <
|
|
|
2079
2113
|
* before the current transaction, the new value after it, and a convenience
|
|
2080
2114
|
* flag that indicates that the value has changed.
|
|
2081
2115
|
* @category Listener
|
|
2116
|
+
* @since v1.0.0
|
|
2082
2117
|
*/
|
|
2083
2118
|
export type ValueChange<
|
|
2084
2119
|
Schema extends OptionalValuesSchema,
|
|
@@ -2421,111 +2456,158 @@ export type TransactionLog<Schemas extends OptionalSchemas> = {
|
|
|
2421
2456
|
* listener. Totals include both mutator and non-mutator listeners. A
|
|
2422
2457
|
* StoreListenerStats object is returned from the getListenerStats method.
|
|
2423
2458
|
* @category Development
|
|
2459
|
+
* @since v1.0.0
|
|
2424
2460
|
*/
|
|
2425
2461
|
export type StoreListenerStats = {
|
|
2426
2462
|
/**
|
|
2427
2463
|
* The number of HasTablesListener functions registered with the Store, since
|
|
2428
2464
|
* v4.4.
|
|
2465
|
+
* @category Stat
|
|
2466
|
+
* @since v1.0.0
|
|
2429
2467
|
*/
|
|
2430
2468
|
hasTables: number;
|
|
2431
2469
|
/**
|
|
2432
2470
|
* The number of TablesListener functions registered with the Store.
|
|
2471
|
+
* @category Stat
|
|
2472
|
+
* @since v1.0.0
|
|
2433
2473
|
*/
|
|
2434
2474
|
tables: number;
|
|
2435
2475
|
/**
|
|
2436
2476
|
* The number of TableIdsListener functions registered with the Store.
|
|
2477
|
+
* @category Stat
|
|
2478
|
+
* @since v1.0.0
|
|
2437
2479
|
*/
|
|
2438
2480
|
tableIds: number;
|
|
2439
2481
|
/**
|
|
2440
2482
|
* The number of HasTableListener functions registered with the Store, since
|
|
2441
2483
|
* v4.4.
|
|
2484
|
+
* @category Stat
|
|
2485
|
+
* @since v1.0.0
|
|
2442
2486
|
*/
|
|
2443
2487
|
hasTable: number;
|
|
2444
2488
|
/**
|
|
2445
2489
|
* The number of TableListener functions registered with the Store.
|
|
2490
|
+
* @category Stat
|
|
2491
|
+
* @since v1.0.0
|
|
2446
2492
|
*/
|
|
2447
2493
|
table: number;
|
|
2448
2494
|
/**
|
|
2449
2495
|
* The number of TableCellIdsListener functions registered with the Store,
|
|
2450
2496
|
* since v3.3.
|
|
2497
|
+
* @category Stat
|
|
2498
|
+
* @since v1.0.0
|
|
2451
2499
|
*/
|
|
2452
2500
|
tableCellIds: number;
|
|
2453
2501
|
/**
|
|
2454
2502
|
* The number of HasTableCellListener functions registered with the Store,
|
|
2455
2503
|
* since v4.4.
|
|
2504
|
+
* @category Stat
|
|
2505
|
+
* @since v1.0.0
|
|
2456
2506
|
*/
|
|
2457
2507
|
hasTableCell: number;
|
|
2458
2508
|
/**
|
|
2459
2509
|
* The number of RowCountListener functions registered with the Store, since
|
|
2460
2510
|
* v4.1.0.
|
|
2511
|
+
* @category Stat
|
|
2512
|
+
* @since v1.0.0
|
|
2461
2513
|
*/
|
|
2462
2514
|
rowCount: number;
|
|
2463
2515
|
/**
|
|
2464
2516
|
* The number of RowIdsListener functions registered with the Store.
|
|
2517
|
+
* @category Stat
|
|
2518
|
+
* @since v1.0.0
|
|
2465
2519
|
*/
|
|
2466
2520
|
rowIds: number;
|
|
2467
2521
|
/**
|
|
2468
2522
|
* The number of SortedRowIdsListener functions registered with the Store.
|
|
2523
|
+
* @category Stat
|
|
2524
|
+
* @since v1.0.0
|
|
2469
2525
|
*/
|
|
2470
2526
|
sortedRowIds: number;
|
|
2471
2527
|
/**
|
|
2472
2528
|
* The number of HasRowListener functions registered with the Store, since
|
|
2473
2529
|
* v4.4.
|
|
2530
|
+
* @category Stat
|
|
2531
|
+
* @since v1.0.0
|
|
2474
2532
|
*/
|
|
2475
2533
|
hasRow: number;
|
|
2476
2534
|
/**
|
|
2477
2535
|
* The number of RowListener functions registered with the Store.
|
|
2536
|
+
* @category Stat
|
|
2537
|
+
* @since v1.0.0
|
|
2478
2538
|
*/
|
|
2479
2539
|
row: number;
|
|
2480
2540
|
/**
|
|
2481
2541
|
* The number of CellIdsListener functions registered with the Store.
|
|
2542
|
+
* @category Stat
|
|
2543
|
+
* @since v1.0.0
|
|
2482
2544
|
*/
|
|
2483
2545
|
cellIds: number;
|
|
2484
2546
|
/**
|
|
2485
2547
|
* The number of HasCellListener functions registered with the Store, since
|
|
2486
2548
|
* v4.4.
|
|
2549
|
+
* @category Stat
|
|
2550
|
+
* @since v1.0.0
|
|
2487
2551
|
*/
|
|
2488
2552
|
hasCell: number;
|
|
2489
2553
|
/**
|
|
2490
2554
|
* The number of CellListener functions registered with the Store.
|
|
2555
|
+
* @category Stat
|
|
2556
|
+
* @since v1.0.0
|
|
2491
2557
|
*/
|
|
2492
2558
|
cell: number;
|
|
2493
2559
|
/**
|
|
2494
2560
|
* The number of InvalidCellListener functions registered with the Store.
|
|
2561
|
+
* @category Stat
|
|
2562
|
+
* @since v1.0.0
|
|
2495
2563
|
*/
|
|
2496
2564
|
invalidCell: number;
|
|
2497
2565
|
/**
|
|
2498
2566
|
* The number of HasValuesListener functions registered with the Store, since
|
|
2499
2567
|
* v4.4.
|
|
2568
|
+
* @category Stat
|
|
2569
|
+
* @since v1.0.0
|
|
2500
2570
|
*/
|
|
2501
2571
|
hasValues: number;
|
|
2502
2572
|
/**
|
|
2503
2573
|
* The number of ValuesListener functions registered with the Store, since
|
|
2504
2574
|
* v3.0.
|
|
2575
|
+
* @category Stat
|
|
2576
|
+
* @since v1.0.0
|
|
2505
2577
|
*/
|
|
2506
2578
|
values: number;
|
|
2507
2579
|
/**
|
|
2508
2580
|
* The number of ValueIdsListener functions registered with the Store, since
|
|
2509
2581
|
* v3.0.
|
|
2582
|
+
* @category Stat
|
|
2583
|
+
* @since v1.0.0
|
|
2510
2584
|
*/
|
|
2511
2585
|
valueIds: number;
|
|
2512
2586
|
/**
|
|
2513
2587
|
* The number of HasValueListener functions registered with the Store, since
|
|
2514
2588
|
* v4.4.
|
|
2589
|
+
* @category Stat
|
|
2590
|
+
* @since v1.0.0
|
|
2515
2591
|
*/
|
|
2516
2592
|
hasValue: number;
|
|
2517
2593
|
/**
|
|
2518
2594
|
* The number of ValueListener functions registered with the Store, since
|
|
2519
2595
|
* v3.0.
|
|
2596
|
+
* @category Stat
|
|
2597
|
+
* @since v1.0.0
|
|
2520
2598
|
*/
|
|
2521
2599
|
value: number;
|
|
2522
2600
|
/**
|
|
2523
2601
|
* The number of InvalidValueListener functions registered with the Store,
|
|
2524
2602
|
* since v3.0.
|
|
2603
|
+
* @category Stat
|
|
2604
|
+
* @since v1.0.0
|
|
2525
2605
|
*/
|
|
2526
2606
|
invalidValue: number;
|
|
2527
2607
|
/**
|
|
2528
2608
|
* The number of TransactionListener functions registered with the Store.
|
|
2609
|
+
* @category Stat
|
|
2610
|
+
* @since v1.0.0
|
|
2529
2611
|
*/
|
|
2530
2612
|
transaction: number;
|
|
2531
2613
|
};
|
|
@@ -2714,6 +2796,7 @@ export type StoreListenerStats = {
|
|
|
2714
2796
|
* @see Hello World demos
|
|
2715
2797
|
* @see Todo App demos
|
|
2716
2798
|
* @category Store
|
|
2799
|
+
* @since v1.0.0
|
|
2717
2800
|
*/
|
|
2718
2801
|
export interface Store<in out Schemas extends OptionalSchemas> {
|
|
2719
2802
|
/**
|
|
@@ -2797,6 +2880,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
2797
2880
|
* // -> {}
|
|
2798
2881
|
* ```
|
|
2799
2882
|
* @category Getter
|
|
2883
|
+
* @since v1.0.0
|
|
2800
2884
|
*/
|
|
2801
2885
|
getTables(): Tables<Schemas[0]>;
|
|
2802
2886
|
|
|
@@ -2837,6 +2921,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
2837
2921
|
* // -> []
|
|
2838
2922
|
* ```
|
|
2839
2923
|
* @category Getter
|
|
2924
|
+
* @since v1.0.0
|
|
2840
2925
|
*/
|
|
2841
2926
|
getTableIds(): TableIdFromSchema<Schemas[0]>[];
|
|
2842
2927
|
|
|
@@ -2880,6 +2965,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
2880
2965
|
* // -> {}
|
|
2881
2966
|
* ```
|
|
2882
2967
|
* @category Getter
|
|
2968
|
+
* @since v1.0.0
|
|
2883
2969
|
*/
|
|
2884
2970
|
getTable<TableId extends TableIdFromSchema<Schemas[0]>>(
|
|
2885
2971
|
tableId: TableId,
|
|
@@ -3019,6 +3105,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
3019
3105
|
* // -> []
|
|
3020
3106
|
* ```
|
|
3021
3107
|
* @category Getter
|
|
3108
|
+
* @since v1.0.0
|
|
3022
3109
|
*/
|
|
3023
3110
|
getRowIds(tableId: TableIdFromSchema<Schemas[0]>): Ids;
|
|
3024
3111
|
|
|
@@ -3193,6 +3280,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
3193
3280
|
* // -> {}
|
|
3194
3281
|
* ```
|
|
3195
3282
|
* @category Getter
|
|
3283
|
+
* @since v1.0.0
|
|
3196
3284
|
*/
|
|
3197
3285
|
getRow<TableId extends TableIdFromSchema<Schemas[0]>>(
|
|
3198
3286
|
tableId: TableId,
|
|
@@ -3240,6 +3328,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
3240
3328
|
* // -> []
|
|
3241
3329
|
* ```
|
|
3242
3330
|
* @category Getter
|
|
3331
|
+
* @since v1.0.0
|
|
3243
3332
|
*/
|
|
3244
3333
|
getCellIds<TableId extends TableIdFromSchema<Schemas[0]>>(
|
|
3245
3334
|
tableId: TableId,
|
|
@@ -3282,6 +3371,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
3282
3371
|
* // -> undefined
|
|
3283
3372
|
* ```
|
|
3284
3373
|
* @category Getter
|
|
3374
|
+
* @since v1.0.0
|
|
3285
3375
|
*/
|
|
3286
3376
|
getCell<
|
|
3287
3377
|
TableId extends TableIdFromSchema<Schemas[0]>,
|
|
@@ -3425,6 +3515,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
3425
3515
|
* // -> true
|
|
3426
3516
|
* ```
|
|
3427
3517
|
* @category Getter
|
|
3518
|
+
* @since v1.0.0
|
|
3428
3519
|
*/
|
|
3429
3520
|
hasTables(): boolean;
|
|
3430
3521
|
|
|
@@ -3452,6 +3543,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
3452
3543
|
* // -> false
|
|
3453
3544
|
* ```
|
|
3454
3545
|
* @category Getter
|
|
3546
|
+
* @since v1.0.0
|
|
3455
3547
|
*/
|
|
3456
3548
|
hasTable(tableId: TableIdFromSchema<Schemas[0]>): boolean;
|
|
3457
3549
|
|
|
@@ -3516,6 +3608,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
3516
3608
|
* // -> false
|
|
3517
3609
|
* ```
|
|
3518
3610
|
* @category Getter
|
|
3611
|
+
* @since v1.0.0
|
|
3519
3612
|
*/
|
|
3520
3613
|
hasRow(tableId: TableIdFromSchema<Schemas[0]>, rowId: Id): boolean;
|
|
3521
3614
|
|
|
@@ -3545,6 +3638,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
3545
3638
|
* // -> false
|
|
3546
3639
|
* ```
|
|
3547
3640
|
* @category Getter
|
|
3641
|
+
* @since v1.0.0
|
|
3548
3642
|
*/
|
|
3549
3643
|
hasCell<TableId extends TableIdFromSchema<Schemas[0]>>(
|
|
3550
3644
|
tableId: TableId,
|
|
@@ -3692,6 +3786,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
3692
3786
|
* // -> '[{},{}]'
|
|
3693
3787
|
* ```
|
|
3694
3788
|
* @category Getter
|
|
3789
|
+
* @since v1.0.0
|
|
3695
3790
|
*/
|
|
3696
3791
|
getJson(): Json;
|
|
3697
3792
|
|
|
@@ -3808,6 +3903,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
3808
3903
|
* // -> '[{},{}]'
|
|
3809
3904
|
* ```
|
|
3810
3905
|
* @category Getter
|
|
3906
|
+
* @since v1.0.0
|
|
3811
3907
|
*/
|
|
3812
3908
|
getSchemaJson(): Json;
|
|
3813
3909
|
|
|
@@ -3986,6 +4082,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
3986
4082
|
* // -> {pets: {felix: {species: 'cat'}}}
|
|
3987
4083
|
* ```
|
|
3988
4084
|
* @category Setter
|
|
4085
|
+
* @since v1.0.0
|
|
3989
4086
|
*/
|
|
3990
4087
|
setTables(tables: Tables<Schemas[0], true>): this;
|
|
3991
4088
|
|
|
@@ -4047,6 +4144,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
4047
4144
|
* // -> {pets: {felix: {species: 'cat'}}}
|
|
4048
4145
|
* ```
|
|
4049
4146
|
* @category Setter
|
|
4147
|
+
* @since v1.0.0
|
|
4050
4148
|
*/
|
|
4051
4149
|
setTable<TableId extends TableIdFromSchema<Schemas[0]>>(
|
|
4052
4150
|
tableId: TableId,
|
|
@@ -4109,6 +4207,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
4109
4207
|
* // -> {pets: {fido: {color: 'brown'}}}
|
|
4110
4208
|
* ```
|
|
4111
4209
|
* @category Setter
|
|
4210
|
+
* @since v1.0.0
|
|
4112
4211
|
*/
|
|
4113
4212
|
setRow<TableId extends TableIdFromSchema<Schemas[0]>>(
|
|
4114
4213
|
tableId: TableId,
|
|
@@ -4184,6 +4283,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
4184
4283
|
* // -> {pets: {'0': {species: 'dog'}, '1': {species: 'cat'}}}
|
|
4185
4284
|
* ```
|
|
4186
4285
|
* @category Setter
|
|
4286
|
+
* @since v1.0.0
|
|
4187
4287
|
*/
|
|
4188
4288
|
addRow<TableId extends TableIdFromSchema<Schemas[0]>>(
|
|
4189
4289
|
tableId: TableId,
|
|
@@ -4249,6 +4349,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
4249
4349
|
* // -> {pets: {fido: {species: 'dog', color: 'brown'}}}
|
|
4250
4350
|
* ```
|
|
4251
4351
|
* @category Setter
|
|
4352
|
+
* @since v1.0.0
|
|
4252
4353
|
*/
|
|
4253
4354
|
setPartialRow<TableId extends TableIdFromSchema<Schemas[0]>>(
|
|
4254
4355
|
tableId: TableId,
|
|
@@ -4322,6 +4423,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
4322
4423
|
* // -> {pets: {fido: {species: 'dog'}}}
|
|
4323
4424
|
* ```
|
|
4324
4425
|
* @category Setter
|
|
4426
|
+
* @since v1.0.0
|
|
4325
4427
|
*/
|
|
4326
4428
|
setCell<
|
|
4327
4429
|
TableId extends TableIdFromSchema<Schemas[0]>,
|
|
@@ -4702,6 +4804,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
4702
4804
|
* // -> {}
|
|
4703
4805
|
* ```
|
|
4704
4806
|
* @category Setter
|
|
4807
|
+
* @since v1.0.0
|
|
4705
4808
|
*/
|
|
4706
4809
|
setJson(tablesAndValuesJson: Json): this;
|
|
4707
4810
|
|
|
@@ -4851,6 +4954,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
4851
4954
|
* // -> {pets: {0: {species: 'dog', sold: false}}}
|
|
4852
4955
|
* ```
|
|
4853
4956
|
* @category Setter
|
|
4957
|
+
* @since v1.0.0
|
|
4854
4958
|
*/
|
|
4855
4959
|
setSchema<TS extends TablesSchema, VS extends ValuesSchema>(
|
|
4856
4960
|
tablesSchema: TS,
|
|
@@ -4880,6 +4984,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
4880
4984
|
* // -> {}
|
|
4881
4985
|
* ```
|
|
4882
4986
|
* @category Deleter
|
|
4987
|
+
* @since v1.0.0
|
|
4883
4988
|
*/
|
|
4884
4989
|
delTables(): this;
|
|
4885
4990
|
|
|
@@ -4909,6 +5014,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
4909
5014
|
* // -> {species: {dog: {price: 5}}}
|
|
4910
5015
|
* ```
|
|
4911
5016
|
* @category Deleter
|
|
5017
|
+
* @since v1.0.0
|
|
4912
5018
|
*/
|
|
4913
5019
|
delTable(tableId: TableIdFromSchema<Schemas[0]>): this;
|
|
4914
5020
|
|
|
@@ -4940,6 +5046,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
4940
5046
|
* // -> {pets: {felix: {species: 'cat'}}}
|
|
4941
5047
|
* ```
|
|
4942
5048
|
* @category Deleter
|
|
5049
|
+
* @since v1.0.0
|
|
4943
5050
|
*/
|
|
4944
5051
|
delRow(tableId: TableIdFromSchema<Schemas[0]>, rowId: Id): this;
|
|
4945
5052
|
|
|
@@ -5035,6 +5142,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
5035
5142
|
* // -> {pets: {felix: {species: 'cat', sold: false}}}
|
|
5036
5143
|
* ```
|
|
5037
5144
|
* @category Deleter
|
|
5145
|
+
* @since v1.0.0
|
|
5038
5146
|
*/
|
|
5039
5147
|
delCell<TableId extends TableIdFromSchema<Schemas[0]>>(
|
|
5040
5148
|
tableId: TableId,
|
|
@@ -5157,6 +5265,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
5157
5265
|
* // -> '{}'
|
|
5158
5266
|
* ```
|
|
5159
5267
|
* @category Deleter
|
|
5268
|
+
* @since v1.0.0
|
|
5160
5269
|
*/
|
|
5161
5270
|
delTablesSchema<
|
|
5162
5271
|
ValuesSchema extends OptionalValuesSchema = Schemas[1],
|
|
@@ -5360,6 +5469,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
5360
5469
|
* // -> {open: true}
|
|
5361
5470
|
* ```
|
|
5362
5471
|
* @category Transaction
|
|
5472
|
+
* @since v1.0.0
|
|
5363
5473
|
*/
|
|
5364
5474
|
transaction<Return>(
|
|
5365
5475
|
actions: () => Return,
|
|
@@ -5655,6 +5765,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
5655
5765
|
* // -> '- dog'
|
|
5656
5766
|
* ```
|
|
5657
5767
|
* @category Iterator
|
|
5768
|
+
* @since v1.0.0
|
|
5658
5769
|
*/
|
|
5659
5770
|
forEachTable(tableCallback: TableCallback<Schemas[0]>): void;
|
|
5660
5771
|
|
|
@@ -5737,6 +5848,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
5737
5848
|
* // -> '- color'
|
|
5738
5849
|
* ```
|
|
5739
5850
|
* @category Iterator
|
|
5851
|
+
* @since v1.0.0
|
|
5740
5852
|
*/
|
|
5741
5853
|
forEachRow<TableId extends TableIdFromSchema<Schemas[0]>>(
|
|
5742
5854
|
tableId: TableId,
|
|
@@ -5775,6 +5887,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
5775
5887
|
* // -> 'color: brown'
|
|
5776
5888
|
* ```
|
|
5777
5889
|
* @category Iterator
|
|
5890
|
+
* @since v1.0.0
|
|
5778
5891
|
*/
|
|
5779
5892
|
forEachCell<TableId extends TableIdFromSchema<Schemas[0]>>(
|
|
5780
5893
|
tableId: TableId,
|
|
@@ -5965,6 +6078,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
5965
6078
|
* store.delListener(listenerId);
|
|
5966
6079
|
* ```
|
|
5967
6080
|
* @category Listener
|
|
6081
|
+
* @since v1.0.0
|
|
5968
6082
|
*/
|
|
5969
6083
|
addTablesListener(
|
|
5970
6084
|
listener: TablesListener<Schemas, this>,
|
|
@@ -6040,6 +6154,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
6040
6154
|
* store.delListener(listenerId);
|
|
6041
6155
|
* ```
|
|
6042
6156
|
* @category Listener
|
|
6157
|
+
* @since v1.0.0
|
|
6043
6158
|
*/
|
|
6044
6159
|
addTableIdsListener(
|
|
6045
6160
|
listener: TableIdsListener<Schemas, this>,
|
|
@@ -6270,6 +6385,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
6270
6385
|
* store.delListener(listenerId);
|
|
6271
6386
|
* ```
|
|
6272
6387
|
* @category Listener
|
|
6388
|
+
* @since v1.0.0
|
|
6273
6389
|
*/
|
|
6274
6390
|
addTableListener<TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null>(
|
|
6275
6391
|
tableId: TableIdOrNull,
|
|
@@ -6390,6 +6506,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
6390
6506
|
* store.delListener(listenerId);
|
|
6391
6507
|
* ```
|
|
6392
6508
|
* @category Listener
|
|
6509
|
+
* @since v1.0.0
|
|
6393
6510
|
*/
|
|
6394
6511
|
addTableCellIdsListener<
|
|
6395
6512
|
TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
|
|
@@ -6753,6 +6870,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
6753
6870
|
* store.delListener(listenerId);
|
|
6754
6871
|
* ```
|
|
6755
6872
|
* @category Listener
|
|
6873
|
+
* @since v1.0.0
|
|
6756
6874
|
*/
|
|
6757
6875
|
addRowIdsListener<TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null>(
|
|
6758
6876
|
tableId: TableIdOrNull,
|
|
@@ -7278,6 +7396,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
7278
7396
|
* store.delListener(listenerId);
|
|
7279
7397
|
* ```
|
|
7280
7398
|
* @category Listener
|
|
7399
|
+
* @since v1.0.0
|
|
7281
7400
|
*/
|
|
7282
7401
|
addRowListener<
|
|
7283
7402
|
TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
|
|
@@ -7403,6 +7522,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
7403
7522
|
* store.delListener(listenerId);
|
|
7404
7523
|
* ```
|
|
7405
7524
|
* @category Listener
|
|
7525
|
+
* @since v1.0.0
|
|
7406
7526
|
*/
|
|
7407
7527
|
addCellIdsListener<
|
|
7408
7528
|
TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
|
|
@@ -7698,6 +7818,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
7698
7818
|
* store.delListener(listenerId);
|
|
7699
7819
|
* ```
|
|
7700
7820
|
* @category Listener
|
|
7821
|
+
* @since v1.0.0
|
|
7701
7822
|
*/
|
|
7702
7823
|
addCellListener<
|
|
7703
7824
|
TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
|
|
@@ -8999,6 +9120,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
8999
9120
|
* store.delListener(listenerId2);
|
|
9000
9121
|
* ```
|
|
9001
9122
|
* @category Listener
|
|
9123
|
+
* @since v1.0.0
|
|
9002
9124
|
*/
|
|
9003
9125
|
callListener(listenerId: Id): this;
|
|
9004
9126
|
|
|
@@ -9033,6 +9155,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
9033
9155
|
* // The listener is not called.
|
|
9034
9156
|
* ```
|
|
9035
9157
|
* @category Listener
|
|
9158
|
+
* @since v1.0.0
|
|
9036
9159
|
*/
|
|
9037
9160
|
delListener(listenerId: Id): this;
|
|
9038
9161
|
|
|
@@ -9063,6 +9186,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
9063
9186
|
* // -> 1
|
|
9064
9187
|
* ```
|
|
9065
9188
|
* @category Development
|
|
9189
|
+
* @since v1.0.0
|
|
9066
9190
|
*/
|
|
9067
9191
|
getListenerStats(): StoreListenerStats;
|
|
9068
9192
|
|
|
@@ -9128,5 +9252,6 @@ export interface Store<in out Schemas extends OptionalSchemas> {
|
|
|
9128
9252
|
* ```
|
|
9129
9253
|
* @see The Basics guides
|
|
9130
9254
|
* @category Creation
|
|
9255
|
+
* @since v1.0.0
|
|
9131
9256
|
*/
|
|
9132
9257
|
export function createStore(): Store<NoSchemas>;
|