[persisters] RemotePersister

Author: jamesgpearce

src/persisters/persister-remote.ts

@@ -1,9 +1,12 @@
-import {Persister, PersisterListener} from '../types/persisters';
+import {
+  RemotePersister,
+  createRemotePersister as createRemotePersisterDecl,
+} from '../types/persisters/persister-remote';
 import {Store, Tables, Values} from '../types/store';
 import {isUndefined, startInterval, stopInterval} from '../common/other';
 import {jsonParse, jsonString} from '../common/json';
+import {PersisterListener} from '../types/persisters';
 import {createCustomPersister} from '../persisters';
-import {createRemotePersister as createRemotePersisterDecl} from '../types/persisters/persister-remote';
 
 const getETag = (response: Response) => response.headers.get('ETag');
 
@@ -13,7 +16,7 @@ export const createRemotePersister = ((
   saveUrl: string,
   autoLoadIntervalSeconds = 5,
   onIgnoredError?: (error: any) => void,
-): Persister => {
+): RemotePersister => {
   let lastEtag: string | null;
 
   const getPersisted = async (): Promise<[Tables, Values]> => {
@@ -56,5 +59,5 @@ export const createRemotePersister = ((
     delPersisterListener,
     onIgnoredError,
     ['getUrls', [loadUrl, saveUrl]],
-  );
+  ) as RemotePersister;
 }) as typeof createRemotePersisterDecl;

src/types/docs/persisters/persister-remote.js

@@ -6,6 +6,42 @@
  * @module persister-remote
  */
 /// persister-remote
+/**
+ * The RemotePersister interface is a minor extension to the Persister
+ * interface.
+ *
+ * It simply provides an extra getUrls method for accessing the URLs the Store
+ * is being persisted to.
+ * @since v4.3.14
+ */
+/// RemotePersister
+{
+  /**
+   * The getUrls method returns the URLs the Store is being persisted to.
+   * @returns The load and save URLs as a two-item array.
+   * @example
+   * This example creates a RemotePersister object against a newly-created Store
+   * and then gets the URLs back out again.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createRemotePersister(
+   *   store,
+   *   'https://example.com/load',
+   *   'https://example.com/save',
+   *   5,
+   * );
+   *
+   * console.log(persister.getUrls());
+   * // -> ['https://example.com/load', 'https://example.com/save']
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  /// RemotePersister.getUrls
+}
 /**
  * The createRemotePersister function creates a Persister object that can
  * persist the Store to a remote server.
@@ -26,10 +62,10 @@
  * @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 RemotePersister object.
  * @example
- * This example creates a Persister object and persists the Store to a remote
- * server.
+ * This example creates a RemotePersister object and persists the Store to a
+ * remote server.
  *
  * ```js yolo
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});

src/types/persisters/persister-remote.d.ts

@@ -3,11 +3,17 @@
 import {Persister} from '../persisters';
 import {Store} from '../store';
 
+/// RemotePersister
+export interface RemotePersister extends Persister {
+  /// RemotePersister.getUrls
+  getUrls: () => [string, string];
+}
+
 /// createRemotePersister
 export function createRemotePersister(
   store: Store,
   loadUrl: string,
   saveUrl: string,
   autoLoadIntervalSeconds?: number,
   onIgnoredError?: (error: any) => void,
-): Persister;
+): RemotePersister;

src/types/with-schemas/persisters/persister-remote.d.ts

@@ -3,11 +3,18 @@
 import {OptionalSchemas, Store} from '../store';
 import {Persister} from '../persisters';
 
+/// RemotePersister
+export interface RemotePersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /// RemotePersister.getUrls
+  getUrls: () => [string, string];
+}
+
 /// createRemotePersister
 export function createRemotePersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,
   loadUrl: string,
   saveUrl: string,
   autoLoadIntervalSeconds?: number,
   onIgnoredError?: (error: any) => void,
-): Persister<Schemas>;
+): RemotePersister<Schemas>;