[persisters] SqliteWasmPersister

Author: jamesgpearce

src/persisters/persister-sqlite-wasm.ts

@@ -1,8 +1,11 @@
-import {DatabasePersisterConfig, Persister} from '../types/persisters';
+import {
+  SqliteWasmPersister,
+  createSqliteWasmPersister as createSqliteWasmPersisterDecl,
+} from '../types/persisters/persister-sqlite-wasm';
 import {UpdateListener, createSqlitePersister} from './sqlite/create';
+import {DatabasePersisterConfig} from '../types/persisters';
 import {IdObj} from '../common/obj';
 import {Store} from '../types/store';
-import {createSqliteWasmPersister as createSqliteWasmPersisterDecl} from '../types/persisters/persister-sqlite-wasm';
 
 export const createSqliteWasmPersister = ((
   store: Store,
@@ -11,7 +14,7 @@ export const createSqliteWasmPersister = ((
   configOrStoreTableName?: DatabasePersisterConfig | string,
   onSqlCommand?: (sql: string, args?: any[]) => void,
   onIgnoredError?: (error: any) => void,
-): Persister =>
+): SqliteWasmPersister =>
   createSqlitePersister(
     store,
     configOrStoreTableName,
@@ -29,4 +32,4 @@ export const createSqliteWasmPersister = ((
     onSqlCommand,
     onIgnoredError,
     db,
-  )) as typeof createSqliteWasmPersisterDecl;
+  ) as SqliteWasmPersister) as typeof createSqliteWasmPersisterDecl;

src/types/docs/persisters/persister-sqlite-wasm.js

@@ -8,6 +8,45 @@
  * @since v4.0.0
  */
 /// persister-sqlite-wasm
+/**
+ * The SqliteWasmPersister 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
+ */
+/// SqliteWasmPersister
+{
+  /**
+   * 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 sqlite3 = await sqlite3InitModule();
+   * const db = new sqlite3.oo1.DB(':memory:', 'c');
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createSqliteWasmPersister(
+   *   store,
+   *   sqlite3,
+   *   db,
+   *   'my_tinybase',
+   * );
+   *
+   * console.log(persister.getDb() == db);
+   * // -> true
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  /// SqliteWasmPersister.getDb
+}
 /**
  * The createSqliteWasmPersister function creates a Persister object that can
  * persist the Store to a local SQLite database (in an appropriate environment).
@@ -40,11 +79,11 @@
  * @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 SqliteWasmPersister 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 SqliteWasmPersister 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
@@ -75,8 +114,8 @@
  * 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 SqliteWasmPersister object and persists the Store to a
+ * local SQLite database with tabular mapping.
  *
  * ```js
  * const sqlite3 = await sqlite3InitModule();

src/types/persisters/persister-sqlite-wasm.d.ts

@@ -3,6 +3,12 @@
 import {DatabasePersisterConfig, Persister} from '../persisters';
 import {Store} from '../store';
 
+/// SqliteWasmPersister
+export interface SqliteWasmPersister extends Persister {
+  /// SqliteWasmPersister.getDb
+  getDb: () => any;
+}
+
 /// createSqliteWasmPersister
 export function createSqliteWasmPersister(
   store: Store,
@@ -11,4 +17,4 @@ export function createSqliteWasmPersister(
   configOrStoreTableName?: DatabasePersisterConfig | string,
   onSqlCommand?: (sql: string, args?: any[]) => void,
   onIgnoredError?: (error: any) => void,
-): Persister;
+): SqliteWasmPersister;

src/types/with-schemas/persisters/persister-sqlite-wasm.d.ts

@@ -3,6 +3,13 @@
 import {DatabasePersisterConfig, Persister} from '../persisters';
 import {OptionalSchemas, Store} from '../store';
 
+/// SqliteWasmPersister
+export interface SqliteWasmPersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /// SqliteWasmPersister.getDb
+  getDb: () => any;
+}
+
 /// createSqliteWasmPersister
 export function createSqliteWasmPersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,
@@ -11,4 +18,4 @@ export function createSqliteWasmPersister<Schemas extends OptionalSchemas>(
   configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
   onSqlCommand?: (sql: string, args?: any[]) => void,
   onIgnoredError?: (error: any) => void,
-): Persister<Schemas>;
+): SqliteWasmPersister<Schemas>;