Moved db out of configuration object

Author: RAnders00

README.md

@@ -29,12 +29,14 @@ async function runMigrations() {
     // (note that migrateInTransaction also accepts single connections, not only pools)
     let migrations = await migrateInTransaction(dbPool, async db => {
         let umzug = new Umzug({
-            storage: new PGStorage({
-                db: db, // required
+            // second parameter (config) is entirely optional
+            storage: new PGStorage(db, {
                 tableName: "MyAppMigration", // optional (default is SchemaMigration)
                 columnName: "MyAppRevisionID" // optional (default is RevisionID)
             }),
             migrations: {
+                // passes the db connection to use to the first parameter of all the up()/down() migrations
+                // you defined for umzug to run
                 params: [db]
             }
         });

lib/index.ts

@@ -3,13 +3,11 @@ import { Storage } from 'umzug';
 import { ident } from 'pg-escape';
 
 export interface PGStorageConfiguration {
-    db: ClientBase;
     tableName: string;
     columnName: string;
 }
 
 const configDefaults: PGStorageConfiguration = {
-    db: undefined!,
     tableName: 'SchemaMigration',
     columnName: 'RevisionID'
 };
@@ -19,12 +17,9 @@ export class PGStorage implements Storage {
     private readonly config: PGStorageConfiguration;
     private tableCreated = false;
 
-    public constructor(partialConfig: Partial<PGStorageConfiguration> = {}) {
-        this.config = Object.assign(partialConfig, configDefaults);
-        this.db = this.config.db;
-        if (this.db == null) {
-            throw new Error('PGStorage requires a db connection or connection pool to be specified');
-        }
+    public constructor(db: ClientBase, partialConfig: Partial<PGStorageConfiguration> = {}) {
+        this.db = db;
+        this.config = Object.assign({}, partialConfig, configDefaults);
     }
 
     private async createTable(): Promise<void> {

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@robotty/umzug-postgres-storage",
-  "version": "1.0.6",
+  "version": "2.0.0",
   "description": "PostgreSQL connector for umzug",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",