[persisters] Sqlite3Persister

Author: jamesgpearce

src/persisters/persister-sqlite3.ts

@@ -1,9 +1,12 @@
-import {DatabasePersisterConfig, Persister} from '../types/persisters';
+import {
+  Sqlite3Persister,
+  createSqlite3Persister as createSqlite3PersisterDecl,
+} from '../types/persisters/persister-sqlite3';
 import {UpdateListener, createSqlitePersister} from './sqlite/create';
 import {Database} from 'sqlite3';
+import {DatabasePersisterConfig} from '../types/persisters';
 import {IdObj} from '../common/obj';
 import {Store} from '../types/store';
-import {createSqlite3Persister as createSqlite3PersisterDecl} from '../types/persisters/persister-sqlite3';
 import {promiseNew} from '../common/other';
 
 const CHANGE = 'change';
@@ -16,7 +19,7 @@ export const createSqlite3Persister = ((
   configOrStoreTableName?: DatabasePersisterConfig | string,
   onSqlCommand?: (sql: string, args?: any[]) => void,
   onIgnoredError?: (error: any) => void,
-): Persister =>
+): Sqlite3Persister =>
   createSqlitePersister(
     store,
     configOrStoreTableName,
@@ -38,4 +41,4 @@ export const createSqlite3Persister = ((
     onSqlCommand,
     onIgnoredError,
     db,
-  )) as typeof createSqlite3PersisterDecl;
+  ) as Sqlite3Persister) as typeof createSqlite3PersisterDecl;

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

@@ -8,6 +8,39 @@
  * @since v4.0.0
  */
 /// persister-sqlite3
+/**
+ * The Sqlite3Persister 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
+ */
+/// Sqlite3Persister
+{
+  /**
+   * 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 db = new sqlite3.Database(':memory:');
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createSqlite3Persister(store, db, 'my_tinybase');
+   *
+   * console.log(persister.getDb() == db);
+   * // -> true
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  /// Sqlite3Persister.getDb
+}
 /**
  * The createSqlite3Persister function creates a Persister object that can
  * persist the Store to a local SQLite database (in an appropriate environment).
@@ -38,11 +71,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 Sqlite3Persister 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 Sqlite3Persister 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
@@ -74,8 +107,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 Sqlite3Persister object and persists the Store to a
+ * local SQLite database with tabular mapping.
  *
  * ```js
  * const db = new sqlite3.Database(':memory:');

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

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

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

@@ -4,6 +4,13 @@ import {DatabasePersisterConfig, Persister} from '../persisters';
 import {OptionalSchemas, Store} from '../store';
 import {Database} from 'sqlite3';
 
+/// Sqlite3Persister
+export interface Sqlite3Persister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /// Sqlite3Persister.getDb
+  getDb: () => Database;
+}
+
 /// createSqlite3Persister
 export function createSqlite3Persister<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,