[persisters] PartyKitPersister

Author: jamesgpearce

src/persisters/persister-partykit-client.ts

@@ -7,13 +7,14 @@ import {
   deconstruct,
 } from './partykit/common';
 import {
+  PartyKitPersister,
   PartyKitPersisterConfig,
   createPartyKitPersister as createPartyKitPersisterDecl,
 } from '../types/persisters/persister-partykit-client';
-import {Persister, PersisterListener} from '../types/persisters';
 import {ifNotUndefined, isString} from '../common/other';
 import {EMPTY_STRING} from '../common/strings';
 import PartySocket from 'partysocket';
+import {PersisterListener} from '../types/persisters';
 import {createCustomPersister} from '../persisters';
 import {jsonString} from '../common/json';
 
@@ -26,7 +27,7 @@ export const createPartyKitPersister = ((
   connection: PartySocket,
   configOrStoreProtocol?: PartyKitPersisterConfig | 'http' | 'https',
   onIgnoredError?: (error: any) => void,
-): Persister => {
+): PartyKitPersister => {
   const {host, room} = connection.partySocketOptions;
   const {
     storeProtocol = 'https',
@@ -100,5 +101,5 @@ export const createPartyKitPersister = ((
     delPersisterListener,
     onIgnoredError,
     ['getConnection', connection],
-  );
+  ) as PartyKitPersister;
 }) as typeof createPartyKitPersisterDecl;

src/types/docs/persisters/persister-partykit-client.js

@@ -19,6 +19,42 @@
  * @since 4.3.0
  */
 /// persister-partykit-client
+/**
+ * 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
+ */
+/// PartyKitPersister
+{
+  /**
+   * 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
+   */
+  /// PartyKitPersister.getConnection
+}
 /**
  * The PartyKitPersisterConfig type describes the configuration of a PartyKit
  * Persister on the client side.
@@ -102,9 +138,9 @@
  * @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

src/types/persisters/persister-partykit-client.d.ts

@@ -4,6 +4,12 @@ import PartySocket from 'partysocket';
 import {Persister} from '../persisters';
 import {Store} from '../store';
 
+/// PartyKitPersister
+export interface PartyKitPersister extends Persister {
+  /// PartyKitPersister.getConnection
+  getConnection: () => PartySocket;
+}
+
 /// PartyKitPersisterConfig
 export type PartyKitPersisterConfig = {
   /// PartyKitPersisterConfig.storeProtocol
@@ -20,4 +26,4 @@ export function createPartyKitPersister(
   connection: PartySocket,
   configOrStoreProtocol?: PartyKitPersisterConfig | 'http' | 'https',
   onIgnoredError?: (error: any) => void,
-): Persister;
+): PartyKitPersister;

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

@@ -4,6 +4,13 @@ import {OptionalSchemas, Store} from '../store';
 import PartySocket from 'partysocket';
 import {Persister} from '../persisters';
 
+/// PartyKitPersister
+export interface PartyKitPersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /// PartyKitPersister.getConnection
+  getConnection: () => PartySocket;
+}
+
 /// PartyKitPersisterConfig
 export type PartyKitPersisterConfig = {
   /// PartyKitPersisterConfig.storeProtocol
@@ -20,4 +27,4 @@ export function createPartyKitPersister<Schemas extends OptionalSchemas>(
   connection: PartySocket,
   configOrStoreProtocol?: PartyKitPersisterConfig | 'http' | 'https',
   onIgnoredError?: (error: any) => void,
-): Persister<Schemas>;
+): PartyKitPersister<Schemas>;