[persisters] IndexedDbPersister

Author: jamesgpearce

src/persisters/persister-indexed-db.ts

@@ -1,5 +1,8 @@
 import {IdObj, objHas, objMap, objNew} from '../common/obj';
-import {Persister, PersisterListener} from '../types/persisters';
+import {
+  IndexedDbPersister,
+  createIndexedDbPersister as createIndexedDbPersisterDecl,
+} from '../types/persisters/persister-indexed-db';
 import {Store, Table, Tables, Values} from '../types/store';
 import {T, V} from '../common/strings';
 import {arrayMap, arrayPush} from '../common/array';
@@ -10,8 +13,8 @@ import {
   stopInterval,
 } from '../common/other';
 import {Id} from '../types/common';
+import {PersisterListener} from '../types/persisters';
 import {createCustomPersister} from '../persisters';
-import {createIndexedDbPersister as createIndexedDbPersisterDecl} from '../types/persisters/persister-indexed-db';
 
 const WINDOW = globalThis.window;
 const OBJECT_STORE_NAMES = [T, V];
@@ -48,7 +51,7 @@ export const createIndexedDbPersister = ((
   dbName: string,
   autoLoadIntervalSeconds = 1,
   onIgnoredError?: (error: any) => void,
-): Persister => {
+): IndexedDbPersister => {
   const forObjectStores = async (
     forObjectStore: (objectStore: IDBObjectStore, arg: any) => Promise<any>,
     args: any[] = [],
@@ -122,5 +125,5 @@ export const createIndexedDbPersister = ((
     delPersisterListener,
     onIgnoredError,
     ['getDbName', dbName],
-  );
+  ) as IndexedDbPersister;
 }) as typeof createIndexedDbPersisterDecl;

src/types/docs/persisters/persister-indexed-db.js

@@ -6,6 +6,38 @@
  * @module persister-indexed-db
  */
 /// persister-indexed-db
+/**
+ * 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
+ */
+/// IndexedDbPersister
+{
+  /**
+   * 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
+   */
+  /// IndexedDbPersister.getDbName
+}
 /**
  * The createIndexedDbPersister function creates a Persister object that can
  * persist the Store to the browser's IndexedDB storage.
@@ -31,10 +63,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.
- * @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()

src/types/persisters/persister-indexed-db.d.ts

@@ -3,10 +3,16 @@
 import {Persister} from '../persisters';
 import {Store} from '../store';
 
+/// IndexedDbPersister
+export interface IndexedDbPersister extends Persister {
+  /// IndexedDbPersister.getDbName
+  getDbName: () => string;
+}
+
 /// createIndexedDbPersister
 export function createIndexedDbPersister(
   store: Store,
   dbName: string,
   autoLoadIntervalSeconds?: number,
   onIgnoredError?: (error: any) => void,
-): Persister;
+): IndexedDbPersister;

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

@@ -3,10 +3,17 @@
 import {OptionalSchemas, Store} from '../store';
 import {Persister} from '../persisters';
 
+/// IndexedDbPersister
+export interface IndexedDbPersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /// IndexedDbPersister.getDbName
+  getDbName: () => string;
+}
+
 /// createIndexedDbPersister
 export function createIndexedDbPersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,
   dbName: string,
   autoLoadIntervalSeconds?: number,
   onIgnoredError?: (error: any) => void,
-): Persister<Schemas>;
+): IndexedDbPersister<Schemas>;