tinybase 8.2.0-beta.0 → 8.2.0-beta.2
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/persisters/index.d.ts +1 -1
- package/@types/persisters/persister-durable-object-sql-storage/index.d.ts +6 -6
- package/@types/persisters/persister-durable-object-sql-storage/with-schemas/index.d.ts +6 -6
- package/@types/persisters/persister-durable-object-storage/index.d.ts +2 -2
- package/@types/persisters/persister-durable-object-storage/with-schemas/index.d.ts +2 -2
- package/@types/persisters/persister-electric-sql/index.d.ts +3 -3
- package/@types/persisters/persister-electric-sql/with-schemas/index.d.ts +3 -3
- package/@types/persisters/persister-expo-sqlite/index.d.ts +3 -3
- package/@types/persisters/persister-expo-sqlite/with-schemas/index.d.ts +3 -3
- package/@types/persisters/persister-file/index.d.ts +1 -1
- package/@types/persisters/persister-file/with-schemas/index.d.ts +1 -1
- package/@types/persisters/persister-libsql/index.d.ts +3 -3
- package/@types/persisters/persister-libsql/with-schemas/index.d.ts +3 -3
- package/@types/persisters/persister-partykit-client/index.d.ts +2 -2
- package/@types/persisters/persister-partykit-client/with-schemas/index.d.ts +2 -2
- package/@types/persisters/persister-powersync/index.d.ts +3 -3
- package/@types/persisters/persister-powersync/with-schemas/index.d.ts +3 -3
- package/@types/persisters/persister-react-native-mmkv/index.d.ts +2 -2
- package/@types/persisters/persister-react-native-mmkv/with-schemas/index.d.ts +2 -2
- package/@types/persisters/persister-react-native-sqlite/index.d.ts +3 -3
- package/@types/persisters/persister-react-native-sqlite/with-schemas/index.d.ts +3 -3
- package/@types/persisters/persister-remote/index.d.ts +1 -1
- package/@types/persisters/persister-remote/with-schemas/index.d.ts +1 -1
- package/@types/persisters/with-schemas/index.d.ts +1 -1
- package/@types/synchronizers/synchronizer-ws-server-durable-object/index.d.ts +7 -7
- package/@types/synchronizers/synchronizer-ws-server-durable-object/with-schemas/index.d.ts +7 -7
- package/@types/ui-react/index.d.ts +3 -3
- package/@types/ui-react/with-schemas/index.d.ts +3 -3
- package/@types/ui-react-dom/index.d.ts +52 -13
- package/@types/ui-react-dom/with-schemas/index.d.ts +52 -13
- package/@types/ui-react-inspector/index.d.ts +7 -4
- package/@types/ui-react-inspector/with-schemas/index.d.ts +7 -4
- package/@types/ui-svelte-dom/index.d.ts +2139 -0
- package/@types/ui-svelte-dom/with-schemas/index.d.ts +2186 -0
- package/@types/ui-svelte-inspector/index.d.ts +73 -0
- package/@types/ui-svelte-inspector/with-schemas/index.d.ts +73 -0
- package/agents.md +23 -12
- package/min/ui-react-inspector/index.js +1 -1
- package/min/ui-react-inspector/index.js.gz +0 -0
- package/min/ui-react-inspector/with-schemas/index.js +1 -1
- package/min/ui-react-inspector/with-schemas/index.js.gz +0 -0
- package/min/ui-svelte-dom/index.js +1 -0
- package/min/ui-svelte-dom/index.js.gz +0 -0
- package/min/ui-svelte-dom/with-schemas/index.js +1 -0
- package/min/ui-svelte-dom/with-schemas/index.js.gz +0 -0
- package/min/ui-svelte-inspector/index.js +1 -0
- package/min/ui-svelte-inspector/index.js.gz +0 -0
- package/min/ui-svelte-inspector/with-schemas/index.js +1 -0
- package/min/ui-svelte-inspector/with-schemas/index.js.gz +0 -0
- package/package.json +85 -13
- package/readme.md +14 -14
- package/releases.md +101 -67
- package/ui-react-inspector/index.js +4676 -4657
- package/ui-react-inspector/with-schemas/index.js +4676 -4657
- package/ui-svelte/index.js +1 -1
- package/ui-svelte/with-schemas/index.js +1 -1
- package/ui-svelte-dom/index.js +2441 -0
- package/ui-svelte-dom/with-schemas/index.js +2441 -0
- package/ui-svelte-inspector/index.js +7680 -0
- package/ui-svelte-inspector/with-schemas/index.js +7680 -0
|
@@ -1524,7 +1524,7 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
|
|
|
1524
1524
|
* Store and then sequences two tasks in order to update its data on a
|
|
1525
1525
|
* hypothetical remote system.
|
|
1526
1526
|
*
|
|
1527
|
-
* ```js
|
|
1527
|
+
* ```js ignore
|
|
1528
1528
|
* import {
|
|
1529
1529
|
* checkRemoteSystemIsReady,
|
|
1530
1530
|
* getDataFromRemoteSystem,
|
|
@@ -38,7 +38,7 @@ import type {DpcJson, Persister, Persists} from '../index.d.ts';
|
|
|
38
38
|
* This example shows how to configure a DurableObjectSqlStoragePersister to use
|
|
39
39
|
* fragmented mode with a custom storage prefix.
|
|
40
40
|
*
|
|
41
|
-
* ```js
|
|
41
|
+
* ```js ignore
|
|
42
42
|
* import {createMergeableStore} from 'tinybase';
|
|
43
43
|
* import {createDurableObjectSqlStoragePersister} from 'tinybase/persisters/persister-durable-object-sql-storage';
|
|
44
44
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
@@ -149,7 +149,7 @@ export interface DurableObjectSqlStoragePersister extends Persister<Persists.Mer
|
|
|
149
149
|
* (within the createPersister method of a WsServerDurableObject instance) and
|
|
150
150
|
* then gets the SQL storage reference back out again.
|
|
151
151
|
*
|
|
152
|
-
* ```js
|
|
152
|
+
* ```js ignore
|
|
153
153
|
* import {createMergeableStore} from 'tinybase';
|
|
154
154
|
* import {createDurableObjectSqlStoragePersister} from 'tinybase/persisters/persister-durable-object-sql-storage';
|
|
155
155
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
@@ -258,7 +258,7 @@ export interface DurableObjectSqlStoragePersister extends Persister<Persists.Mer
|
|
|
258
258
|
* default `tinybase` table. It uses this within the createPersister method of a
|
|
259
259
|
* WsServerDurableObject instance.
|
|
260
260
|
*
|
|
261
|
-
* ```js
|
|
261
|
+
* ```js ignore
|
|
262
262
|
* import {createMergeableStore} from 'tinybase';
|
|
263
263
|
* import {createDurableObjectSqlStoragePersister} from 'tinybase/persisters/persister-durable-object-sql-storage';
|
|
264
264
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
@@ -278,7 +278,7 @@ export interface DurableObjectSqlStoragePersister extends Persister<Persists.Mer
|
|
|
278
278
|
* This example creates a DurableObjectSqlStoragePersister object with a custom
|
|
279
279
|
* table name and SQL command logging for debugging.
|
|
280
280
|
*
|
|
281
|
-
* ```js
|
|
281
|
+
* ```js ignore
|
|
282
282
|
* import {createMergeableStore} from 'tinybase';
|
|
283
283
|
* import {createDurableObjectSqlStoragePersister} from 'tinybase/persisters/persister-durable-object-sql-storage';
|
|
284
284
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
@@ -301,7 +301,7 @@ export interface DurableObjectSqlStoragePersister extends Persister<Persists.Mer
|
|
|
301
301
|
* This example creates a DurableObjectSqlStoragePersister object using
|
|
302
302
|
* fragmented mode to avoid Cloudflare's 2MB row limit for large stores.
|
|
303
303
|
*
|
|
304
|
-
* ```js
|
|
304
|
+
* ```js ignore
|
|
305
305
|
* import {createMergeableStore} from 'tinybase';
|
|
306
306
|
* import {createDurableObjectSqlStoragePersister} from 'tinybase/persisters/persister-durable-object-sql-storage';
|
|
307
307
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
@@ -322,7 +322,7 @@ export interface DurableObjectSqlStoragePersister extends Persister<Persists.Mer
|
|
|
322
322
|
* This example creates a DurableObjectSqlStoragePersister object using
|
|
323
323
|
* fragmented mode with a custom storage prefix.
|
|
324
324
|
*
|
|
325
|
-
* ```js
|
|
325
|
+
* ```js ignore
|
|
326
326
|
* import {createMergeableStore} from 'tinybase';
|
|
327
327
|
* import {createDurableObjectSqlStoragePersister} from 'tinybase/persisters/persister-durable-object-sql-storage';
|
|
328
328
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
@@ -46,7 +46,7 @@ import type {
|
|
|
46
46
|
* This example shows how to configure a DurableObjectSqlStoragePersister to use
|
|
47
47
|
* fragmented mode with a custom storage prefix.
|
|
48
48
|
*
|
|
49
|
-
* ```js
|
|
49
|
+
* ```js ignore
|
|
50
50
|
* import {createMergeableStore} from 'tinybase';
|
|
51
51
|
* import {createDurableObjectSqlStoragePersister} from 'tinybase/persisters/persister-durable-object-sql-storage';
|
|
52
52
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
@@ -167,7 +167,7 @@ export interface DurableObjectSqlStoragePersister<
|
|
|
167
167
|
* (within the createPersister method of a WsServerDurableObject instance) and
|
|
168
168
|
* then gets the SQL storage reference back out again.
|
|
169
169
|
*
|
|
170
|
-
* ```js
|
|
170
|
+
* ```js ignore
|
|
171
171
|
* import {createMergeableStore} from 'tinybase';
|
|
172
172
|
* import {createDurableObjectSqlStoragePersister} from 'tinybase/persisters/persister-durable-object-sql-storage';
|
|
173
173
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
@@ -288,7 +288,7 @@ export interface DurableObjectSqlStoragePersister<
|
|
|
288
288
|
* default `tinybase` table. It uses this within the createPersister method of a
|
|
289
289
|
* WsServerDurableObject instance.
|
|
290
290
|
*
|
|
291
|
-
* ```js
|
|
291
|
+
* ```js ignore
|
|
292
292
|
* import {createMergeableStore} from 'tinybase';
|
|
293
293
|
* import {createDurableObjectSqlStoragePersister} from 'tinybase/persisters/persister-durable-object-sql-storage';
|
|
294
294
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
@@ -308,7 +308,7 @@ export interface DurableObjectSqlStoragePersister<
|
|
|
308
308
|
* This example creates a DurableObjectSqlStoragePersister object with a custom
|
|
309
309
|
* table name and SQL command logging for debugging.
|
|
310
310
|
*
|
|
311
|
-
* ```js
|
|
311
|
+
* ```js ignore
|
|
312
312
|
* import {createMergeableStore} from 'tinybase';
|
|
313
313
|
* import {createDurableObjectSqlStoragePersister} from 'tinybase/persisters/persister-durable-object-sql-storage';
|
|
314
314
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
@@ -331,7 +331,7 @@ export interface DurableObjectSqlStoragePersister<
|
|
|
331
331
|
* This example creates a DurableObjectSqlStoragePersister object using
|
|
332
332
|
* fragmented mode to avoid Cloudflare's 2MB row limit for large stores.
|
|
333
333
|
*
|
|
334
|
-
* ```js
|
|
334
|
+
* ```js ignore
|
|
335
335
|
* import {createMergeableStore} from 'tinybase';
|
|
336
336
|
* import {createDurableObjectSqlStoragePersister} from 'tinybase/persisters/persister-durable-object-sql-storage';
|
|
337
337
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
@@ -352,7 +352,7 @@ export interface DurableObjectSqlStoragePersister<
|
|
|
352
352
|
* This example creates a DurableObjectSqlStoragePersister object using
|
|
353
353
|
* fragmented mode with a custom storage prefix.
|
|
354
354
|
*
|
|
355
|
-
* ```js
|
|
355
|
+
* ```js ignore
|
|
356
356
|
* import {createMergeableStore} from 'tinybase';
|
|
357
357
|
* import {createDurableObjectSqlStoragePersister} from 'tinybase/persisters/persister-durable-object-sql-storage';
|
|
358
358
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
@@ -35,7 +35,7 @@ export interface DurableObjectStoragePersister extends Persister<Persists.Mergea
|
|
|
35
35
|
* (within the createPersister method of a WsServerDurableObject instance) and
|
|
36
36
|
* then gets the storage reference back out again.
|
|
37
37
|
*
|
|
38
|
-
* ```js
|
|
38
|
+
* ```js ignore
|
|
39
39
|
* import {createMergeableStore} from 'tinybase';
|
|
40
40
|
* import {createDurableObjectStoragePersister} from 'tinybase/persisters/persister-durable-object-storage';
|
|
41
41
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
@@ -94,7 +94,7 @@ export interface DurableObjectStoragePersister extends Persister<Persists.Mergea
|
|
|
94
94
|
* MergeableStore (within the createPersister method of a WsServerDurableObject
|
|
95
95
|
* instance) and then gets the storage reference back out again.
|
|
96
96
|
*
|
|
97
|
-
* ```js
|
|
97
|
+
* ```js ignore
|
|
98
98
|
* import {createMergeableStore} from 'tinybase';
|
|
99
99
|
* import {createDurableObjectStoragePersister} from 'tinybase/persisters/persister-durable-object-storage';
|
|
100
100
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
@@ -38,7 +38,7 @@ export interface DurableObjectStoragePersister<
|
|
|
38
38
|
* (within the createPersister method of a WsServerDurableObject instance) and
|
|
39
39
|
* then gets the storage reference back out again.
|
|
40
40
|
*
|
|
41
|
-
* ```js
|
|
41
|
+
* ```js ignore
|
|
42
42
|
* import {createMergeableStore} from 'tinybase';
|
|
43
43
|
* import {createDurableObjectStoragePersister} from 'tinybase/persisters/persister-durable-object-storage';
|
|
44
44
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
@@ -108,7 +108,7 @@ export interface DurableObjectStoragePersister<
|
|
|
108
108
|
* MergeableStore (within the createPersister method of a WsServerDurableObject
|
|
109
109
|
* instance) and then gets the storage reference back out again.
|
|
110
110
|
*
|
|
111
|
-
* ```js
|
|
111
|
+
* ```js ignore
|
|
112
112
|
* import {createMergeableStore} from 'tinybase';
|
|
113
113
|
* import {createDurableObjectStoragePersister} from 'tinybase/persisters/persister-durable-object-storage';
|
|
114
114
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
@@ -33,7 +33,7 @@ export interface ElectricSqlPersister extends Persister {
|
|
|
33
33
|
* This example creates a Persister object against a newly-created Store and
|
|
34
34
|
* then gets the Electric client back out again.
|
|
35
35
|
*
|
|
36
|
-
* ```js
|
|
36
|
+
* ```js ignore
|
|
37
37
|
* import {ElectricDatabase, electrify} from 'electric-sql/wa-sqlite';
|
|
38
38
|
* import {createStore} from 'tinybase';
|
|
39
39
|
* import {createElectricSqlPersister} from 'tinybase/persisters/persister-electric-sql';
|
|
@@ -106,7 +106,7 @@ export interface ElectricSqlPersister extends Persister {
|
|
|
106
106
|
* table. It makes a change to the database directly and then reloads it back
|
|
107
107
|
* into the Store.
|
|
108
108
|
*
|
|
109
|
-
* ```js
|
|
109
|
+
* ```js ignore
|
|
110
110
|
* import {ElectricDatabase, electrify} from 'electric-sql/wa-sqlite';
|
|
111
111
|
* import {createStore} from 'tinybase';
|
|
112
112
|
* import {createElectricSqlPersister} from 'tinybase/persisters/persister-electric-sql';
|
|
@@ -147,7 +147,7 @@ export interface ElectricSqlPersister extends Persister {
|
|
|
147
147
|
* This example creates a ElectricSqlPersister object and persists the Store to
|
|
148
148
|
* a local ElectricSql database with tabular mapping.
|
|
149
149
|
*
|
|
150
|
-
* ```js
|
|
150
|
+
* ```js ignore
|
|
151
151
|
* import {ElectricDatabase, electrify} from 'electric-sql/wa-sqlite';
|
|
152
152
|
* import {createStore} from 'tinybase';
|
|
153
153
|
* import {createElectricSqlPersister} from 'tinybase/persisters/persister-electric-sql';
|
|
@@ -41,7 +41,7 @@ export interface ElectricSqlPersister<
|
|
|
41
41
|
* This example creates a Persister object against a newly-created Store and
|
|
42
42
|
* then gets the Electric client back out again.
|
|
43
43
|
*
|
|
44
|
-
* ```js
|
|
44
|
+
* ```js ignore
|
|
45
45
|
* import {ElectricDatabase, electrify} from 'electric-sql/wa-sqlite';
|
|
46
46
|
* import {createStore} from 'tinybase';
|
|
47
47
|
* import {createElectricSqlPersister} from 'tinybase/persisters/persister-electric-sql';
|
|
@@ -126,7 +126,7 @@ export interface ElectricSqlPersister<
|
|
|
126
126
|
* table. It makes a change to the database directly and then reloads it back
|
|
127
127
|
* into the Store.
|
|
128
128
|
*
|
|
129
|
-
* ```js
|
|
129
|
+
* ```js ignore
|
|
130
130
|
* import {ElectricDatabase, electrify} from 'electric-sql/wa-sqlite';
|
|
131
131
|
* import {createStore} from 'tinybase';
|
|
132
132
|
* import {createElectricSqlPersister} from 'tinybase/persisters/persister-electric-sql';
|
|
@@ -167,7 +167,7 @@ export interface ElectricSqlPersister<
|
|
|
167
167
|
* This example creates a ElectricSqlPersister object and persists the Store to
|
|
168
168
|
* a local ElectricSql database with tabular mapping.
|
|
169
169
|
*
|
|
170
|
-
* ```js
|
|
170
|
+
* ```js ignore
|
|
171
171
|
* import {ElectricDatabase, electrify} from 'electric-sql/wa-sqlite';
|
|
172
172
|
* import {createStore} from 'tinybase';
|
|
173
173
|
* import {createElectricSqlPersister} from 'tinybase/persisters/persister-electric-sql';
|
|
@@ -41,7 +41,7 @@ export interface ExpoSqlitePersister extends Persister<Persists.StoreOrMergeable
|
|
|
41
41
|
* This example creates a Persister object against a newly-created Store and
|
|
42
42
|
* then gets the database instance back out again.
|
|
43
43
|
*
|
|
44
|
-
* ```js
|
|
44
|
+
* ```js ignore
|
|
45
45
|
* import {openDatabaseSync} from 'expo-sqlite';
|
|
46
46
|
* import {createStore} from 'tinybase';
|
|
47
47
|
* import {createExpoSqlitePersister} from 'tinybase/persisters/persister-expo-sqlite';
|
|
@@ -109,7 +109,7 @@ export interface ExpoSqlitePersister extends Persister<Persists.StoreOrMergeable
|
|
|
109
109
|
* table. It makes a change to the database directly and then reloads it back
|
|
110
110
|
* into the Store.
|
|
111
111
|
*
|
|
112
|
-
* ```js
|
|
112
|
+
* ```js ignore
|
|
113
113
|
* import {openDatabaseSync} from 'expo-sqlite';
|
|
114
114
|
* import {createStore} from 'tinybase';
|
|
115
115
|
* import {createExpoSqlitePersister} from 'tinybase/persisters/persister-expo-sqlite';
|
|
@@ -146,7 +146,7 @@ export interface ExpoSqlitePersister extends Persister<Persists.StoreOrMergeable
|
|
|
146
146
|
* This example creates a ExpoSqlitePersister object and persists the Store
|
|
147
147
|
* to a local SQLite database with tabular mapping.
|
|
148
148
|
*
|
|
149
|
-
* ```js
|
|
149
|
+
* ```js ignore
|
|
150
150
|
* import {openDatabaseSync} from 'expo-sqlite';
|
|
151
151
|
* import {createStore} from 'tinybase';
|
|
152
152
|
* import {createExpoSqlitePersister} from 'tinybase/persisters/persister-expo-sqlite';
|
|
@@ -50,7 +50,7 @@ export interface ExpoSqlitePersister<
|
|
|
50
50
|
* This example creates a Persister object against a newly-created Store and
|
|
51
51
|
* then gets the database instance back out again.
|
|
52
52
|
*
|
|
53
|
-
* ```js
|
|
53
|
+
* ```js ignore
|
|
54
54
|
* import {openDatabaseSync} from 'expo-sqlite';
|
|
55
55
|
* import {createStore} from 'tinybase';
|
|
56
56
|
* import {createExpoSqlitePersister} from 'tinybase/persisters/persister-expo-sqlite';
|
|
@@ -130,7 +130,7 @@ export interface ExpoSqlitePersister<
|
|
|
130
130
|
* table. It makes a change to the database directly and then reloads it back
|
|
131
131
|
* into the Store.
|
|
132
132
|
*
|
|
133
|
-
* ```js
|
|
133
|
+
* ```js ignore
|
|
134
134
|
* import {openDatabaseSync} from 'expo-sqlite';
|
|
135
135
|
* import {createStore} from 'tinybase';
|
|
136
136
|
* import {createExpoSqlitePersister} from 'tinybase/persisters/persister-expo-sqlite';
|
|
@@ -167,7 +167,7 @@ export interface ExpoSqlitePersister<
|
|
|
167
167
|
* This example creates a ExpoSqlitePersister object and persists the Store
|
|
168
168
|
* to a local SQLite database with tabular mapping.
|
|
169
169
|
*
|
|
170
|
-
* ```js
|
|
170
|
+
* ```js ignore
|
|
171
171
|
* import {openDatabaseSync} from 'expo-sqlite';
|
|
172
172
|
* import {createStore} from 'tinybase';
|
|
173
173
|
* import {createExpoSqlitePersister} from 'tinybase/persisters/persister-expo-sqlite';
|
|
@@ -68,7 +68,7 @@ export interface FilePersister extends Persister<Persists.StoreOrMergeableStore>
|
|
|
68
68
|
* This example creates a FilePersister object and persists the Store to a local
|
|
69
69
|
* file.
|
|
70
70
|
*
|
|
71
|
-
* ```js
|
|
71
|
+
* ```js ignore
|
|
72
72
|
* import {createStore} from 'tinybase';
|
|
73
73
|
* import {createFilePersister} from 'tinybase/persisters/persister-file';
|
|
74
74
|
*
|
|
@@ -83,7 +83,7 @@ export interface FilePersister<
|
|
|
83
83
|
* This example creates a FilePersister object and persists the Store to a local
|
|
84
84
|
* file.
|
|
85
85
|
*
|
|
86
|
-
* ```js
|
|
86
|
+
* ```js ignore
|
|
87
87
|
* import {createStore} from 'tinybase';
|
|
88
88
|
* import {createFilePersister} from 'tinybase/persisters/persister-file';
|
|
89
89
|
*
|
|
@@ -33,7 +33,7 @@ export interface LibSqlPersister extends Persister {
|
|
|
33
33
|
* This example creates a Persister object against a newly-created Store and
|
|
34
34
|
* then gets the database client back out again.
|
|
35
35
|
*
|
|
36
|
-
* ```js
|
|
36
|
+
* ```js ignore
|
|
37
37
|
* import {createClient} from '@libsql/client';
|
|
38
38
|
* import {createStore} from 'tinybase';
|
|
39
39
|
* import {createLibSqlPersister} from 'tinybase/persisters/persister-libsql';
|
|
@@ -96,7 +96,7 @@ export interface LibSqlPersister extends Persister {
|
|
|
96
96
|
* It makes a change to the database directly and then reloads it back into the
|
|
97
97
|
* Store.
|
|
98
98
|
*
|
|
99
|
-
* ```js
|
|
99
|
+
* ```js ignore
|
|
100
100
|
* import {createClient} from '@libsql/client';
|
|
101
101
|
* import {createStore} from 'tinybase';
|
|
102
102
|
* import {createLibSqlPersister} from 'tinybase/persisters/persister-libsql';
|
|
@@ -125,7 +125,7 @@ export interface LibSqlPersister extends Persister {
|
|
|
125
125
|
* This example creates a LibSqlPersister object and persists the Store to a
|
|
126
126
|
* local SQLite database with tabular mapping.
|
|
127
127
|
*
|
|
128
|
-
* ```js
|
|
128
|
+
* ```js ignore
|
|
129
129
|
* import {createClient} from '@libsql/client';
|
|
130
130
|
* import {createStore} from 'tinybase';
|
|
131
131
|
* import {createLibSqlPersister} from 'tinybase/persisters/persister-libsql';
|
|
@@ -41,7 +41,7 @@ export interface LibSqlPersister<
|
|
|
41
41
|
* This example creates a Persister object against a newly-created Store and
|
|
42
42
|
* then gets the database client back out again.
|
|
43
43
|
*
|
|
44
|
-
* ```js
|
|
44
|
+
* ```js ignore
|
|
45
45
|
* import {createClient} from '@libsql/client';
|
|
46
46
|
* import {createStore} from 'tinybase';
|
|
47
47
|
* import {createLibSqlPersister} from 'tinybase/persisters/persister-libsql';
|
|
@@ -116,7 +116,7 @@ export interface LibSqlPersister<
|
|
|
116
116
|
* It makes a change to the database directly and then reloads it back into the
|
|
117
117
|
* Store.
|
|
118
118
|
*
|
|
119
|
-
* ```js
|
|
119
|
+
* ```js ignore
|
|
120
120
|
* import {createClient} from '@libsql/client';
|
|
121
121
|
* import {createStore} from 'tinybase';
|
|
122
122
|
* import {createLibSqlPersister} from 'tinybase/persisters/persister-libsql';
|
|
@@ -145,7 +145,7 @@ export interface LibSqlPersister<
|
|
|
145
145
|
* This example creates a LibSqlPersister object and persists the Store to a
|
|
146
146
|
* local SQLite database with tabular mapping.
|
|
147
147
|
*
|
|
148
|
-
* ```js
|
|
148
|
+
* ```js ignore
|
|
149
149
|
* import {createClient} from '@libsql/client';
|
|
150
150
|
* import {createStore} from 'tinybase';
|
|
151
151
|
* import {createLibSqlPersister} from 'tinybase/persisters/persister-libsql';
|
|
@@ -44,7 +44,7 @@ export interface PartyKitPersister extends Persister {
|
|
|
44
44
|
* This example creates a Persister object against a newly-created Store and
|
|
45
45
|
* then gets the PartySocket back out again.
|
|
46
46
|
*
|
|
47
|
-
* ```js
|
|
47
|
+
* ```js ignore
|
|
48
48
|
* import {PartySocket} from 'partysocket';
|
|
49
49
|
* import {createStore} from 'tinybase';
|
|
50
50
|
* import {createPartyKitPersister} from 'tinybase/persisters/persister-partykit-client';
|
|
@@ -164,7 +164,7 @@ export type PartyKitPersisterConfig = {
|
|
|
164
164
|
* This example creates a PartyKitPersister object and persists the Store to the
|
|
165
165
|
* browser's IndexedDB storage.
|
|
166
166
|
*
|
|
167
|
-
* ```js
|
|
167
|
+
* ```js ignore
|
|
168
168
|
* import {PartySocket} from 'partysocket';
|
|
169
169
|
* import {createStore} from 'tinybase';
|
|
170
170
|
* import {createPartyKitPersister} from 'tinybase/persisters/persister-partykit-client';
|
|
@@ -49,7 +49,7 @@ export interface PartyKitPersister<
|
|
|
49
49
|
* This example creates a Persister object against a newly-created Store and
|
|
50
50
|
* then gets the PartySocket back out again.
|
|
51
51
|
*
|
|
52
|
-
* ```js
|
|
52
|
+
* ```js ignore
|
|
53
53
|
* import {PartySocket} from 'partysocket';
|
|
54
54
|
* import {createStore} from 'tinybase';
|
|
55
55
|
* import {createPartyKitPersister} from 'tinybase/persisters/persister-partykit-client';
|
|
@@ -180,7 +180,7 @@ export type PartyKitPersisterConfig = {
|
|
|
180
180
|
* This example creates a PartyKitPersister object and persists the Store to the
|
|
181
181
|
* browser's IndexedDB storage.
|
|
182
182
|
*
|
|
183
|
-
* ```js
|
|
183
|
+
* ```js ignore
|
|
184
184
|
* import {PartySocket} from 'partysocket';
|
|
185
185
|
* import {createStore} from 'tinybase';
|
|
186
186
|
* import {createPartyKitPersister} from 'tinybase/persisters/persister-partykit-client';
|
|
@@ -34,7 +34,7 @@ export interface PowerSyncPersister extends Persister {
|
|
|
34
34
|
* This example creates a Persister object against a newly-created Store and
|
|
35
35
|
* then gets the PowerSync instance back out again.
|
|
36
36
|
*
|
|
37
|
-
* ```js
|
|
37
|
+
* ```js ignore
|
|
38
38
|
* import {usePowerSync} from '@powersync/react';
|
|
39
39
|
* import {createStore} from 'tinybase';
|
|
40
40
|
* import {createPowerSyncPersister} from 'tinybase/persisters/persister-powersync';
|
|
@@ -98,7 +98,7 @@ export interface PowerSyncPersister extends Persister {
|
|
|
98
98
|
* It makes a change to the database directly and then reloads it back into the
|
|
99
99
|
* Store.
|
|
100
100
|
*
|
|
101
|
-
* ```js
|
|
101
|
+
* ```js ignore
|
|
102
102
|
* import {usePowerSync} from '@powersync/react';
|
|
103
103
|
* import {createStore} from 'tinybase';
|
|
104
104
|
* import {createPowerSyncPersister} from 'tinybase/persisters/persister-powersync';
|
|
@@ -134,7 +134,7 @@ export interface PowerSyncPersister extends Persister {
|
|
|
134
134
|
* This example creates a PowerSyncPersister object and persists the Store to a
|
|
135
135
|
* local PowerSync instance with tabular mapping.
|
|
136
136
|
*
|
|
137
|
-
* ```js
|
|
137
|
+
* ```js ignore
|
|
138
138
|
* import {usePowerSync} from '@powersync/react';
|
|
139
139
|
* import {createStore} from 'tinybase';
|
|
140
140
|
* import {createPowerSyncPersister} from 'tinybase/persisters/persister-powersync';
|
|
@@ -42,7 +42,7 @@ export interface PowerSyncPersister<
|
|
|
42
42
|
* This example creates a Persister object against a newly-created Store and
|
|
43
43
|
* then gets the PowerSync instance back out again.
|
|
44
44
|
*
|
|
45
|
-
* ```js
|
|
45
|
+
* ```js ignore
|
|
46
46
|
* import {usePowerSync} from '@powersync/react';
|
|
47
47
|
* import {createStore} from 'tinybase';
|
|
48
48
|
* import {createPowerSyncPersister} from 'tinybase/persisters/persister-powersync';
|
|
@@ -118,7 +118,7 @@ export interface PowerSyncPersister<
|
|
|
118
118
|
* It makes a change to the database directly and then reloads it back into the
|
|
119
119
|
* Store.
|
|
120
120
|
*
|
|
121
|
-
* ```js
|
|
121
|
+
* ```js ignore
|
|
122
122
|
* import {usePowerSync} from '@powersync/react';
|
|
123
123
|
* import {createStore} from 'tinybase';
|
|
124
124
|
* import {createPowerSyncPersister} from 'tinybase/persisters/persister-powersync';
|
|
@@ -154,7 +154,7 @@ export interface PowerSyncPersister<
|
|
|
154
154
|
* This example creates a PowerSyncPersister object and persists the Store to a
|
|
155
155
|
* local PowerSync instance with tabular mapping.
|
|
156
156
|
*
|
|
157
|
-
* ```js
|
|
157
|
+
* ```js ignore
|
|
158
158
|
* import {usePowerSync} from '@powersync/react';
|
|
159
159
|
* import {createStore} from 'tinybase';
|
|
160
160
|
* import {createPowerSyncPersister} from 'tinybase/persisters/persister-powersync';
|
|
@@ -35,7 +35,7 @@ export interface ReactNativeMmkvPersister extends Persister<Persists.StoreOrMerg
|
|
|
35
35
|
* This example creates a Persister object against a newly-created Store and
|
|
36
36
|
* then gets the unique key of the storage location back out again.
|
|
37
37
|
*
|
|
38
|
-
* ```js
|
|
38
|
+
* ```js ignore
|
|
39
39
|
* import {createMMKV} from 'react-native-mmkv';
|
|
40
40
|
* import {createStore} from 'tinybase';
|
|
41
41
|
* import {createReactNativeMmkvPersister} from 'tinybase/persisters/persister-react-native-mmkv';
|
|
@@ -84,7 +84,7 @@ export interface ReactNativeMmkvPersister extends Persister<Persists.StoreOrMerg
|
|
|
84
84
|
* `my_tinybase` key. It makes a change to the storage directly and then
|
|
85
85
|
* reloads it back into the Store.
|
|
86
86
|
*
|
|
87
|
-
* ```js
|
|
87
|
+
* ```js ignore
|
|
88
88
|
* import {createMMKV} from 'react-native-mmkv';
|
|
89
89
|
* import {createStore} from 'tinybase';
|
|
90
90
|
* import {createReactNativeMmkvPersister} from 'tinybase/persisters/persister-react-native-mmkv';
|
|
@@ -40,7 +40,7 @@ export interface ReactNativeMmkvPersister<
|
|
|
40
40
|
* This example creates a Persister object against a newly-created Store and
|
|
41
41
|
* then gets the unique key of the storage location back out again.
|
|
42
42
|
*
|
|
43
|
-
* ```js
|
|
43
|
+
* ```js ignore
|
|
44
44
|
* import {createMMKV} from 'react-native-mmkv';
|
|
45
45
|
* import {createStore} from 'tinybase';
|
|
46
46
|
* import {createReactNativeMmkvPersister} from 'tinybase/persisters/persister-react-native-mmkv';
|
|
@@ -100,7 +100,7 @@ export interface ReactNativeMmkvPersister<
|
|
|
100
100
|
* `my_tinybase` key. It makes a change to the storage directly and then
|
|
101
101
|
* reloads it back into the Store.
|
|
102
102
|
*
|
|
103
|
-
* ```js
|
|
103
|
+
* ```js ignore
|
|
104
104
|
* import {createMMKV} from 'react-native-mmkv';
|
|
105
105
|
* import {createStore} from 'tinybase';
|
|
106
106
|
* import {createReactNativeMmkvPersister} from 'tinybase/persisters/persister-react-native-mmkv';
|
|
@@ -36,7 +36,7 @@ export interface ReactNativeSqlitePersister extends Persister<Persists.StoreOrMe
|
|
|
36
36
|
* This example creates a Persister object against a newly-created Store and
|
|
37
37
|
* then gets the database instance back out again.
|
|
38
38
|
*
|
|
39
|
-
* ```js
|
|
39
|
+
* ```js ignore
|
|
40
40
|
* import {enablePromise, openDatabase} from 'react-native-sqlite-storage';
|
|
41
41
|
* import {createStore} from 'tinybase';
|
|
42
42
|
* import {createReactNativeSqlitePersister} from 'tinybase/persisters/persister-react-native-sqlite';
|
|
@@ -110,7 +110,7 @@ export interface ReactNativeSqlitePersister extends Persister<Persists.StoreOrMe
|
|
|
110
110
|
* `my_tinybase` table. It makes a change to the database directly and then
|
|
111
111
|
* reloads it back into the Store.
|
|
112
112
|
*
|
|
113
|
-
* ```js
|
|
113
|
+
* ```js ignore
|
|
114
114
|
* import {enablePromise, openDatabase} from 'react-native-sqlite-storage';
|
|
115
115
|
* import {createStore} from 'tinybase';
|
|
116
116
|
* import {createReactNativeSqlitePersister} from 'tinybase/persisters/persister-react-native-sqlite';
|
|
@@ -146,7 +146,7 @@ export interface ReactNativeSqlitePersister extends Persister<Persists.StoreOrMe
|
|
|
146
146
|
* This example creates a ReactNativeSqlitePersister object and persists the
|
|
147
147
|
* Store to a local SQLite database with tabular mapping.
|
|
148
148
|
*
|
|
149
|
-
* ```js
|
|
149
|
+
* ```js ignore
|
|
150
150
|
* import {enablePromise, openDatabase} from 'react-native-sqlite-storage';
|
|
151
151
|
* import {createStore} from 'tinybase';
|
|
152
152
|
* import {createReactNativeSqlitePersister} from 'tinybase/persisters/persister-react-native-sqlite';
|
|
@@ -45,7 +45,7 @@ export interface ReactNativeSqlitePersister<
|
|
|
45
45
|
* This example creates a Persister object against a newly-created Store and
|
|
46
46
|
* then gets the database instance back out again.
|
|
47
47
|
*
|
|
48
|
-
* ```js
|
|
48
|
+
* ```js ignore
|
|
49
49
|
* import {enablePromise, openDatabase} from 'react-native-sqlite-storage';
|
|
50
50
|
* import {createStore} from 'tinybase';
|
|
51
51
|
* import {createReactNativeSqlitePersister} from 'tinybase/persisters/persister-react-native-sqlite';
|
|
@@ -131,7 +131,7 @@ export interface ReactNativeSqlitePersister<
|
|
|
131
131
|
* `my_tinybase` table. It makes a change to the database directly and then
|
|
132
132
|
* reloads it back into the Store.
|
|
133
133
|
*
|
|
134
|
-
* ```js
|
|
134
|
+
* ```js ignore
|
|
135
135
|
* import {enablePromise, openDatabase} from 'react-native-sqlite-storage';
|
|
136
136
|
* import {createStore} from 'tinybase';
|
|
137
137
|
* import {createReactNativeSqlitePersister} from 'tinybase/persisters/persister-react-native-sqlite';
|
|
@@ -167,7 +167,7 @@ export interface ReactNativeSqlitePersister<
|
|
|
167
167
|
* This example creates a ReactNativeSqlitePersister object and persists the
|
|
168
168
|
* Store to a local SQLite database with tabular mapping.
|
|
169
169
|
*
|
|
170
|
-
* ```js
|
|
170
|
+
* ```js ignore
|
|
171
171
|
* import {enablePromise, openDatabase} from 'react-native-sqlite-storage';
|
|
172
172
|
* import {createStore} from 'tinybase';
|
|
173
173
|
* import {createReactNativeSqlitePersister} from 'tinybase/persisters/persister-react-native-sqlite';
|
|
@@ -85,7 +85,7 @@ export interface RemotePersister extends Persister {
|
|
|
85
85
|
* This example creates a RemotePersister object and persists the Store to a
|
|
86
86
|
* remote server.
|
|
87
87
|
*
|
|
88
|
-
* ```js
|
|
88
|
+
* ```js ignore
|
|
89
89
|
* import {createStore} from 'tinybase';
|
|
90
90
|
* import {createRemotePersister} from 'tinybase/persisters/persister-remote';
|
|
91
91
|
*
|
|
@@ -102,7 +102,7 @@ export interface RemotePersister<
|
|
|
102
102
|
* This example creates a RemotePersister object and persists the Store to a
|
|
103
103
|
* remote server.
|
|
104
104
|
*
|
|
105
|
-
* ```js
|
|
105
|
+
* ```js ignore
|
|
106
106
|
* import {createStore} from 'tinybase';
|
|
107
107
|
* import {createRemotePersister} from 'tinybase/persisters/persister-remote';
|
|
108
108
|
*
|
|
@@ -1632,7 +1632,7 @@ export interface Persister<
|
|
|
1632
1632
|
* Store and then sequences two tasks in order to update its data on a
|
|
1633
1633
|
* hypothetical remote system.
|
|
1634
1634
|
*
|
|
1635
|
-
* ```js
|
|
1635
|
+
* ```js ignore
|
|
1636
1636
|
* import {
|
|
1637
1637
|
* checkRemoteSystemIsReady,
|
|
1638
1638
|
* getDataFromRemoteSystem,
|
|
@@ -64,7 +64,7 @@ export class WsServerDurableObject<Env = unknown> extends DurableObject<Env> {
|
|
|
64
64
|
* This example enables Durable Object persistence by creating a Persister
|
|
65
65
|
* object within the createPersister method of a WsServerDurableObject.
|
|
66
66
|
*
|
|
67
|
-
* ```js
|
|
67
|
+
* ```js ignore
|
|
68
68
|
* import {createMergeableStore} from 'tinybase';
|
|
69
69
|
* import {createDurableObjectStoragePersister} from 'tinybase/persisters/persister-durable-object-storage';
|
|
70
70
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
@@ -102,7 +102,7 @@ export class WsServerDurableObject<Env = unknown> extends DurableObject<Env> {
|
|
|
102
102
|
* This example logs the path being served by the Durable Object every time a
|
|
103
103
|
* synchronization method is handled.
|
|
104
104
|
*
|
|
105
|
-
* ```js
|
|
105
|
+
* ```js ignore
|
|
106
106
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
107
107
|
*
|
|
108
108
|
* export class MyDurableObject extends WsServerDurableObject {
|
|
@@ -128,7 +128,7 @@ export class WsServerDurableObject<Env = unknown> extends DurableObject<Env> {
|
|
|
128
128
|
* This example logs the list of clients being served by the Durable Object
|
|
129
129
|
* every time a synchronization method is handled.
|
|
130
130
|
*
|
|
131
|
-
* ```js
|
|
131
|
+
* ```js ignore
|
|
132
132
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
133
133
|
*
|
|
134
134
|
* export class MyDurableObject extends WsServerDurableObject {
|
|
@@ -157,7 +157,7 @@ export class WsServerDurableObject<Env = unknown> extends DurableObject<Env> {
|
|
|
157
157
|
* when the first client joins (the path Id is 'added'), and when the last
|
|
158
158
|
* client leaves (the path Id is 'removed').
|
|
159
159
|
*
|
|
160
|
-
* ```js
|
|
160
|
+
* ```js ignore
|
|
161
161
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
162
162
|
*
|
|
163
163
|
* export class MyDurableObject extends WsServerDurableObject {
|
|
@@ -192,7 +192,7 @@ export class WsServerDurableObject<Env = unknown> extends DurableObject<Env> {
|
|
|
192
192
|
* leaves (the client Id is 'removed') on the path being served by the Durable
|
|
193
193
|
* Object.
|
|
194
194
|
*
|
|
195
|
-
* ```js
|
|
195
|
+
* ```js ignore
|
|
196
196
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
197
197
|
*
|
|
198
198
|
* export class MyDurableObject extends WsServerDurableObject {
|
|
@@ -228,7 +228,7 @@ export class WsServerDurableObject<Env = unknown> extends DurableObject<Env> {
|
|
|
228
228
|
* This example logs every message routed by the Durable Object between
|
|
229
229
|
* clients.
|
|
230
230
|
*
|
|
231
|
-
* ```js
|
|
231
|
+
* ```js ignore
|
|
232
232
|
* import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
|
|
233
233
|
*
|
|
234
234
|
* export class MyDurableObject extends WsServerDurableObject {
|
|
@@ -289,7 +289,7 @@ export class WsServerDurableObject<Env = unknown> extends DurableObject<Env> {
|
|
|
289
289
|
* Durable Object in the `MyDurableObjects` namespace. This would require the
|
|
290
290
|
* `wrangler.toml` configuration shown above.
|
|
291
291
|
*
|
|
292
|
-
* ```js
|
|
292
|
+
* ```js ignore
|
|
293
293
|
* import {
|
|
294
294
|
* WsServerDurableObject,
|
|
295
295
|
* getWsServerDurableObjectFetch,
|