Merge pull request #48 from mike-north/sqlite3-debugging-hooks

Expose sqlite3 debugging hooks

Author: Theo Gravity

src/Database.js

@@ -9,19 +9,20 @@
 
 import fs from 'fs';
 import path from 'path';
+// eslint-disable-next-line no-unused-vars,import/no-unresolved,import/extensions
+import sqlite3 from 'sqlite3'; // import sqlite3 for jsdoc type information only
 import Statement from './Statement';
 import prepareParams from './utils';
 
 class Database {
-
   /**
    * Initializes a new instance of the database client.
-   * @param driver An instance of SQLite3 driver library.
-   * @param promiseLibrary ES6 Promise library to use.
+   * @param {sqlite3.Database} driver An instance of SQLite3 driver library.
+   * @param {{Promise: PromiseConstructor}} promiseLibrary ES6 Promise library to use.
      */
-  constructor(driver, { Promise }) {
+  constructor(driver, promiseLibrary) {
     this.driver = driver;
-    this.Promise = Promise;
+    this.Promise = promiseLibrary.Promise;
   }
 
   /**
@@ -39,6 +40,16 @@ class Database {
     });
   }
 
+  /**
+   * Register listeners for Sqlite3 events
+   *
+   * @param {'trace'|'profile'|'error'|'open'|'close'} eventName
+   * @param {() => void} listener trigger listener function
+   */
+  on(eventName, listener) {
+    this.driver.on(eventName, listener);
+  }
+
   run(sql) {
     const params = prepareParams(arguments, { offset: 1 });
     const Promise = this.Promise;

src/main.d.ts

@@ -57,6 +57,12 @@ declare module 'sqlite' {
     prepare(sql: string, ...params: any[]): Promise<Statement>;
 
     migrate(options: { force?: string, table?: string, migrationsPath?: string }): Promise<Database>;
+
+    on(event: "trace", listener: (sql: string) => void): void;
+    on(event: "profile", listener: (sql: string, time: number) => void): void;
+    on(event: "error", listener: (err: Error) => void): void;
+    on(event: "open" | "close", listener: () => void): void;
+    on(event: string, listener: (...args: any[]) => void): void;
   }
 
   export function open(filename: string, options?: { mode?: number, verbose?: boolean, promise?: typeof Promise }): Promise<Database>;