tinybase 5.0.0-beta.17 → 5.0.0-beta.18
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/cjs/mergeable-store.cjs +1 -1
- package/lib/cjs/mergeable-store.cjs.gz +0 -0
- package/lib/cjs/persisters/persister-automerge.cjs +1 -1
- package/lib/cjs/persisters/persister-automerge.cjs.gz +0 -0
- package/lib/cjs/persisters/persister-browser.cjs +1 -1
- package/lib/cjs/persisters/persister-browser.cjs.gz +0 -0
- package/lib/cjs/persisters/persister-cr-sqlite-wasm.cjs +1 -1
- package/lib/cjs/persisters/persister-cr-sqlite-wasm.cjs.gz +0 -0
- package/lib/cjs/persisters/persister-electric-sql.cjs +1 -1
- package/lib/cjs/persisters/persister-electric-sql.cjs.gz +0 -0
- package/lib/cjs/persisters/persister-expo-sqlite-next.cjs +1 -1
- package/lib/cjs/persisters/persister-expo-sqlite-next.cjs.gz +0 -0
- package/lib/cjs/persisters/persister-expo-sqlite.cjs +1 -1
- package/lib/cjs/persisters/persister-expo-sqlite.cjs.gz +0 -0
- package/lib/cjs/persisters/persister-file.cjs +1 -1
- package/lib/cjs/persisters/persister-file.cjs.gz +0 -0
- package/lib/cjs/persisters/persister-indexed-db.cjs +1 -1
- package/lib/cjs/persisters/persister-indexed-db.cjs.gz +0 -0
- package/lib/cjs/persisters/persister-libsql.cjs +1 -1
- package/lib/cjs/persisters/persister-libsql.cjs.gz +0 -0
- package/lib/cjs/persisters/persister-partykit-client.cjs +1 -1
- package/lib/cjs/persisters/persister-partykit-client.cjs.gz +0 -0
- package/lib/cjs/persisters/persister-powersync.cjs +1 -1
- package/lib/cjs/persisters/persister-powersync.cjs.gz +0 -0
- package/lib/cjs/persisters/persister-remote.cjs +1 -1
- package/lib/cjs/persisters/persister-remote.cjs.gz +0 -0
- package/lib/cjs/persisters/persister-sqlite-wasm.cjs +1 -1
- package/lib/cjs/persisters/persister-sqlite-wasm.cjs.gz +0 -0
- package/lib/cjs/persisters/persister-sqlite3.cjs +1 -1
- package/lib/cjs/persisters/persister-sqlite3.cjs.gz +0 -0
- package/lib/cjs/persisters/persister-yjs.cjs +1 -1
- package/lib/cjs/persisters/persister-yjs.cjs.gz +0 -0
- package/lib/cjs/persisters.cjs +1 -1
- package/lib/cjs/persisters.cjs.gz +0 -0
- package/lib/cjs/store.cjs +1 -1
- package/lib/cjs/store.cjs.gz +0 -0
- package/lib/cjs/synchronizers/synchronizer-local.cjs +1 -1
- package/lib/cjs/synchronizers/synchronizer-local.cjs.gz +0 -0
- package/lib/cjs/synchronizers/synchronizer-ws-client.cjs +1 -1
- package/lib/cjs/synchronizers/synchronizer-ws-client.cjs.gz +0 -0
- package/lib/cjs/synchronizers.cjs +1 -1
- package/lib/cjs/synchronizers.cjs.gz +0 -0
- package/lib/cjs/tinybase.cjs +1 -1
- package/lib/cjs/tinybase.cjs.gz +0 -0
- package/lib/cjs/ui-react-dom-debug.cjs +1 -1
- package/lib/cjs/ui-react-dom-debug.cjs.gz +0 -0
- package/lib/cjs-es6/mergeable-store.cjs +1 -1
- package/lib/cjs-es6/mergeable-store.cjs.gz +0 -0
- package/lib/cjs-es6/persisters/persister-automerge.cjs +1 -1
- package/lib/cjs-es6/persisters/persister-automerge.cjs.gz +0 -0
- package/lib/cjs-es6/persisters/persister-browser.cjs +1 -1
- package/lib/cjs-es6/persisters/persister-browser.cjs.gz +0 -0
- package/lib/cjs-es6/persisters/persister-cr-sqlite-wasm.cjs +1 -1
- package/lib/cjs-es6/persisters/persister-cr-sqlite-wasm.cjs.gz +0 -0
- package/lib/cjs-es6/persisters/persister-electric-sql.cjs +1 -1
- package/lib/cjs-es6/persisters/persister-electric-sql.cjs.gz +0 -0
- package/lib/cjs-es6/persisters/persister-expo-sqlite-next.cjs +1 -1
- package/lib/cjs-es6/persisters/persister-expo-sqlite-next.cjs.gz +0 -0
- package/lib/cjs-es6/persisters/persister-expo-sqlite.cjs +1 -1
- package/lib/cjs-es6/persisters/persister-expo-sqlite.cjs.gz +0 -0
- package/lib/cjs-es6/persisters/persister-file.cjs +1 -1
- package/lib/cjs-es6/persisters/persister-file.cjs.gz +0 -0
- package/lib/cjs-es6/persisters/persister-indexed-db.cjs +1 -1
- package/lib/cjs-es6/persisters/persister-indexed-db.cjs.gz +0 -0
- package/lib/cjs-es6/persisters/persister-libsql.cjs +1 -1
- package/lib/cjs-es6/persisters/persister-libsql.cjs.gz +0 -0
- package/lib/cjs-es6/persisters/persister-partykit-client.cjs +1 -1
- package/lib/cjs-es6/persisters/persister-partykit-client.cjs.gz +0 -0
- package/lib/cjs-es6/persisters/persister-powersync.cjs +1 -1
- package/lib/cjs-es6/persisters/persister-powersync.cjs.gz +0 -0
- package/lib/cjs-es6/persisters/persister-remote.cjs +1 -1
- package/lib/cjs-es6/persisters/persister-remote.cjs.gz +0 -0
- package/lib/cjs-es6/persisters/persister-sqlite-wasm.cjs +1 -1
- package/lib/cjs-es6/persisters/persister-sqlite-wasm.cjs.gz +0 -0
- package/lib/cjs-es6/persisters/persister-sqlite3.cjs +1 -1
- package/lib/cjs-es6/persisters/persister-sqlite3.cjs.gz +0 -0
- package/lib/cjs-es6/persisters/persister-yjs.cjs +1 -1
- package/lib/cjs-es6/persisters/persister-yjs.cjs.gz +0 -0
- package/lib/cjs-es6/persisters.cjs +1 -1
- package/lib/cjs-es6/persisters.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/synchronizers/synchronizer-local.cjs +1 -1
- package/lib/cjs-es6/synchronizers/synchronizer-local.cjs.gz +0 -0
- package/lib/cjs-es6/synchronizers/synchronizer-ws-client.cjs +1 -1
- package/lib/cjs-es6/synchronizers/synchronizer-ws-client.cjs.gz +0 -0
- package/lib/cjs-es6/synchronizers.cjs +1 -1
- package/lib/cjs-es6/synchronizers.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/ui-react-dom-debug.cjs +1 -1
- package/lib/cjs-es6/ui-react-dom-debug.cjs.gz +0 -0
- package/lib/debug/mergeable-store.js +4 -1
- package/lib/debug/persisters/persister-automerge.js +5 -3
- package/lib/debug/persisters/persister-browser.js +5 -3
- package/lib/debug/persisters/persister-cr-sqlite-wasm.js +5 -3
- package/lib/debug/persisters/persister-electric-sql.js +5 -3
- package/lib/debug/persisters/persister-expo-sqlite-next.js +5 -3
- package/lib/debug/persisters/persister-expo-sqlite.js +5 -3
- package/lib/debug/persisters/persister-file.js +5 -3
- package/lib/debug/persisters/persister-indexed-db.js +5 -3
- package/lib/debug/persisters/persister-libsql.js +5 -3
- package/lib/debug/persisters/persister-partykit-client.js +5 -3
- package/lib/debug/persisters/persister-powersync.js +5 -3
- package/lib/debug/persisters/persister-remote.js +5 -3
- package/lib/debug/persisters/persister-sqlite-wasm.js +5 -3
- package/lib/debug/persisters/persister-sqlite3.js +5 -3
- package/lib/debug/persisters/persister-yjs.js +5 -3
- package/lib/debug/persisters.js +5 -3
- package/lib/debug/store.js +1 -0
- package/lib/debug/synchronizers/synchronizer-local.js +5 -3
- package/lib/debug/synchronizers/synchronizer-ws-client.js +5 -3
- package/lib/debug/synchronizers.js +5 -3
- package/lib/debug/tinybase.js +9 -4
- package/lib/debug/ui-react-dom.js +7 -4
- package/lib/es6/mergeable-store.js +1 -1
- package/lib/es6/mergeable-store.js.gz +0 -0
- package/lib/es6/persisters/persister-automerge.js +1 -1
- package/lib/es6/persisters/persister-automerge.js.gz +0 -0
- package/lib/es6/persisters/persister-browser.js +1 -1
- package/lib/es6/persisters/persister-browser.js.gz +0 -0
- package/lib/es6/persisters/persister-cr-sqlite-wasm.js +1 -1
- package/lib/es6/persisters/persister-cr-sqlite-wasm.js.gz +0 -0
- package/lib/es6/persisters/persister-electric-sql.js +1 -1
- package/lib/es6/persisters/persister-electric-sql.js.gz +0 -0
- package/lib/es6/persisters/persister-expo-sqlite-next.js +1 -1
- package/lib/es6/persisters/persister-expo-sqlite-next.js.gz +0 -0
- package/lib/es6/persisters/persister-expo-sqlite.js +1 -1
- package/lib/es6/persisters/persister-expo-sqlite.js.gz +0 -0
- package/lib/es6/persisters/persister-file.js +1 -1
- package/lib/es6/persisters/persister-file.js.gz +0 -0
- package/lib/es6/persisters/persister-indexed-db.js +1 -1
- package/lib/es6/persisters/persister-indexed-db.js.gz +0 -0
- package/lib/es6/persisters/persister-libsql.js +1 -1
- package/lib/es6/persisters/persister-libsql.js.gz +0 -0
- package/lib/es6/persisters/persister-partykit-client.js +1 -1
- package/lib/es6/persisters/persister-partykit-client.js.gz +0 -0
- package/lib/es6/persisters/persister-powersync.js +1 -1
- package/lib/es6/persisters/persister-powersync.js.gz +0 -0
- package/lib/es6/persisters/persister-remote.js +1 -1
- package/lib/es6/persisters/persister-remote.js.gz +0 -0
- package/lib/es6/persisters/persister-sqlite-wasm.js +1 -1
- package/lib/es6/persisters/persister-sqlite-wasm.js.gz +0 -0
- package/lib/es6/persisters/persister-sqlite3.js +1 -1
- package/lib/es6/persisters/persister-sqlite3.js.gz +0 -0
- package/lib/es6/persisters/persister-yjs.js +1 -1
- package/lib/es6/persisters/persister-yjs.js.gz +0 -0
- package/lib/es6/persisters.js +1 -1
- package/lib/es6/persisters.js.gz +0 -0
- package/lib/es6/store.js +1 -1
- package/lib/es6/store.js.gz +0 -0
- package/lib/es6/synchronizers/synchronizer-local.js +1 -1
- package/lib/es6/synchronizers/synchronizer-local.js.gz +0 -0
- package/lib/es6/synchronizers/synchronizer-ws-client.js +1 -1
- package/lib/es6/synchronizers/synchronizer-ws-client.js.gz +0 -0
- package/lib/es6/synchronizers.js +1 -1
- package/lib/es6/synchronizers.js.gz +0 -0
- package/lib/es6/tinybase.js +1 -1
- package/lib/es6/tinybase.js.gz +0 -0
- package/lib/es6/ui-react-dom-debug.js +1 -1
- package/lib/es6/ui-react-dom-debug.js.gz +0 -0
- package/lib/mergeable-store.js +1 -1
- package/lib/mergeable-store.js.gz +0 -0
- package/lib/persisters/persister-automerge.js +1 -1
- package/lib/persisters/persister-automerge.js.gz +0 -0
- package/lib/persisters/persister-browser.js +1 -1
- package/lib/persisters/persister-browser.js.gz +0 -0
- package/lib/persisters/persister-cr-sqlite-wasm.js +1 -1
- package/lib/persisters/persister-cr-sqlite-wasm.js.gz +0 -0
- package/lib/persisters/persister-electric-sql.js +1 -1
- package/lib/persisters/persister-electric-sql.js.gz +0 -0
- package/lib/persisters/persister-expo-sqlite-next.js +1 -1
- package/lib/persisters/persister-expo-sqlite-next.js.gz +0 -0
- package/lib/persisters/persister-expo-sqlite.js +1 -1
- package/lib/persisters/persister-expo-sqlite.js.gz +0 -0
- package/lib/persisters/persister-file.js +1 -1
- package/lib/persisters/persister-file.js.gz +0 -0
- package/lib/persisters/persister-indexed-db.js +1 -1
- package/lib/persisters/persister-indexed-db.js.gz +0 -0
- package/lib/persisters/persister-libsql.js +1 -1
- package/lib/persisters/persister-libsql.js.gz +0 -0
- package/lib/persisters/persister-partykit-client.js +1 -1
- package/lib/persisters/persister-partykit-client.js.gz +0 -0
- package/lib/persisters/persister-powersync.js +1 -1
- package/lib/persisters/persister-powersync.js.gz +0 -0
- package/lib/persisters/persister-remote.js +1 -1
- package/lib/persisters/persister-remote.js.gz +0 -0
- package/lib/persisters/persister-sqlite-wasm.js +1 -1
- package/lib/persisters/persister-sqlite-wasm.js.gz +0 -0
- package/lib/persisters/persister-sqlite3.js +1 -1
- package/lib/persisters/persister-sqlite3.js.gz +0 -0
- package/lib/persisters/persister-yjs.js +1 -1
- package/lib/persisters/persister-yjs.js.gz +0 -0
- package/lib/persisters.js +1 -1
- package/lib/persisters.js.gz +0 -0
- package/lib/store.js +1 -1
- package/lib/store.js.gz +0 -0
- package/lib/synchronizers/synchronizer-local.js +1 -1
- package/lib/synchronizers/synchronizer-local.js.gz +0 -0
- package/lib/synchronizers/synchronizer-ws-client.js +1 -1
- package/lib/synchronizers/synchronizer-ws-client.js.gz +0 -0
- package/lib/synchronizers.js +1 -1
- package/lib/synchronizers.js.gz +0 -0
- package/lib/tinybase.js +1 -1
- package/lib/tinybase.js.gz +0 -0
- package/lib/types/checkpoints.d.ts +50 -3
- package/lib/types/common.d.ts +4 -0
- package/lib/types/indexes.d.ts +58 -14
- package/lib/types/mergeable-store.d.ts +9 -0
- package/lib/types/metrics.d.ts +46 -7
- package/lib/types/persisters/persister-automerge.d.ts +17 -4
- package/lib/types/persisters/persister-browser.d.ts +12 -0
- package/lib/types/persisters/persister-cr-sqlite-wasm.d.ts +12 -0
- package/lib/types/persisters/persister-electric-sql.d.ts +18 -3
- package/lib/types/persisters/persister-expo-sqlite-next.d.ts +23 -8
- package/lib/types/persisters/persister-expo-sqlite.d.ts +17 -4
- package/lib/types/persisters/persister-file.d.ts +6 -0
- package/lib/types/persisters/persister-indexed-db.d.ts +6 -0
- package/lib/types/persisters/persister-libsql.d.ts +12 -0
- package/lib/types/persisters/persister-partykit-client.d.ts +11 -3
- package/lib/types/persisters/persister-partykit-server.d.ts +37 -14
- package/lib/types/persisters/persister-powersync.d.ts +13 -1
- package/lib/types/persisters/persister-remote.d.ts +6 -0
- package/lib/types/persisters/persister-sqlite-wasm.d.ts +14 -1
- package/lib/types/persisters/persister-sqlite3.d.ts +17 -4
- package/lib/types/persisters/persister-yjs.d.ts +18 -6
- package/lib/types/persisters.d.ts +75 -8
- package/lib/types/queries.d.ts +137 -9
- package/lib/types/relationships.d.ts +28 -4
- package/lib/types/store.d.ts +429 -18
- package/lib/types/synchronizers.d.ts +3 -0
- package/lib/types/tools.d.ts +45 -10
- package/lib/types/ui-react-dom.d.ts +136 -27
- package/lib/types/ui-react.d.ts +1806 -326
- package/lib/types/with-schemas/checkpoints.d.ts +50 -3
- package/lib/types/with-schemas/common.d.ts +4 -0
- package/lib/types/with-schemas/indexes.d.ts +58 -14
- package/lib/types/with-schemas/mergeable-store.d.ts +23 -0
- package/lib/types/with-schemas/metrics.d.ts +46 -7
- package/lib/types/with-schemas/persisters/persister-automerge.d.ts +17 -4
- package/lib/types/with-schemas/persisters/persister-browser.d.ts +12 -0
- package/lib/types/with-schemas/persisters/persister-cr-sqlite-wasm.d.ts +12 -0
- package/lib/types/with-schemas/persisters/persister-electric-sql.d.ts +18 -3
- package/lib/types/with-schemas/persisters/persister-expo-sqlite-next.d.ts +24 -9
- package/lib/types/with-schemas/persisters/persister-expo-sqlite.d.ts +18 -5
- package/lib/types/with-schemas/persisters/persister-file.d.ts +6 -0
- package/lib/types/with-schemas/persisters/persister-indexed-db.d.ts +6 -0
- package/lib/types/with-schemas/persisters/persister-libsql.d.ts +12 -0
- package/lib/types/with-schemas/persisters/persister-partykit-client.d.ts +11 -3
- package/lib/types/with-schemas/persisters/persister-partykit-server.d.ts +37 -14
- package/lib/types/with-schemas/persisters/persister-powersync.d.ts +13 -1
- package/lib/types/with-schemas/persisters/persister-remote.d.ts +6 -0
- package/lib/types/with-schemas/persisters/persister-sqlite-wasm.d.ts +15 -2
- package/lib/types/with-schemas/persisters/persister-sqlite3.d.ts +18 -5
- package/lib/types/with-schemas/persisters/persister-yjs.d.ts +18 -6
- package/lib/types/with-schemas/persisters.d.ts +75 -8
- package/lib/types/with-schemas/queries.d.ts +137 -9
- package/lib/types/with-schemas/relationships.d.ts +28 -4
- package/lib/types/with-schemas/store.d.ts +429 -18
- package/lib/types/with-schemas/synchronizers.d.ts +3 -0
- package/lib/types/with-schemas/tools.d.ts +45 -10
- package/lib/types/with-schemas/ui-react-dom.d.ts +136 -27
- package/lib/types/with-schemas/ui-react.d.ts +1806 -326
- package/lib/umd/mergeable-store.js +1 -1
- package/lib/umd/mergeable-store.js.gz +0 -0
- package/lib/umd/persisters/persister-automerge.js +1 -1
- package/lib/umd/persisters/persister-automerge.js.gz +0 -0
- package/lib/umd/persisters/persister-browser.js +1 -1
- package/lib/umd/persisters/persister-browser.js.gz +0 -0
- package/lib/umd/persisters/persister-cr-sqlite-wasm.js +1 -1
- package/lib/umd/persisters/persister-cr-sqlite-wasm.js.gz +0 -0
- package/lib/umd/persisters/persister-electric-sql.js +1 -1
- package/lib/umd/persisters/persister-electric-sql.js.gz +0 -0
- package/lib/umd/persisters/persister-expo-sqlite-next.js +1 -1
- package/lib/umd/persisters/persister-expo-sqlite-next.js.gz +0 -0
- package/lib/umd/persisters/persister-expo-sqlite.js +1 -1
- package/lib/umd/persisters/persister-expo-sqlite.js.gz +0 -0
- package/lib/umd/persisters/persister-file.js +1 -1
- package/lib/umd/persisters/persister-file.js.gz +0 -0
- package/lib/umd/persisters/persister-indexed-db.js +1 -1
- package/lib/umd/persisters/persister-indexed-db.js.gz +0 -0
- package/lib/umd/persisters/persister-libsql.js +1 -1
- package/lib/umd/persisters/persister-libsql.js.gz +0 -0
- package/lib/umd/persisters/persister-partykit-client.js +1 -1
- package/lib/umd/persisters/persister-partykit-client.js.gz +0 -0
- package/lib/umd/persisters/persister-powersync.js +1 -1
- package/lib/umd/persisters/persister-powersync.js.gz +0 -0
- package/lib/umd/persisters/persister-remote.js +1 -1
- package/lib/umd/persisters/persister-remote.js.gz +0 -0
- package/lib/umd/persisters/persister-sqlite-wasm.js +1 -1
- package/lib/umd/persisters/persister-sqlite-wasm.js.gz +0 -0
- package/lib/umd/persisters/persister-sqlite3.js +1 -1
- package/lib/umd/persisters/persister-sqlite3.js.gz +0 -0
- package/lib/umd/persisters/persister-yjs.js +1 -1
- package/lib/umd/persisters/persister-yjs.js.gz +0 -0
- package/lib/umd/persisters.js +1 -1
- package/lib/umd/persisters.js.gz +0 -0
- package/lib/umd/store.js +1 -1
- package/lib/umd/store.js.gz +0 -0
- package/lib/umd/synchronizers/synchronizer-local.js +1 -1
- package/lib/umd/synchronizers/synchronizer-local.js.gz +0 -0
- package/lib/umd/synchronizers/synchronizer-ws-client.js +1 -1
- package/lib/umd/synchronizers/synchronizer-ws-client.js.gz +0 -0
- package/lib/umd/synchronizers.js +1 -1
- package/lib/umd/synchronizers.js.gz +0 -0
- package/lib/umd/tinybase.js +1 -1
- package/lib/umd/tinybase.js.gz +0 -0
- package/lib/umd/ui-react-dom-debug.js +1 -1
- package/lib/umd/ui-react-dom-debug.js.gz +0 -0
- package/lib/umd-es6/mergeable-store.js +1 -1
- package/lib/umd-es6/mergeable-store.js.gz +0 -0
- package/lib/umd-es6/persisters/persister-automerge.js +1 -1
- package/lib/umd-es6/persisters/persister-automerge.js.gz +0 -0
- package/lib/umd-es6/persisters/persister-browser.js +1 -1
- package/lib/umd-es6/persisters/persister-browser.js.gz +0 -0
- package/lib/umd-es6/persisters/persister-cr-sqlite-wasm.js +1 -1
- package/lib/umd-es6/persisters/persister-cr-sqlite-wasm.js.gz +0 -0
- package/lib/umd-es6/persisters/persister-electric-sql.js +1 -1
- package/lib/umd-es6/persisters/persister-electric-sql.js.gz +0 -0
- package/lib/umd-es6/persisters/persister-expo-sqlite-next.js +1 -1
- package/lib/umd-es6/persisters/persister-expo-sqlite-next.js.gz +0 -0
- package/lib/umd-es6/persisters/persister-expo-sqlite.js +1 -1
- package/lib/umd-es6/persisters/persister-expo-sqlite.js.gz +0 -0
- package/lib/umd-es6/persisters/persister-file.js +1 -1
- package/lib/umd-es6/persisters/persister-file.js.gz +0 -0
- package/lib/umd-es6/persisters/persister-indexed-db.js +1 -1
- package/lib/umd-es6/persisters/persister-indexed-db.js.gz +0 -0
- package/lib/umd-es6/persisters/persister-libsql.js +1 -1
- package/lib/umd-es6/persisters/persister-libsql.js.gz +0 -0
- package/lib/umd-es6/persisters/persister-partykit-client.js +1 -1
- package/lib/umd-es6/persisters/persister-partykit-client.js.gz +0 -0
- package/lib/umd-es6/persisters/persister-powersync.js +1 -1
- package/lib/umd-es6/persisters/persister-powersync.js.gz +0 -0
- package/lib/umd-es6/persisters/persister-remote.js +1 -1
- package/lib/umd-es6/persisters/persister-remote.js.gz +0 -0
- package/lib/umd-es6/persisters/persister-sqlite-wasm.js +1 -1
- package/lib/umd-es6/persisters/persister-sqlite-wasm.js.gz +0 -0
- package/lib/umd-es6/persisters/persister-sqlite3.js +1 -1
- package/lib/umd-es6/persisters/persister-sqlite3.js.gz +0 -0
- package/lib/umd-es6/persisters/persister-yjs.js +1 -1
- package/lib/umd-es6/persisters/persister-yjs.js.gz +0 -0
- package/lib/umd-es6/persisters.js +1 -1
- package/lib/umd-es6/persisters.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/synchronizers/synchronizer-local.js +1 -1
- package/lib/umd-es6/synchronizers/synchronizer-local.js.gz +0 -0
- package/lib/umd-es6/synchronizers/synchronizer-ws-client.js +1 -1
- package/lib/umd-es6/synchronizers/synchronizer-ws-client.js.gz +0 -0
- package/lib/umd-es6/synchronizers.js +1 -1
- package/lib/umd-es6/synchronizers.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/ui-react-dom-debug.js +1 -1
- package/lib/umd-es6/ui-react-dom-debug.js.gz +0 -0
- package/package.json +25 -23
- package/readme.md +21 -3
|
@@ -137,6 +137,8 @@ export type CheckpointsListenerStats = {
|
|
|
137
137
|
* registering and removing a listener for them.
|
|
138
138
|
*
|
|
139
139
|
* ```js
|
|
140
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
141
|
+
*
|
|
140
142
|
* const store = createStore()
|
|
141
143
|
* .setTables({pets: {fido: {sold: false}}})
|
|
142
144
|
* .setValue('open', true);
|
|
@@ -178,7 +180,6 @@ export type CheckpointsListenerStats = {
|
|
|
178
180
|
* // Previous redo of checkpoints '1' and '2' are now not possible.
|
|
179
181
|
*
|
|
180
182
|
* checkpoints.delListener(listenerId);
|
|
181
|
-
* checkpoints.destroy();
|
|
182
183
|
* ```
|
|
183
184
|
* @see Relationships And Checkpoints guides
|
|
184
185
|
* @see Todo App demos
|
|
@@ -209,6 +210,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
209
210
|
* number of checkpoints to demonstrate the oldest being pruned.
|
|
210
211
|
*
|
|
211
212
|
* ```js
|
|
213
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
214
|
+
*
|
|
212
215
|
* const store = createStore().setTables({pets: {fido: {views: 0}}});
|
|
213
216
|
*
|
|
214
217
|
* const checkpoints = createCheckpoints(store);
|
|
@@ -253,6 +256,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
253
256
|
* checkpoints, one with a label.
|
|
254
257
|
*
|
|
255
258
|
* ```js
|
|
259
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
260
|
+
*
|
|
256
261
|
* const store = createStore().setTables({pets: {fido: {sold: false}}});
|
|
257
262
|
*
|
|
258
263
|
* const checkpoints = createCheckpoints(store);
|
|
@@ -307,6 +312,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
307
312
|
* checkpoints, one with a label, which are both then re-labelled.
|
|
308
313
|
*
|
|
309
314
|
* ```js
|
|
315
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
316
|
+
*
|
|
310
317
|
* const store = createStore().setTables({pets: {fido: {sold: false}}});
|
|
311
318
|
*
|
|
312
319
|
* const checkpoints = createCheckpoints(store);
|
|
@@ -355,6 +362,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
355
362
|
* ```
|
|
356
363
|
*
|
|
357
364
|
* ```js
|
|
365
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
366
|
+
*
|
|
358
367
|
* const checkpoints = createCheckpoints(createStore());
|
|
359
368
|
* checkpoints.getStore().setCell('pets', 'fido', 'species', 'dog');
|
|
360
369
|
* checkpoints.addCheckpoint();
|
|
@@ -381,6 +390,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
381
390
|
* Ids of the checkpoints as it sets them and moves around the stack.
|
|
382
391
|
*
|
|
383
392
|
* ```js
|
|
393
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
394
|
+
*
|
|
384
395
|
* const store = createStore().setTables({pets: {fido: {sold: false}}});
|
|
385
396
|
*
|
|
386
397
|
* const checkpoints = createCheckpoints(store);
|
|
@@ -418,6 +429,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
418
429
|
* This example iterates over each Checkpoint in a Checkpoints object.
|
|
419
430
|
*
|
|
420
431
|
* ```js
|
|
432
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
433
|
+
*
|
|
421
434
|
* const store = createStore().setTables({pets: {fido: {sold: false}}});
|
|
422
435
|
* const checkpoints = createCheckpoints(store);
|
|
423
436
|
* store.setCell('pets', 'fido', 'sold', true);
|
|
@@ -443,6 +456,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
443
456
|
* This example shows two simple Checkpoint existence checks.
|
|
444
457
|
*
|
|
445
458
|
* ```js
|
|
459
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
460
|
+
*
|
|
446
461
|
* const store = createStore().setTables({pets: {fido: {sold: false}}});
|
|
447
462
|
* const checkpoints = createCheckpoints(store);
|
|
448
463
|
* console.log(checkpoints.hasCheckpoint('0'));
|
|
@@ -469,6 +484,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
469
484
|
* checkpoint with a label, before retrieving it again.
|
|
470
485
|
*
|
|
471
486
|
* ```js
|
|
487
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
488
|
+
*
|
|
472
489
|
* const store = createStore().setTables({pets: {fido: {sold: false}}});
|
|
473
490
|
*
|
|
474
491
|
* const checkpoints = createCheckpoints(store);
|
|
@@ -485,6 +502,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
485
502
|
* checkpoint return an `undefined` label.
|
|
486
503
|
*
|
|
487
504
|
* ```js
|
|
505
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
506
|
+
*
|
|
488
507
|
* const store = createStore().setTables({pets: {fido: {sold: false}}});
|
|
489
508
|
*
|
|
490
509
|
* const checkpoints = createCheckpoints(store);
|
|
@@ -525,6 +544,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
525
544
|
* listener that responds to any changes to the checkpoints.
|
|
526
545
|
*
|
|
527
546
|
* ```js
|
|
547
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
548
|
+
*
|
|
528
549
|
* const store = createStore().setTables({pets: {fido: {sold: false}}});
|
|
529
550
|
*
|
|
530
551
|
* const checkpoints = createCheckpoints(store);
|
|
@@ -553,7 +574,6 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
553
574
|
* // -> [['0'], '1', []]
|
|
554
575
|
*
|
|
555
576
|
* checkpoints.delListener(listenerId);
|
|
556
|
-
* checkpoints.destroy();
|
|
557
577
|
* ```
|
|
558
578
|
* @category Listener
|
|
559
579
|
*/
|
|
@@ -591,6 +611,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
591
611
|
* including when the checkpoint no longer exists.
|
|
592
612
|
*
|
|
593
613
|
* ```js
|
|
614
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
615
|
+
*
|
|
594
616
|
* const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
|
|
595
617
|
*
|
|
596
618
|
* const checkpoints = createCheckpoints(store);
|
|
@@ -621,7 +643,6 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
621
643
|
* // The checkpoint no longer exists.
|
|
622
644
|
*
|
|
623
645
|
* checkpoints.delListener(listenerId);
|
|
624
|
-
* checkpoints.destroy();
|
|
625
646
|
* ```
|
|
626
647
|
* @category Listener
|
|
627
648
|
*/
|
|
@@ -649,6 +670,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
649
670
|
* and then removes it.
|
|
650
671
|
*
|
|
651
672
|
* ```js
|
|
673
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
674
|
+
*
|
|
652
675
|
* const store = createStore().setTables({pets: {fido: {sold: false}}});
|
|
653
676
|
*
|
|
654
677
|
* const checkpoints = createCheckpoints(store);
|
|
@@ -692,6 +715,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
692
715
|
* goes backward to the state of the Store before the change.
|
|
693
716
|
*
|
|
694
717
|
* ```js
|
|
718
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
719
|
+
*
|
|
695
720
|
* const store = createStore().setTables({pets: {fido: {sold: false}}});
|
|
696
721
|
*
|
|
697
722
|
* const checkpoints = createCheckpoints(store);
|
|
@@ -736,6 +761,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
736
761
|
* forward again to restore the state with the changes.
|
|
737
762
|
*
|
|
738
763
|
* ```js
|
|
764
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
765
|
+
*
|
|
739
766
|
* const store = createStore().setTables({pets: {fido: {sold: false}}});
|
|
740
767
|
*
|
|
741
768
|
* const checkpoints = createCheckpoints(store);
|
|
@@ -766,6 +793,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
766
793
|
* has no effect.
|
|
767
794
|
*
|
|
768
795
|
* ```js
|
|
796
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
797
|
+
*
|
|
769
798
|
* const store = createStore().setTables({pets: {fido: {sold: false}}});
|
|
770
799
|
*
|
|
771
800
|
* const checkpoints = createCheckpoints(store);
|
|
@@ -818,6 +847,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
818
847
|
* tries to go to a checkpoint that does not exist.
|
|
819
848
|
*
|
|
820
849
|
* ```js
|
|
850
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
851
|
+
*
|
|
821
852
|
* const store = createStore().setTables({pets: {fido: {sold: false}}});
|
|
822
853
|
*
|
|
823
854
|
* const checkpoints = createCheckpoints(store);
|
|
@@ -878,6 +909,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
878
909
|
* a change and then clears the checkpoints.
|
|
879
910
|
*
|
|
880
911
|
* ```js
|
|
912
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
913
|
+
*
|
|
881
914
|
* const store = createStore().setTables({pets: {fido: {sold: false}}});
|
|
882
915
|
*
|
|
883
916
|
* const checkpoints = createCheckpoints(store);
|
|
@@ -909,6 +942,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
909
942
|
* // -> {pets: {fido: {sold: true, color: 'brown'}}}
|
|
910
943
|
* console.log(checkpoints.getCheckpointIds());
|
|
911
944
|
* // -> [[], '0', []]
|
|
945
|
+
*
|
|
946
|
+
* checkpoints.delListener(listenerId);
|
|
912
947
|
* ```
|
|
913
948
|
* @category Lifecycle
|
|
914
949
|
*/
|
|
@@ -937,6 +972,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
937
972
|
* a change and then clears the forward checkpoints.
|
|
938
973
|
*
|
|
939
974
|
* ```js
|
|
975
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
976
|
+
*
|
|
940
977
|
* const store = createStore().setTables({pets: {fido: {sold: false}}});
|
|
941
978
|
*
|
|
942
979
|
* const checkpoints = createCheckpoints(store);
|
|
@@ -968,6 +1005,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
968
1005
|
*
|
|
969
1006
|
* console.log(checkpoints.getCheckpointIds());
|
|
970
1007
|
* // -> [['0'], '1', []]
|
|
1008
|
+
*
|
|
1009
|
+
* checkpoints.delListener(listenerId);
|
|
971
1010
|
* ```
|
|
972
1011
|
* @category Lifecycle
|
|
973
1012
|
* @since v4.5.3
|
|
@@ -986,6 +1025,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
986
1025
|
* removing the listener.
|
|
987
1026
|
*
|
|
988
1027
|
* ```js
|
|
1028
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
1029
|
+
*
|
|
989
1030
|
* const store = createStore().setTables({pets: {fido: {sold: false}}});
|
|
990
1031
|
*
|
|
991
1032
|
* const checkpoints = createCheckpoints(store);
|
|
@@ -1019,6 +1060,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
1019
1060
|
* This example gets the listener statistics of a Checkpoints object.
|
|
1020
1061
|
*
|
|
1021
1062
|
* ```js
|
|
1063
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
1064
|
+
*
|
|
1022
1065
|
* const store = createStore();
|
|
1023
1066
|
* const checkpoints = createCheckpoints(store);
|
|
1024
1067
|
* checkpoints.addCheckpointIdsListener(() => {
|
|
@@ -1055,6 +1098,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
1055
1098
|
* This example creates a Checkpoints object.
|
|
1056
1099
|
*
|
|
1057
1100
|
* ```js
|
|
1101
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
1102
|
+
*
|
|
1058
1103
|
* const store = createStore();
|
|
1059
1104
|
* const checkpoints = createCheckpoints(store);
|
|
1060
1105
|
* console.log(checkpoints.getCheckpointIds());
|
|
@@ -1065,6 +1110,8 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
|
|
|
1065
1110
|
* time for the same Store to return the same object.
|
|
1066
1111
|
*
|
|
1067
1112
|
* ```js
|
|
1113
|
+
* import {createCheckpoints, createStore} from 'tinybase';
|
|
1114
|
+
*
|
|
1068
1115
|
* const store = createStore();
|
|
1069
1116
|
* const checkpoints1 = createCheckpoints(store);
|
|
1070
1117
|
* const checkpoints2 = createCheckpoints(store);
|
|
@@ -69,6 +69,8 @@ export type SortKey = string | number | boolean;
|
|
|
69
69
|
* This example creates an Indexes object.
|
|
70
70
|
*
|
|
71
71
|
* ```js
|
|
72
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
73
|
+
*
|
|
72
74
|
* const store = createStore();
|
|
73
75
|
* const indexes = createIndexes(store);
|
|
74
76
|
* console.log(indexes.getIndexIds());
|
|
@@ -80,6 +82,8 @@ export type SortKey = string | number | boolean;
|
|
|
80
82
|
* Ids within them) are alphabetically sorted using the defaultSorter function.
|
|
81
83
|
*
|
|
82
84
|
* ```js
|
|
85
|
+
* import {createIndexes, createStore, defaultSorter} from 'tinybase';
|
|
86
|
+
*
|
|
83
87
|
* const store = createStore().setTable('pets', {
|
|
84
88
|
* fido: {species: 'dog'},
|
|
85
89
|
* felix: {species: 'cat'},
|
|
@@ -217,6 +217,8 @@ export type IndexesListenerStats = {
|
|
|
217
217
|
* and removing a listener for it.
|
|
218
218
|
*
|
|
219
219
|
* ```js
|
|
220
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
221
|
+
*
|
|
220
222
|
* const store = createStore().setTable('pets', {
|
|
221
223
|
* fido: {species: 'dog'},
|
|
222
224
|
* felix: {species: 'cat'},
|
|
@@ -331,6 +333,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
331
333
|
* simple Index based on the values in the `species` Cell.
|
|
332
334
|
*
|
|
333
335
|
* ```js
|
|
336
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
337
|
+
*
|
|
334
338
|
* const store = createStore().setTable('pets', {
|
|
335
339
|
* fido: {species: 'dog'},
|
|
336
340
|
* felix: {species: 'cat'},
|
|
@@ -350,6 +354,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
350
354
|
* Index based on the first letter of the pets' names.
|
|
351
355
|
*
|
|
352
356
|
* ```js
|
|
357
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
358
|
+
*
|
|
353
359
|
* const store = createStore().setTable('pets', {
|
|
354
360
|
* fido: {species: 'dog'},
|
|
355
361
|
* felix: {species: 'cat'},
|
|
@@ -369,6 +375,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
369
375
|
* Index based on each of the letters present in the pets' names.
|
|
370
376
|
*
|
|
371
377
|
* ```js
|
|
378
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
379
|
+
*
|
|
372
380
|
* const store = createStore().setTable('pets', {
|
|
373
381
|
* fido: {species: 'dog'},
|
|
374
382
|
* felix: {species: 'cat'},
|
|
@@ -393,6 +401,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
393
401
|
* Ids within them) are alphabetically sorted.
|
|
394
402
|
*
|
|
395
403
|
* ```js
|
|
404
|
+
* import {createIndexes, createStore, defaultSorter} from 'tinybase';
|
|
405
|
+
*
|
|
396
406
|
* const store = createStore().setTable('pets', {
|
|
397
407
|
* fido: {species: 'dog'},
|
|
398
408
|
* felix: {species: 'cat'},
|
|
@@ -444,6 +454,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
444
454
|
* ```
|
|
445
455
|
*
|
|
446
456
|
* ```js
|
|
457
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
458
|
+
*
|
|
447
459
|
* const store = createStore().setTable('pets', {
|
|
448
460
|
* fido: {species: 'dog'},
|
|
449
461
|
* felix: {species: 'cat'},
|
|
@@ -478,6 +490,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
478
490
|
* ```
|
|
479
491
|
*
|
|
480
492
|
* ```js
|
|
493
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
494
|
+
*
|
|
481
495
|
* const indexes = createIndexes(createStore());
|
|
482
496
|
* indexes.setIndexDefinition('bySpecies', 'pets', 'species');
|
|
483
497
|
* indexes.getStore().setCell('pets', 'fido', 'species', 'dog');
|
|
@@ -497,6 +511,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
497
511
|
* the Ids of the definitions.
|
|
498
512
|
*
|
|
499
513
|
* ```js
|
|
514
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
515
|
+
*
|
|
500
516
|
* const indexes = createIndexes(createStore())
|
|
501
517
|
* .setIndexDefinition('bySpecies', 'pets', 'species')
|
|
502
518
|
* .setIndexDefinition('byColor', 'pets', 'color');
|
|
@@ -529,6 +545,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
529
545
|
* Slice Id within them.
|
|
530
546
|
*
|
|
531
547
|
* ```js
|
|
548
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
549
|
+
*
|
|
532
550
|
* const store = createStore().setTable('pets', {
|
|
533
551
|
* fido: {species: 'dog', color: 'brown'},
|
|
534
552
|
* felix: {species: 'cat', color: 'black'},
|
|
@@ -573,6 +591,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
573
591
|
* This example iterates over each Row in a Slice, and lists its Id.
|
|
574
592
|
*
|
|
575
593
|
* ```js
|
|
594
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
595
|
+
*
|
|
576
596
|
* const store = createStore().setTable('pets', {
|
|
577
597
|
* fido: {species: 'dog'},
|
|
578
598
|
* felix: {species: 'cat'},
|
|
@@ -604,6 +624,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
604
624
|
* This example shows two simple Index existence checks.
|
|
605
625
|
*
|
|
606
626
|
* ```js
|
|
627
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
628
|
+
*
|
|
607
629
|
* const indexes = createIndexes(createStore());
|
|
608
630
|
* indexes.setIndexDefinition('bySpecies', 'pets', 'species');
|
|
609
631
|
* console.log(indexes.hasIndex('bySpecies'));
|
|
@@ -625,6 +647,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
625
647
|
* This example shows two simple Index existence checks.
|
|
626
648
|
*
|
|
627
649
|
* ```js
|
|
650
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
651
|
+
*
|
|
628
652
|
* const store = createStore().setTable('pets', {
|
|
629
653
|
* fido: {species: 'dog'},
|
|
630
654
|
* felix: {species: 'cat'},
|
|
@@ -659,6 +683,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
659
683
|
* queries it (and a non-existent definition) to get the underlying Table Id.
|
|
660
684
|
*
|
|
661
685
|
* ```js
|
|
686
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
687
|
+
*
|
|
662
688
|
* const indexes = createIndexes(createStore());
|
|
663
689
|
* indexes.setIndexDefinition('bySpecies', 'pets', 'species');
|
|
664
690
|
*
|
|
@@ -686,6 +712,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
686
712
|
* the Index (and also the Slice Ids in an Index that has not been defined).
|
|
687
713
|
*
|
|
688
714
|
* ```js
|
|
715
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
716
|
+
*
|
|
689
717
|
* const store = createStore().setTable('pets', {
|
|
690
718
|
* fido: {species: 'dog'},
|
|
691
719
|
* felix: {species: 'cat'},
|
|
@@ -719,6 +747,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
719
747
|
* (and also the Row Ids in Slices that do not exist).
|
|
720
748
|
*
|
|
721
749
|
* ```js
|
|
750
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
751
|
+
*
|
|
722
752
|
* const store = createStore().setTable('pets', {
|
|
723
753
|
* fido: {species: 'dog'},
|
|
724
754
|
* felix: {species: 'cat'},
|
|
@@ -760,6 +790,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
760
790
|
* definition.
|
|
761
791
|
*
|
|
762
792
|
* ```js
|
|
793
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
794
|
+
*
|
|
763
795
|
* const store = createStore().setTable('pets', {
|
|
764
796
|
* fido: {species: 'dog'},
|
|
765
797
|
* felix: {species: 'cat'},
|
|
@@ -810,6 +842,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
810
842
|
* listener that responds to any changes to a specific Index.
|
|
811
843
|
*
|
|
812
844
|
* ```js
|
|
845
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
846
|
+
*
|
|
813
847
|
* const store = createStore().setTable('pets', {
|
|
814
848
|
* fido: {species: 'dog'},
|
|
815
849
|
* felix: {species: 'cat'},
|
|
@@ -819,13 +853,10 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
819
853
|
* const indexes = createIndexes(store);
|
|
820
854
|
* indexes.setIndexDefinition('bySpecies', 'pets', 'species');
|
|
821
855
|
*
|
|
822
|
-
* const listenerId = indexes.addSliceIdsListener(
|
|
823
|
-
* 'bySpecies'
|
|
824
|
-
* (indexes
|
|
825
|
-
*
|
|
826
|
-
* console.log(indexes.getSliceIds('bySpecies'));
|
|
827
|
-
* },
|
|
828
|
-
* );
|
|
856
|
+
* const listenerId = indexes.addSliceIdsListener('bySpecies', (indexes) => {
|
|
857
|
+
* console.log('Slice Ids for bySpecies index changed');
|
|
858
|
+
* console.log(indexes.getSliceIds('bySpecies'));
|
|
859
|
+
* });
|
|
829
860
|
*
|
|
830
861
|
* store.setRow('pets', 'lowly', {species: 'worm'});
|
|
831
862
|
* // -> 'Slice Ids for bySpecies index changed'
|
|
@@ -838,6 +869,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
838
869
|
* listener that responds to any changes to any Index.
|
|
839
870
|
*
|
|
840
871
|
* ```js
|
|
872
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
873
|
+
*
|
|
841
874
|
* const store = createStore().setTable('pets', {
|
|
842
875
|
* fido: {species: 'dog', color: 'brown'},
|
|
843
876
|
* felix: {species: 'cat', color: 'black'},
|
|
@@ -907,6 +940,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
907
940
|
* listener that responds to any changes to a specific Slice.
|
|
908
941
|
*
|
|
909
942
|
* ```js
|
|
943
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
944
|
+
*
|
|
910
945
|
* const store = createStore().setTable('pets', {
|
|
911
946
|
* fido: {species: 'dog'},
|
|
912
947
|
* felix: {species: 'cat'},
|
|
@@ -919,7 +954,7 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
919
954
|
* const listenerId = indexes.addSliceRowIdsListener(
|
|
920
955
|
* 'bySpecies',
|
|
921
956
|
* 'dog',
|
|
922
|
-
* (indexes
|
|
957
|
+
* (indexes) => {
|
|
923
958
|
* console.log('Row Ids for dog slice in bySpecies index changed');
|
|
924
959
|
* console.log(indexes.getSliceRowIds('bySpecies', 'dog'));
|
|
925
960
|
* },
|
|
@@ -936,6 +971,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
936
971
|
* listener that responds to any changes to any Slice.
|
|
937
972
|
*
|
|
938
973
|
* ```js
|
|
974
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
975
|
+
*
|
|
939
976
|
* const store = createStore().setTable('pets', {
|
|
940
977
|
* fido: {species: 'dog', color: 'brown'},
|
|
941
978
|
* felix: {species: 'cat', color: 'black'},
|
|
@@ -993,6 +1030,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
993
1030
|
* then removes it.
|
|
994
1031
|
*
|
|
995
1032
|
* ```js
|
|
1033
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
1034
|
+
*
|
|
996
1035
|
* const store = createStore().setTable('pets', {
|
|
997
1036
|
* fido: {species: 'dog'},
|
|
998
1037
|
* felix: {species: 'cat'},
|
|
@@ -1002,12 +1041,9 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
1002
1041
|
* const indexes = createIndexes(store);
|
|
1003
1042
|
* indexes.setIndexDefinition('bySpecies', 'pets', 'species');
|
|
1004
1043
|
*
|
|
1005
|
-
* const listenerId = indexes.addSliceIdsListener(
|
|
1006
|
-
* 'bySpecies'
|
|
1007
|
-
*
|
|
1008
|
-
* console.log('Slice Ids for bySpecies index changed');
|
|
1009
|
-
* },
|
|
1010
|
-
* );
|
|
1044
|
+
* const listenerId = indexes.addSliceIdsListener('bySpecies', () => {
|
|
1045
|
+
* console.log('Slice Ids for bySpecies index changed');
|
|
1046
|
+
* });
|
|
1011
1047
|
*
|
|
1012
1048
|
* store.setRow('pets', 'lowly', {species: 'worm'});
|
|
1013
1049
|
* // -> 'Slice Ids for bySpecies index changed'
|
|
@@ -1034,6 +1070,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
1034
1070
|
* and then destroys it again, removing the listener.
|
|
1035
1071
|
*
|
|
1036
1072
|
* ```js
|
|
1073
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
1074
|
+
*
|
|
1037
1075
|
* const store = createStore().setTable('pets', {
|
|
1038
1076
|
* fido: {species: 'dog'},
|
|
1039
1077
|
* felix: {species: 'cat'},
|
|
@@ -1072,6 +1110,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
1072
1110
|
* This example gets the listener statistics of an Indexes object.
|
|
1073
1111
|
*
|
|
1074
1112
|
* ```js
|
|
1113
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
1114
|
+
*
|
|
1075
1115
|
* const store = createStore();
|
|
1076
1116
|
* const indexes = createIndexes(store);
|
|
1077
1117
|
* indexes.addSliceIdsListener(null, () => {
|
|
@@ -1108,6 +1148,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
1108
1148
|
* This example creates an Indexes object.
|
|
1109
1149
|
*
|
|
1110
1150
|
* ```js
|
|
1151
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
1152
|
+
*
|
|
1111
1153
|
* const store = createStore();
|
|
1112
1154
|
* const indexes = createIndexes(store);
|
|
1113
1155
|
* console.log(indexes.getIndexIds());
|
|
@@ -1118,6 +1160,8 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
|
|
|
1118
1160
|
* for the same Store to return the same object.
|
|
1119
1161
|
*
|
|
1120
1162
|
* ```js
|
|
1163
|
+
* import {createIndexes, createStore} from 'tinybase';
|
|
1164
|
+
*
|
|
1121
1165
|
* const store = createStore();
|
|
1122
1166
|
* const indexes1 = createIndexes(store);
|
|
1123
1167
|
* const indexes2 = createIndexes(store);
|
|
@@ -278,6 +278,15 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
|
|
|
278
278
|
*/
|
|
279
279
|
merge(mergeableStore: MergeableStore<Schemas>): MergeableStore<Schemas>;
|
|
280
280
|
|
|
281
|
+
/**
|
|
282
|
+
* The isMergeable methods lets you know if the Store is mergeable.
|
|
283
|
+
*
|
|
284
|
+
* This will always be false for a Store, and true for a MergeableStore.
|
|
285
|
+
* @category Information
|
|
286
|
+
* @since v5.0.0
|
|
287
|
+
*/
|
|
288
|
+
isMergeable: () => boolean;
|
|
289
|
+
|
|
281
290
|
/**
|
|
282
291
|
* The setTablesSchema method lets you specify the TablesSchema of the tabular
|
|
283
292
|
* part of the Store.
|
|
@@ -294,6 +303,8 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
|
|
|
294
303
|
* This example sets the TablesSchema of a Store after it has been created.
|
|
295
304
|
*
|
|
296
305
|
* ```js
|
|
306
|
+
* import {createStore} from 'tinybase';
|
|
307
|
+
*
|
|
297
308
|
* const store = createStore().setTablesSchema({
|
|
298
309
|
* pets: {
|
|
299
310
|
* species: {type: 'string'},
|
|
@@ -328,6 +339,8 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
|
|
|
328
339
|
* This example sets the ValuesSchema of a Store after it has been created.
|
|
329
340
|
*
|
|
330
341
|
* ```js
|
|
342
|
+
* import {createStore} from 'tinybase';
|
|
343
|
+
*
|
|
331
344
|
* const store = createStore().setValuesSchema({
|
|
332
345
|
* open: {type: 'boolean', default: false},
|
|
333
346
|
* });
|
|
@@ -364,6 +377,8 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
|
|
|
364
377
|
* been created.
|
|
365
378
|
*
|
|
366
379
|
* ```js
|
|
380
|
+
* import {createStore} from 'tinybase';
|
|
381
|
+
*
|
|
367
382
|
* const store = createStore().setSchema(
|
|
368
383
|
* {
|
|
369
384
|
* pets: {
|
|
@@ -386,6 +401,8 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
|
|
|
386
401
|
* created.
|
|
387
402
|
*
|
|
388
403
|
* ```js
|
|
404
|
+
* import {createStore} from 'tinybase';
|
|
405
|
+
*
|
|
389
406
|
* const store = createStore().setSchema({
|
|
390
407
|
* pets: {
|
|
391
408
|
* species: {type: 'string'},
|
|
@@ -418,6 +435,8 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
|
|
|
418
435
|
* This example removes the TablesSchema of a Store.
|
|
419
436
|
*
|
|
420
437
|
* ```js
|
|
438
|
+
* import {createStore} from 'tinybase';
|
|
439
|
+
*
|
|
421
440
|
* const store = createStore().setTablesSchema({
|
|
422
441
|
* pets: {species: {type: 'string'}},
|
|
423
442
|
* });
|
|
@@ -438,6 +457,8 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
|
|
|
438
457
|
* This example removes the ValuesSchema of a Store.
|
|
439
458
|
*
|
|
440
459
|
* ```js
|
|
460
|
+
* import {createStore} from 'tinybase';
|
|
461
|
+
*
|
|
441
462
|
* const store = createStore().setValuesSchema({
|
|
442
463
|
* sold: {type: 'boolean', default: false},
|
|
443
464
|
* });
|
|
@@ -462,6 +483,8 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
|
|
|
462
483
|
* This example removes the TablesSchema and ValuesSchema of a Store.
|
|
463
484
|
*
|
|
464
485
|
* ```js
|
|
486
|
+
* import {createStore} from 'tinybase';
|
|
487
|
+
*
|
|
465
488
|
* const store = createStore()
|
|
466
489
|
* .setTablesSchema({
|
|
467
490
|
* pets: {species: {type: 'string'}},
|