tinybase 5.0.0-beta.17 → 5.0.0-beta.18

package/lib/types/metrics.d.ts

@@ -216,6 +216,8 @@ export type MetricsListenerStats = {
  * removing a listener for it.
  *
  * ```js
+ * import {createMetrics, createStore} from 'tinybase';
+ *
  * const store = createStore().setTable('species', {
  *   dog: {price: 5},
  *   cat: {price: 4},
@@ -303,6 +305,8 @@ export interface Metrics {
    * simple Metric to count the Row objects in the Table.
    *
    * ```js
+   * import {createMetrics, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -321,6 +325,8 @@ export interface Metrics {
    * objects in the Table.
    *
    * ```js
+   * import {createMetrics, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -338,6 +344,8 @@ export interface Metrics {
    * custom Metric to get the lowest value of each `price` Cell, greater than 2.
    *
    * ```js
+   * import {createMetrics, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -362,6 +370,8 @@ export interface Metrics {
    * functions.
    *
    * ```js
+   * import {createMetrics, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -395,6 +405,8 @@ export interface Metrics {
    * custom Metric to get the average value of a discounted price.
    *
    * ```js
+   * import {createMetrics, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('species', {
    *   dog: {price: 5, discount: 0.3},
    *   cat: {price: 4, discount: 0.2},
@@ -433,6 +445,8 @@ export interface Metrics {
    * Metric, and then removes it.
    *
    * ```js
+   * import {createMetrics, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -461,6 +475,8 @@ export interface Metrics {
    * then gets its reference in order to update its data.
    *
    * ```js
+   * import {createMetrics, createStore} from 'tinybase';
+   *
    * const metrics = createMetrics(createStore());
    * metrics.setMetricDefinition('speciesCount', 'species');
    * metrics.getStore().setCell('species', 'dog', 'price', 5);
@@ -480,6 +496,8 @@ export interface Metrics {
    * the Ids of the definitions.
    *
    * ```js
+   * import {createMetrics, createStore} from 'tinybase';
+   *
    * const metrics = createMetrics(createStore())
    *   .setMetricDefinition('speciesCount', 'species')
    *   .setMetricDefinition('petsCount', 'pets');
@@ -503,6 +521,8 @@ export interface Metrics {
    * This example iterates over each Metric in a Metrics object.
    *
    * ```js
+   * import {createMetrics, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -531,6 +551,8 @@ export interface Metrics {
    * This example shows two simple Metric existence checks.
    *
    * ```js
+   * import {createMetrics, createStore} from 'tinybase';
+   *
    * const store = createStore();
    * const metrics = createMetrics(store);
    * metrics.setMetricDefinition('highestPrice', 'species', 'max', 'price');
@@ -559,6 +581,8 @@ export interface Metrics {
    * queries it (and a non-existent definition) to get the underlying Table Id.
    *
    * ```js
+   * import {createMetrics, createStore} from 'tinybase';
+   *
    * const metrics = createMetrics(createStore());
    * metrics.setMetricDefinition('speciesCount', 'species');
    *
@@ -585,6 +609,8 @@ export interface Metrics {
    * been defined).
    *
    * ```js
+   * import {createMetrics, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -618,6 +644,8 @@ export interface Metrics {
    * definition.
    *
    * ```js
+   * import {createMetrics, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -662,6 +690,8 @@ export interface Metrics {
    * listener that responds to any changes to a specific Metric.
    *
    * ```js
+   * import {createMetrics, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -673,7 +703,7 @@ export interface Metrics {
    *
    * const listenerId = metrics.addMetricListener(
    *   'highestPrice',
-   *   (metrics, metricId, newMetric, oldMetric) => {
+   *   (metrics, _metricId, newMetric, oldMetric) => {
    *     console.log('highestPrice metric changed');
    *     console.log([oldMetric, newMetric]);
    *   },
@@ -690,6 +720,8 @@ export interface Metrics {
    * listener that responds to any changes to any Metric.
    *
    * ```js
+   * import {createMetrics, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -733,6 +765,8 @@ export interface Metrics {
    * then removes it.
    *
    * ```js
+   * import {createMetrics, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -742,12 +776,9 @@ export interface Metrics {
    * const metrics = createMetrics(store);
    * metrics.setMetricDefinition('highestPrice', 'species', 'max', 'price');
    *
-   * const listenerId = metrics.addMetricListener(
-   *   'highestPrice',
-   *   (metrics, metricId, newMetric, oldMetric) => {
-   *     console.log('highestPrice metric changed');
-   *   },
-   * );
+   * const listenerId = metrics.addMetricListener('highestPrice', () => {
+   *   console.log('highestPrice metric changed');
+   * });
    *
    * store.setCell('species', 'horse', 'price', 20);
    * // -> 'highestPrice metric changed'
@@ -774,6 +805,8 @@ export interface Metrics {
    * again, removing the listener.
    *
    * ```js
+   * import {createMetrics, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -809,6 +842,8 @@ export interface Metrics {
    * This example gets the listener statistics of a Metrics object.
    *
    * ```js
+   * import {createMetrics, createStore} from 'tinybase';
+   *
    * const store = createStore();
    * const metrics = createMetrics(store);
    * metrics.addMetricListener(null, () => console.log('Metric changed'));
@@ -835,6 +870,8 @@ export interface Metrics {
  * This example creates a Metrics object.
  *
  * ```js
+ * import {createMetrics, createStore} from 'tinybase';
+ *
  * const store = createStore();
  * const metrics = createMetrics(store);
  * console.log(metrics.getMetricIds());
@@ -845,6 +882,8 @@ export interface Metrics {
  * for the same Store to return the same object.
  *
  * ```js
+ * import {createMetrics, createStore} from 'tinybase';
+ *
  * const store = createStore();
  * const metrics1 = createMetrics(store);
  * const metrics2 = createMetrics(store);

package/lib/types/persisters/persister-automerge.d.ts

@@ -37,7 +37,11 @@ export interface AutomergePersister extends Persister {
    * then gets the Automerge document handler back out again.
    *
    * ```js
-   * const docHandler = new AutomergeRepo.Repo({network: []}).create();
+   * import {Repo} from '@automerge/automerge-repo';
+   * import {createAutomergePersister} from 'tinybase/persisters/persister-automerge';
+   * import {createStore} from 'tinybase';
+   *
+   * const docHandler = new Repo({network: []}).create();
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const persister = createAutomergePersister(store, docHandler);
    *
@@ -71,7 +75,11 @@ export interface AutomergePersister extends Persister {
  * Automerge document.
  *
  * ```js
- * const docHandler = new AutomergeRepo.Repo({network: []}).create();
+ * import {Repo} from '@automerge/automerge-repo';
+ * import {createAutomergePersister} from 'tinybase/persisters/persister-automerge';
+ * import {createStore} from 'tinybase';
+ *
+ * const docHandler = new Repo({network: []}).create();
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = createAutomergePersister(store, docHandler);
  *
@@ -89,8 +97,13 @@ export interface AutomergePersister extends Persister {
  * each other using a network.
  *
  * ```js
+ * import {BroadcastChannelNetworkAdapter} from '@automerge/automerge-repo-network-broadcastchannel';
+ * import {Repo} from '@automerge/automerge-repo';
+ * import {createAutomergePersister} from 'tinybase/persisters/persister-automerge';
+ * import {createStore} from 'tinybase';
+ *
  * // Bind the first Store to a network-enabled automerge-repo
- * const repo1 = new AutomergeRepo.Repo({
+ * const repo1 = new Repo({
  *   network: [new BroadcastChannelNetworkAdapter()],
  * });
  * const docHandler1 = repo1.create();
@@ -101,7 +114,7 @@ export interface AutomergePersister extends Persister {
  * await persister1.startAutoSave();
  *
  * // Bind the second Store to a different network-enabled automerge-repo
- * const repo2 = new AutomergeRepo.Repo({
+ * const repo2 = new Repo({
  *   network: [new BroadcastChannelNetworkAdapter()],
  * });
  * const docHandler2 = repo2.find(docHandler1.documentId);

package/lib/types/persisters/persister-browser.d.ts

@@ -40,6 +40,9 @@ export interface SessionPersister extends Persister<3> {
    * then gets the unique key of the storage location back out again.
    *
    * ```js
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
+   * import {createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const persister = createSessionPersister(store, 'pets');
    *
@@ -75,6 +78,9 @@ export interface LocalPersister extends Persister<3> {
    * then gets the unique key of the storage location back out again.
    *
    * ```js
+   * import {createLocalPersister} from 'tinybase/persisters/persister-browser';
+   * import {createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const persister = createLocalPersister(store, 'pets');
    *
@@ -107,6 +113,9 @@ export interface LocalPersister extends Persister<3> {
  * browser's session storage.
  *
  * ```js
+ * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
+ * import {createStore} from 'tinybase';
+ *
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = createSessionPersister(store, 'pets');
  *
@@ -143,6 +152,9 @@ export function createSessionPersister(
  * browser's local storage.
  *
  * ```js
+ * import {createLocalPersister} from 'tinybase/persisters/persister-browser';
+ * import {createStore} from 'tinybase';
+ *
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = createLocalPersister(store, 'pets');
  *

package/lib/types/persisters/persister-cr-sqlite-wasm.d.ts

@@ -34,6 +34,10 @@ export interface CrSqliteWasmPersister extends Persister {
    * then gets the database instance back out again.
    *
    * ```js
+   * import {createCrSqliteWasmPersister} from 'tinybase/persisters/persister-cr-sqlite-wasm';
+   * import {createStore} from 'tinybase';
+   * import initWasm from '@vlcn.io/crsqlite-wasm';
+   *
    * const crSqlite3 = await initWasm();
    * const db = await crSqlite3.open();
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
@@ -88,6 +92,10 @@ export interface CrSqliteWasmPersister extends Persister {
  * into the Store.
  *
  * ```js
+ * import {createCrSqliteWasmPersister} from 'tinybase/persisters/persister-cr-sqlite-wasm';
+ * import {createStore} from 'tinybase';
+ * import initWasm from '@vlcn.io/crsqlite-wasm';
+ *
  * const crSqlite3 = await initWasm();
  * const db = await crSqlite3.open();
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
@@ -114,6 +122,10 @@ export interface CrSqliteWasmPersister extends Persister {
  * a local SQLite database with tabular mapping.
  *
  * ```js
+ * import {createCrSqliteWasmPersister} from 'tinybase/persisters/persister-cr-sqlite-wasm';
+ * import {createStore} from 'tinybase';
+ * import initWasm from '@vlcn.io/crsqlite-wasm';
+ *
  * const crSqlite3 = await initWasm();
  * const db = await crSqlite3.open();
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});

package/lib/types/persisters/persister-electric-sql.d.ts

@@ -34,10 +34,15 @@ export interface ElectricSqlPersister extends Persister {
    * then gets the Electric client back out again.
    *
    * ```js yolo
+   * import {ElectricDatabase, electrify} from 'electric-sql/wa-sqlite';
+   * import {createElectricSqlPersister} from 'tinybase/persisters/persister-electric-sql';
+   * import {createStore} from 'tinybase';
+   * import {schema} from './generated/client';
+   *
    * const electricClient = await electrify(
    *   await ElectricDatabase.init('electric.db', ''),
    *   schema,
-   *   {url: ELECTRIC_URL},
+   *   {url: import.meta.env.ELECTRIC_SERVICE},
    * );
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const persister = createElectricSqlPersister(
@@ -96,10 +101,15 @@ export interface ElectricSqlPersister extends Persister {
  * into the Store.
  *
  * ```js yolo
+ * import {ElectricDatabase, electrify} from 'electric-sql/wa-sqlite';
+ * import {createElectricSqlPersister} from 'tinybase/persisters/persister-electric-sql';
+ * import {createStore} from 'tinybase';
+ * import {schema} from './generated/client';
+ *
  * const electricClient = await electrify(
  *   await ElectricDatabase.init('electric.db', ''),
  *   schema,
- *   {url: ELECTRIC_URL},
+ *   {url: import.meta.env.ELECTRIC_SERVICE},
  * );
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = createElectricSqlPersister(
@@ -132,10 +142,15 @@ export interface ElectricSqlPersister extends Persister {
  * a local ElectricSql database with tabular mapping.
  *
  * ```js yolo
+ * import {ElectricDatabase, electrify} from 'electric-sql/wa-sqlite';
+ * import {createElectricSqlPersister} from 'tinybase/persisters/persister-electric-sql';
+ * import {createStore} from 'tinybase';
+ * import {schema} from './generated/client';
+ *
  * const electricClient = await electrify(
  *   await ElectricDatabase.init('electric.db', ''),
  *   schema,
- *   {url: ELECTRIC_URL},
+ *   {url: import.meta.env.ELECTRIC_SERVICE},
  * );
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = createElectricSqlPersister(store, electricClient, {

package/lib/types/persisters/persister-expo-sqlite-next.d.ts

@@ -21,6 +21,7 @@
  */
 
 import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
+import {MergeableStore} from '../mergeable-store.d.ts';
 import {SQLiteDatabase} from 'expo-sqlite/next';
 import {Store} from '../store.d.ts';
 
@@ -46,7 +47,11 @@ export interface ExpoSqliteNextPersister extends Persister<3> {
    * then gets the database instance back out again.
    *
    * ```js yolo
-   * const db = SQLite.openDatabaseSync('my.db');
+   * import {createExpoSqliteNextPersister} from 'tinybase/persisters/persister-expo-sqlite-next';
+   * import {createStore} from 'tinybase';
+   * import {openDatabaseSync} from 'expo-sqlite';
+   *
+   * const db = openDatabaseSync('my.db');
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const persister = createExpoSqliteNextPersister(store, db, 'my_tinybase');
    *
@@ -103,7 +108,11 @@ export interface ExpoSqliteNextPersister extends Persister<3> {
  * into the Store.
  *
  * ```js yolo
- * const db = SQLite.openDatabaseSync('my.db');
+ * import {createExpoSqliteNextPersister} from 'tinybase/persisters/persister-expo-sqlite-next';
+ * import {createStore} from 'tinybase';
+ * import {openDatabaseSync} from 'expo-sqlite';
+ *
+ * const db = openDatabaseSync('my.db');
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = createExpoSqliteNextPersister(store, db, 'my_tinybase');
  *
@@ -118,10 +127,12 @@ export interface ExpoSqliteNextPersister extends Persister<3> {
  * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
  *
  * await new Promise((resolve) =>
- *   db.allAsync(
- *     'UPDATE my_tinybase SET store = ' +
- *       `'[{"pets":{"felix":{"species":"cat"}}},{}]' WHERE _id = '_';`,
- *   ),
+ *   db
+ *     .allAsync(
+ *       'UPDATE my_tinybase SET store = ' +
+ *         `'[{"pets":{"felix":{"species":"cat"}}},{}]' WHERE _id = '_';`,
+ *     )
+ *     .then(resolve),
  * );
  * await persister.load();
  * console.log(store.getTables());
@@ -134,7 +145,11 @@ export interface ExpoSqliteNextPersister extends Persister<3> {
  * to a local SQLite database with tabular mapping.
  *
  * ```js yolo
- * const db = SQLite.openDatabaseSync('my.db');
+ * import {createExpoSqliteNextPersister} from 'tinybase/persisters/persister-expo-sqlite-next';
+ * import {createStore} from 'tinybase';
+ * import {openDatabaseSync} from 'expo-sqlite';
+ *
+ * const db = openDatabaseSync('my.db');
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = createExpoSqliteNextPersister(store, db, {
  *   mode: 'tabular',
@@ -164,7 +179,7 @@ export interface ExpoSqliteNextPersister extends Persister<3> {
  * @since v4.5.0
  */
 export function createExpoSqliteNextPersister(
-  store: Store,
+  store: Store | MergeableStore,
   db: SQLiteDatabase,
   configOrStoreTableName?: DatabasePersisterConfig | string,
   onSqlCommand?: (sql: string, args?: any[]) => void,

package/lib/types/persisters/persister-expo-sqlite.d.ts

@@ -20,6 +20,7 @@
  */
 
 import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
+import {MergeableStore} from '../mergeable-store.d.ts';
 import {SQLiteDatabase} from 'expo-sqlite';
 import {Store} from '../store.d.ts';
 
@@ -45,7 +46,11 @@ export interface ExpoSqlitePersister extends Persister<3> {
    * then gets the database instance back out again.
    *
    * ```js yolo
-   * const db = SQLite.openDatabase('my.db');
+   * import {createExpoSqlitePersister} from 'tinybase/persisters/persister-expo-sqlite-next';
+   * import {createStore} from 'tinybase';
+   * import {openDatabase} from 'expo-sqlite';
+   *
+   * const db = openDatabase('my.db');
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const persister = createExpoSqlitePersister(store, db, 'my_tinybase');
    *
@@ -102,7 +107,11 @@ export interface ExpoSqlitePersister extends Persister<3> {
  * Store.
  *
  * ```js yolo
- * const db = SQLite.openDatabase('my.db');
+ * import {createExpoSqlitePersister} from 'tinybase/persisters/persister-expo-sqlite-next';
+ * import {createStore} from 'tinybase';
+ * import {openDatabase} from 'expo-sqlite';
+ *
+ * const db = openDatabase('my.db');
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = createExpoSqlitePersister(store, db, 'my_tinybase');
  *
@@ -134,7 +143,11 @@ export interface ExpoSqlitePersister extends Persister<3> {
  * local SQLite database with tabular mapping.
  *
  * ```js yolo
- * const db = SQLite.openDatabase('my.db');
+ * import {createExpoSqlitePersister} from 'tinybase/persisters/persister-expo-sqlite-next';
+ * import {createStore} from 'tinybase';
+ * import {openDatabase} from 'expo-sqlite';
+ *
+ * const db = openDatabase('my.db');
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = createExpoSqlitePersister(store, db, {
  *   mode: 'tabular',
@@ -165,7 +178,7 @@ export interface ExpoSqlitePersister extends Persister<3> {
  * @since v4.0.3
  */
 export function createExpoSqlitePersister(
-  store: Store,
+  store: Store | MergeableStore,
   db: SQLiteDatabase,
   configOrStoreTableName?: DatabasePersisterConfig | string,
   onSqlCommand?: (sql: string, args?: any[]) => void,

package/lib/types/persisters/persister-file.d.ts

@@ -31,6 +31,9 @@ export interface FilePersister extends Persister<3> {
    * then gets the file location back out again.
    *
    * ```js
+   * import {createFilePersister} from 'tinybase/persisters/persister-file';
+   * import {createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const persister = createFilePersister(store, '/app/persisted.json');
    *
@@ -62,6 +65,9 @@ export interface FilePersister extends Persister<3> {
  * file.
  *
  * ```js yolo
+ * import {createFilePersister} from 'tinybase/persisters/persister-file';
+ * import {createStore} from 'tinybase';
+ *
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = createFilePersister(store, '/app/persisted.json');
  *

package/lib/types/persisters/persister-indexed-db.d.ts

@@ -31,6 +31,9 @@ export interface IndexedDbPersister extends Persister {
    * then gets the unique key of the IndexedDB back out again.
    *
    * ```js
+   * import {createIndexedDbPersister} from 'tinybase/persisters/persister-indexed-db';
+   * import {createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const persister = createIndexedDbPersister(store, 'petStore');
    *
@@ -76,6 +79,9 @@ export interface IndexedDbPersister extends Persister {
  * the browser's IndexedDB storage.
  *
  * ```js
+ * import {createIndexedDbPersister} from 'tinybase/persisters/persister-indexed-db';
+ * import {createStore} from 'tinybase';
+ *
  * const store = createStore()
  *   .setTable('pets', {fido: {species: 'dog'}})
  *   .setTable('species', {dog: {price: 5}})

package/lib/types/persisters/persister-libsql.d.ts

@@ -33,6 +33,10 @@ export interface LibSqlPersister extends Persister {
    * then gets the database client back out again.
    *
    * ```js yolo
+   * import {createClient} from '@libsql/client';
+   * import {createLibSqlPersister} from 'tinybase/persisters/persister-libsql';
+   * import {createStore} from 'tinybase';
+   *
    * const client = createClient({url: 'file:my.db'});
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const persister = createLibSqlPersister(store, client, 'my_tinybase');
@@ -85,6 +89,10 @@ export interface LibSqlPersister extends Persister {
  * Store.
  *
  * ```js yolo
+ * import {createClient} from '@libsql/client';
+ * import {createLibSqlPersister} from 'tinybase/persisters/persister-libsql';
+ * import {createStore} from 'tinybase';
+ *
  * const client = createClient({url: 'file:my.db'});
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = createLibSqlPersister(store, client, 'my_tinybase');
@@ -110,6 +118,10 @@ export interface LibSqlPersister extends Persister {
  * local SQLite database with tabular mapping.
  *
  * ```js yolo
+ * import {createClient} from '@libsql/client';
+ * import {createLibSqlPersister} from 'tinybase/persisters/persister-libsql';
+ * import {createStore} from 'tinybase';
+ *
  * const client = createClient({url: 'file:my.db'});
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = createLibSqlPersister(store, client, {

package/lib/types/persisters/persister-partykit-client.d.ts

@@ -44,8 +44,12 @@ export interface PartyKitPersister extends Persister {
    * then gets the PartySocket back out again.
    *
    * ```js yolo
+   * import PartySocket from 'partysocket';
+   * import {createPartyKitPersister} from 'tinybase/persisters/persister-partykit-client';
+   * import {createStore} from 'tinybase';
+   *
    * const partySocket = new PartySocket({
-   *   host: PARTYKIT_HOST,
+   *   host: '127.0.0.1:1999',
    *   room: 'my_room',
    * });
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
@@ -78,7 +82,7 @@ export interface PartyKitPersister extends Persister {
  * to the TinyBasePartyKitServerConfig on the server side.
  *
  * ```js
- * const partyKitPersisterConfig = {
+ * export const partyKitPersisterConfig = {
  *   storeProtocol: 'http',
  *   storePath: '/my_tinybase',
  * };
@@ -151,12 +155,16 @@ export type PartyKitPersisterConfig = {
  * browser's IndexedDB storage.
  *
  * ```js yolo
+ * import PartySocket from 'partysocket';
+ * import {createPartyKitPersister} from 'tinybase/persisters/persister-partykit-client';
+ * import {createStore} from 'tinybase';
+ *
  * const store = createStore()
  *   .setTable('pets', {fido: {species: 'dog'}})
  *   .setTable('species', {dog: {price: 5}})
  *   .setValues({open: true});
  * const partySocket = new PartySocket({
- *   host: PARTYKIT_HOST,
+ *   host: '127.0.0.1:1999',
  *   room: 'my_room',
  * });
  * const persister = createPartyKitPersister(store, partySocket);