tinybase 4.4.0-beta.0 → 4.4.0-beta.2

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

@@ -15,6 +15,40 @@ import {OptionalSchemas, Store} from '../store';
 import {DocHandle} from 'automerge-repo';
 import {Persister} from '../persisters';
 
+/**
+ * The AutomergePersister interface is a minor extension to the Persister
+ * interface.
+ *
+ * It simply provides an extra getDocHandle method for accessing the Automerge
+ * document handler the Store is being persisted to.
+ * @since v4.3.14
+ */
+export interface AutomergePersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /**
+   * The getDocHandle method returns the Automerge document handler the Store is
+   * being persisted to.
+   * @returns The Automerge document handler.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the Automerge document handler back out again.
+   *
+   * ```js
+   * const docHandler = new AutomergeRepo.Repo({network: []}).create();
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createAutomergePersister(store, docHandler);
+   *
+   * console.log(persister.getDocHandle() == docHandler);
+   * // -> true
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getDocHandle: () => DocHandle<any>;
+}
+
 /**
  * The createAutomergePersister function creates a Persister object that can
  * persist the Store to an Automerge document.
@@ -27,7 +61,7 @@ import {Persister} from '../persisters';
  *   docHandle: DocHandle<any>,
  *   docMapName?: string,
  *   onIgnoredError?: (error: any) => void,
- * ): Persister;
+ * ): AutomergePersister;
  * ```
  *
  * As well as providing a reference to the Store to persist, you must provide
@@ -39,9 +73,9 @@ import {Persister} from '../persisters';
  * @param onIgnoredError An optional handler for the errors that the Persister
  * would otherwise ignore when trying to save or load data. This is suitable for
  * debugging persistence issues in a development environment, since v4.0.4.
- * @returns A reference to the new Persister object.
+ * @returns A reference to the new AutomergePersister object.
  * @example
- * This example creates a Persister object and persists the Store to an
+ * This example creates a AutomergePersister object and persists the Store to an
  * Automerge document.
  *
  * ```js
@@ -120,4 +154,4 @@ export function createAutomergePersister<Schemas extends OptionalSchemas>(
   docHandle: DocHandle<any>,
   docMapName?: string,
   onIgnoredError?: (error: any) => void,
-): Persister<Schemas>;
+): AutomergePersister<Schemas>;

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

@@ -17,6 +17,71 @@
 import {OptionalSchemas, Store} from '../store';
 import {Persister} from '../persisters';
 
+/**
+ * The SessionPersister interface is a minor extension to the Persister
+ * interface.
+ *
+ * It simply provides an extra getStorageName method for accessing the unique
+ * key of the storage location the Store is being persisted to.
+ * @since v4.3.14
+ */
+export interface SessionPersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /**
+   * The getStorageName method returns the unique key of the storage location
+   * the Store is being persisted to.
+   * @returns The unique key of the storage location.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the unique key of the storage location back out again.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createSessionPersister(store, 'pets');
+   *
+   * console.log(persister.getStorageName());
+   * // -> 'pets'
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getStorageName: () => string;
+}
+
+/**
+ * The LocalPersister interface is a minor extension to the Persister interface.
+ *
+ * It simply provides an extra getStorageName method for accessing the unique
+ * key of the storage location the Store is being persisted to.
+ * @since v4.3.14
+ */
+export interface LocalPersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /**
+   * The getStorageName method returns the unique key of the storage location
+   * the Store is being persisted to.
+   * @returns The unique key of the storage location.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the unique key of the storage location back out again.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createLocalPersister(store, 'pets');
+   *
+   * console.log(persister.getStorageName());
+   * // -> 'pets'
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getStorageName: () => string;
+}
+
 /**
  * The createSessionPersister function creates a Persister object that can
  * persist the Store to the browser's session storage.
@@ -28,7 +93,7 @@ import {Persister} from '../persisters';
  *   store: Store,
  *   storageName: string,
  *   onIgnoredError?: (error: any) => void,
- * ): Persister;
+ * ): SessionPersister;
  * ```
  *
  * As well as providing a reference to the Store to persist, you must provide a
@@ -39,9 +104,9 @@ import {Persister} from '../persisters';
  * @param onIgnoredError An optional handler for the errors that the Persister
  * would otherwise ignore when trying to save or load data. This is suitable for
  * debugging persistence issues in a development environment, since v4.0.4.
- * @returns A reference to the new Persister object.
+ * @returns A reference to the new SessionPersister object.
  * @example
- * This example creates a Persister object and persists the Store to the
+ * This example creates a SessionPersister object and persists the Store to the
  * browser's session storage.
  *
  * ```js
@@ -61,11 +126,11 @@ export function createSessionPersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,
   storageName: string,
   onIgnoredError?: (error: any) => void,
-): Persister<Schemas>;
+): SessionPersister<Schemas>;
 
 /**
- * The createLocalPersister function creates a Persister object that can
- * persist the Store to the browser's local storage.
+ * The createLocalPersister function creates a Persister object that can persist
+ * the Store to the browser's local storage.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -74,7 +139,7 @@ export function createSessionPersister<Schemas extends OptionalSchemas>(
  *   store: Store,
  *   storageName: string,
  *   onIgnoredError?: (error: any) => void,
- * ): Persister;
+ * ): LocalPersister;
  * ```
  *
  * As well as providing a reference to the Store to persist, you must provide a
@@ -85,9 +150,9 @@ export function createSessionPersister<Schemas extends OptionalSchemas>(
  * @param onIgnoredError An optional handler for the errors that the Persister
  * would otherwise ignore when trying to save or load data. This is suitable for
  * debugging persistence issues in a development environment, since v4.0.4.
- * @returns A reference to the new Persister object.
+ * @returns A reference to the new LocalPersister object.
  * @example
- * This example creates a Persister object and persists the Store to the
+ * This example creates a LocalPersister object and persists the Store to the
  * browser's local storage.
  *
  * ```js
@@ -107,4 +172,4 @@ export function createLocalPersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,
   storageName: string,
   onIgnoredError?: (error: any) => void,
-): Persister<Schemas>;
+): LocalPersister<Schemas>;

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

@@ -12,6 +12,41 @@ import {DatabasePersisterConfig, Persister} from '../persisters';
 import {OptionalSchemas, Store} from '../store';
 import {DB} from '@vlcn.io/crsqlite-wasm';
 
+/**
+ * The CrSqliteWasmPersister interface is a minor extension to the Persister
+ * interface.
+ *
+ * It simply provides an extra getDb method for accessing a reference to the
+ * database instance the Store is being persisted to.
+ * @since v4.3.14
+ */
+export interface CrSqliteWasmPersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /**
+   * The getDb method returns a reference to the database instance the Store is
+   * being persisted to.
+   * @returns A reference to the database instance.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the database instance back out again.
+   *
+   * ```js
+   * const crSqlite3 = await initWasm();
+   * const db = await crSqlite3.open();
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createCrSqliteWasmPersister(store, db, 'my_tinybase');
+   *
+   * console.log(persister.getDb() == db);
+   * // -> true
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getDb: () => DB;
+}
+
 /**
  * The createCrSqliteWasmPersister function creates a Persister object that can
  * persist the Store to a local CR-SQLite database (in an appropriate
@@ -26,7 +61,7 @@ import {DB} from '@vlcn.io/crsqlite-wasm';
  *   configOrStoreTableName?: DatabasePersisterConfig | string,
  *   onSqlCommand?: (sql: string, args?: any[]) => void,
  *   onIgnoredError?: (error: any) => void,
- * ): Persister;
+ * ): CrSqliteWasmPersister;
  * ```
  *
  * As well as providing a reference to the Store to persist, you must provide a
@@ -54,12 +89,12 @@ import {DB} from '@vlcn.io/crsqlite-wasm';
  * @param onIgnoredError An optional handler for the errors that the Persister
  * would otherwise ignore when trying to save or load data. This is suitable for
  * debugging persistence issues in a development environment, since v4.0.4.
- * @returns A reference to the new Persister object.
+ * @returns A reference to the new CrSqliteWasmPersister object.
  * @example
- * This example creates a Persister object and persists the Store to a local
- * CR-SQLite database as a JSON serialization into the `my_tinybase` table. It
- * makes a change to the database directly and then reloads it back into the
- * Store.
+ * This example creates a CrSqliteWasmPersister object and persists the Store to
+ * a local CR-SQLite database as a JSON serialization into the `my_tinybase`
+ * table. It makes a change to the database directly and then reloads it back
+ * into the Store.
  *
  * ```js
  * const crSqlite3 = await initWasm();
@@ -84,8 +119,8 @@ import {DB} from '@vlcn.io/crsqlite-wasm';
  * persister.destroy();
  * ```
  * @example
- * This example creates a Persister object and persists the Store to a local
- * SQLite database with tabular mapping.
+ * This example creates a CrSqliteWasmPersister object and persists the Store to
+ * a local SQLite database with tabular mapping.
  *
  * ```js
  * const crSqlite3 = await initWasm();
@@ -116,4 +151,4 @@ export function createCrSqliteWasmPersister<Schemas extends OptionalSchemas>(
   configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
   onSqlCommand?: (sql: string, args?: any[]) => void,
   onIgnoredError?: (error: any) => void,
-): Persister<Schemas>;
+): CrSqliteWasmPersister<Schemas>;

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

@@ -15,6 +15,40 @@ import {DatabasePersisterConfig, Persister} from '../persisters';
 import {OptionalSchemas, Store} from '../store';
 import {SQLiteDatabase} from 'expo-sqlite';
 
+/**
+ * The ExpoSqlitePersister interface is a minor extension to the Persister
+ * interface.
+ *
+ * It simply provides an extra getDb method for accessing a reference to the
+ * database instance the Store is being persisted to.
+ * @since v4.3.14
+ */
+export interface ExpoSqlitePersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /**
+   * The getDb method returns a reference to the database instance the Store is
+   * being persisted to.
+   * @returns A reference to the database instance.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the database instance back out again.
+   *
+   * ```js yolo
+   * const db = SQLite.openDatabase('my.db');
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createExpoSqlitePersister(store, db, 'my_tinybase');
+   *
+   * console.log(persister.getDb() == db);
+   * // -> true
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getDb: () => SQLiteDatabase;
+}
+
 /**
  * The createExpoSqlitePersister function creates a Persister object that can
  * persist the Store to a local Expo-SQLite database (in an appropriate React
@@ -29,7 +63,7 @@ import {SQLiteDatabase} from 'expo-sqlite';
  *   configOrStoreTableName?: DatabasePersisterConfig | string,
  *   onSqlCommand?: (sql: string, args?: any[]) => void,
  *   onIgnoredError?: (error: any) => void,
- * ): Persister;
+ * ): ExpoSqlitePersister;
  * ```
  *
  * Note that this Persister is currently experimental as Expo themselves iterate
@@ -61,11 +95,11 @@ import {SQLiteDatabase} from 'expo-sqlite';
  * @param onIgnoredError An optional handler for the errors that the Persister
  * would otherwise ignore when trying to save or load data. This is suitable for
  * debugging persistence issues in a development environment, since v4.0.4.
- * @returns A reference to the new Persister object.
+ * @returns A reference to the new ExpoSqlitePersister object.
  * @example
- * This example creates a Persister object and persists the Store to a local
- * SQLite database as a JSON serialization into the `my_tinybase` table. It
- * makes a change to the database directly and then reloads it back into the
+ * This example creates a ExpoSqlitePersister object and persists the Store to a
+ * local SQLite database as a JSON serialization into the `my_tinybase` table.
+ * It makes a change to the database directly and then reloads it back into the
  * Store.
  *
  * ```js yolo
@@ -97,8 +131,8 @@ import {SQLiteDatabase} from 'expo-sqlite';
  * persister.destroy();
  * ```
  * @example
- * This example creates a Persister object and persists the Store to a local
- * SQLite database with tabular mapping.
+ * This example creates a ExpoSqlitePersister object and persists the Store to a
+ * local SQLite database with tabular mapping.
  *
  * ```js yolo
  * const db = SQLite.openDatabase('my.db');
@@ -137,4 +171,4 @@ export function createExpoSqlitePersister<Schemas extends OptionalSchemas>(
   configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
   onSqlCommand?: (sql: string, args?: any[]) => void,
   onIgnoredError?: (error: any) => void,
-): Persister<Schemas>;
+): ExpoSqlitePersister<Schemas>;

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

@@ -9,6 +9,38 @@
 import {OptionalSchemas, Store} from '../store';
 import {Persister} from '../persisters';
 
+/**
+ * The FilePersister interface is a minor extension to the Persister interface.
+ *
+ * It simply provides an extra getFilePath method for accessing the location of
+ * the local file the Store is being persisted to.
+ * @since v4.3.14
+ */
+export interface FilePersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /**
+   * The getFilePath method returns the location of the local file the Store is
+   * being persisted to.
+   * @returns The location of the local file.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the file location back out again.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createFilePersister(store, '/app/persisted.json');
+   *
+   * console.log(persister.getFilePath());
+   * // -> '/app/persisted.json'
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getFilePath: () => string;
+}
+
 /**
  * The createFilePersister function creates a Persister object that can persist
  * the Store to a local file (in an appropriate environment).
@@ -20,7 +52,7 @@ import {Persister} from '../persisters';
  *   store: Store,
  *   filePath: string,
  *   onIgnoredError?: (error: any) => void,
- * ): Persister;
+ * ): FilePersister;
  * ```
  *
  * As well as providing a reference to the Store to persist, you must provide a
@@ -30,9 +62,9 @@ import {Persister} from '../persisters';
  * @param onIgnoredError An optional handler for the errors that the Persister
  * would otherwise ignore when trying to save or load data. This is suitable for
  * debugging persistence issues in a development environment, since v4.0.4.
- * @returns A reference to the new Persister object.
+ * @returns A reference to the new FilePersister object.
  * @example
- * This example creates a Persister object and persists the Store to a local
+ * This example creates a FilePersister object and persists the Store to a local
  * file.
  *
  * ```js yolo
@@ -53,4 +85,4 @@ export function createFilePersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,
   filePath: string,
   onIgnoredError?: (error: any) => void,
-): Persister<Schemas>;
+): FilePersister<Schemas>;

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

@@ -9,6 +9,39 @@
 import {OptionalSchemas, Store} from '../store';
 import {Persister} from '../persisters';
 
+/**
+ * The IndexedDbPersister interface is a minor extension to the Persister
+ * interface.
+ *
+ * It simply provides an extra getDbName method for accessing the unique key of
+ * the IndexedDB the Store is being persisted to.
+ * @since v4.3.14
+ */
+export interface IndexedDbPersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /**
+   * The getDbName method returns the unique key of the IndexedDB the Store is
+   * being persisted to.
+   * @returns The unique key of the IndexedDB.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the unique key of the IndexedDB back out again.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createIndexedDbPersister(store, 'petStore');
+   *
+   * console.log(persister.getDbName());
+   * // -> 'petStore'
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getDbName: () => string;
+}
+
 /**
  * The createIndexedDbPersister function creates a Persister object that can
  * persist the Store to the browser's IndexedDB storage.
@@ -21,7 +54,7 @@ import {Persister} from '../persisters';
  *   dbName: string,
  *   autoLoadIntervalSeconds?: number,
  *   onIgnoredError?: (error: any) => void,
- * ): Persister;
+ * ): IndexedDbPersister;
  * ```
  *
  * As well as providing a reference to the Store to persist, you must provide a
@@ -45,17 +78,16 @@ import {Persister} from '../persisters';
  * @param onIgnoredError An optional handler for the errors that the Persister
  * would otherwise ignore when trying to save or load data. This is suitable for
  * debugging persistence issues in a development environment.
- * @returns A reference to the new Persister object.
+ * @returns A reference to the new IndexedDbPersister object.
  * @example
- * This example creates a Persister object and persists the Store to the
- * browser's IndexedDB storage.
+ * This example creates a IndexedDbPersister object and persists the Store to
+ * the browser's IndexedDB storage.
  *
  * ```js
- * const store =
- *   createStore()
- *     .setTable('pets', {fido: {species: 'dog'}})
- *     .setTable('species', {dog: {price: 5}})
- *     .setValues({open: true});
+ * const store = createStore()
+ *   .setTable('pets', {fido: {species: 'dog'}})
+ *   .setTable('species', {dog: {price: 5}})
+ *   .setValues({open: true});
  * const persister = createIndexedDbPersister(store, 'petStore');
  *
  * await persister.save();
@@ -83,4 +115,4 @@ export function createIndexedDbPersister<Schemas extends OptionalSchemas>(
   dbName: string,
   autoLoadIntervalSeconds?: number,
   onIgnoredError?: (error: any) => void,
-): Persister<Schemas>;
+): IndexedDbPersister<Schemas>;

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

@@ -23,6 +23,91 @@ import {OptionalSchemas, Store} from '../store';
 import PartySocket from 'partysocket';
 import {Persister} from '../persisters';
 
+/**
+ * The PartyKitPersister interface is a minor extension to the Persister
+ * interface.
+ *
+ * It simply provides an extra getConnection method for accessing the
+ * PartySocket the Store is being persisted to.
+ * @since v4.3.14
+ */
+export interface PartyKitPersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /**
+   * The getConnection method returns the PartySocket the Store is being
+   * persisted to.
+   * @returns The PartySocket.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the PartySocket back out again.
+   *
+   * ```js yolo
+   * const partySocket = new PartySocket({
+   *   host: PARTYKIT_HOST,
+   *   room: 'my_room',
+   * });
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createPartyKitPersister(store, partySocket);
+   *
+   * console.log(persister.getConnection() == partySocket);
+   * // -> true
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getConnection: () => PartySocket;
+}
+
+/**
+ * The PartyKitPersisterConfig type describes the configuration of a PartyKit
+ * Persister on the client side.
+ *
+ * The defaults (if used on both the server and client) will work fine, but if
+ * you are building more complex PartyKit apps and you need to configure path
+ * names, for example, then this is the thing to use.
+ * @example
+ * When applied to a PartyKit Persister, this PartyKitPersisterConfig will load
+ * and save a JSON serialization from and to an end point in your room called
+ * `/my_tinybase`, and use HTTP (rather than the default HTTPS) as the protocol.
+ *
+ * Note that this would require you to also add the matching storePath setting
+ * to the TinyBasePartyKitServerConfig on the server side.
+ *
+ * ```js
+ * const partyKitPersisterConfig = {
+ *   storeProtocol: 'http',
+ *   storePath: '/my_tinybase',
+ * };
+ * ```
+ * @category Configuration
+ * @since v4.3.9
+ */
+export type PartyKitPersisterConfig = {
+  /**
+   * The HTTP protocol to use (in addition to the websocket channel). This
+   * defaults to 'https' but you may wish to use 'http' for local PartyKit
+   * development.
+   */
+  storeProtocol?: 'http' | 'https';
+  /**
+   * The path used to set and get the whole Store over HTTP(S) on the server.
+   * This must match the storePath property of the TinyBasePartyKitServerConfig
+   * object used on the server. Both default to '/store'.
+   */
+  storePath?: string;
+  /**
+   * The prefix at the beginning of the web socket messages sent between the
+   * client and the server when synchronizing the Store. Use this to make sure
+   * they do not collide with any other message syntax that your room is using.
+   * This must match the messagePrefix property of the
+   * TinyBasePartyKitServerConfig object used on the server. Both default to an
+   * empty string.
+   */
+  messagePrefix?: string;
+};
+
 /**
  * The createPartyKitPersister function creates a Persister object that can
  * persist the Store to durable PartyKit storage, enabling synchronization of
@@ -34,9 +119,9 @@ import {Persister} from '../persisters';
  * createPartyKitPersister(
  *   store: Store,
  *   connection: PartySocket,
- *   storeUrlProtocol?: 'http' | 'https',
+ *   configOrStoreProtocol?: PartyKitPersisterConfig | 'http' | 'https',
  *   onIgnoredError?: (error: any) => void,
- * ): Persister;
+ * ): PartyKitPersister;
  * ```
  *
  * As well as providing a reference to the Store to persist, you must provide a
@@ -63,24 +148,26 @@ import {Persister} from '../persisters';
  * @param store The Store to persist.
  * @param connection The PartySocket to use for participating in the PartyKit
  * room.
- * @param storeUrlProtocol The HTTP protocol to use (in addition to the
- * websocket channel). This defaults to 'https' but you may wish to use 'http'
- * for local PartyKit development.
+ * @param configOrStoreProtocol The PartyKitPersisterConfig configuration for
+ * the Persister, (or a string to specify a HTTP protocol to use, defaulting to
+ * 'https').
  * @param onIgnoredError An optional handler for the errors that the Persister
  * would otherwise ignore when trying to save or load data. This is suitable for
  * debugging persistence issues in a development environment.
- * @returns A reference to the new Persister object.
+ * @returns A reference to the new PartyKitPersister object.
  * @example
- * This example creates a Persister object and persists the Store to the
+ * This example creates a PartyKitPersister object and persists the Store to the
  * browser's IndexedDB storage.
  *
  * ```js yolo
- * const store =
- *   createStore()
- *     .setTable('pets', {fido: {species: 'dog'}})
- *     .setTable('species', {dog: {price: 5}})
- *     .setValues({open: true});
- * const partySocket = new PartySocket({host: PARTYKIT_HOST, room: 'my_room'});
+ * const store = createStore()
+ *   .setTable('pets', {fido: {species: 'dog'}})
+ *   .setTable('species', {dog: {price: 5}})
+ *   .setValues({open: true});
+ * const partySocket = new PartySocket({
+ *   host: PARTYKIT_HOST,
+ *   room: 'my_room',
+ * });
  * const persister = createPartyKitPersister(store, partySocket);
  * await persister.startAutoLoad();
  * await persister.startAutoSave();
@@ -94,6 +181,6 @@ import {Persister} from '../persisters';
 export function createPartyKitPersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,
   connection: PartySocket,
-  storeUrlProtocol?: 'http' | 'https',
+  configOrStoreProtocol?: PartyKitPersisterConfig | 'http' | 'https',
   onIgnoredError?: (error: any) => void,
-): Persister<Schemas>;
+): PartyKitPersister<Schemas>;