pg-promise 10.12.1 → 10.14.1

package/lib/query.js

@@ -167,12 +167,14 @@ function $query(ctx, query, values, qrm, config) {
                         lastResult = result[result.length - 1];
                         for (let i = 0; i < result.length; i++) {
                             const r = result[i];
+                            makeIterable(r);
                             error = Events.receive(opt, r.rows, r, getContext());
                             if (error) {
                                 break;
                             }
                         }
                     } else {
+                        makeIterable(result);
                         result.duration = Date.now() - start;
                         error = Events.receive(opt, result.rows, result, getContext());
                     }
@@ -258,6 +260,16 @@ function $query(ctx, query, values, qrm, config) {
     });
 }
 
+// Extends Result to provide iterable for the rows;
+//
+// To be removed once the following PR is merged amd released:
+// https://github.com/brianc/node-postgres/pull/2861
+function makeIterable(r) {
+    r[Symbol.iterator] = function () {
+        return this.rows.values();
+    };
+}
+
 module.exports = config => {
     return function (ctx, query, values, qrm) {
         return $query.call(this, ctx, query, values, qrm, config);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-promise",
-  "version": "10.12.1",
+  "version": "10.14.1",
   "description": "PostgreSQL interface for Node.js",
   "main": "lib/index.js",
   "typings": "typescript/pg-promise.d.ts",
@@ -45,16 +45,16 @@
     "spex": "3.2.0"
   },
   "devDependencies": {
-    "@types/node": "18.11.0",
+    "@types/node": "18.11.9",
     "bluebird": "3.7.2",
     "coveralls": "3.1.1",
-    "eslint": "8.25.0",
+    "eslint": "8.27.0",
     "istanbul": "0.4.5",
     "jasmine-node": "3.0.0",
-    "jsdoc": "3.6.11",
+    "jsdoc": "4.0.0",
     "JSONStream": "1.3.5",
     "pg-query-stream": "4.2.4",
     "tslint": "6.1.3",
-    "typescript": "4.8.4"
+    "typescript": "4.9.3"
   }
 }

package/typescript/pg-promise.d.ts

@@ -8,7 +8,7 @@
  */
 
 /////////////////////////////////////////
-// Requires pg-promise v10.5.0 or later.
+// Requires pg-promise v10.14.0 or later.
 /////////////////////////////////////////
 
 // We use ES6 as static promise here, because generic promises are still not supported.
@@ -21,6 +21,26 @@ import * as pg from './pg-subset';
 import * as pgMinify from 'pg-minify';
 import * as spexLib from 'spex';
 
+// internal namespace for "txMode" property:
+declare namespace _txMode {
+    // Transaction Isolation Level;
+    // API: http://vitaly-t.github.io/pg-promise/txMode.html#.isolationLevel
+    enum isolationLevel {
+        none = 0,
+        serializable = 1,
+        repeatableRead = 2,
+        readCommitted = 3
+    }
+
+    // TransactionMode class;
+    // API: http://vitaly-t.github.io/pg-promise/txMode.TransactionMode.html
+    class TransactionMode {
+        constructor(options?: { tiLevel?: isolationLevel, readOnly?: boolean, deferrable?: boolean })
+
+        begin(cap?: boolean): string
+    }
+}
+
 // Main protocol of the library;
 // API: http://vitaly-t.github.io/pg-promise/module-pg-promise.html
 declare namespace pgPromise {
@@ -269,7 +289,7 @@ declare namespace pgPromise {
         constructor(api: IPromiseConfig)
     }
 
-    const txMode: ITXMode;
+    const txMode: typeof _txMode;
     const utils: IUtils;
     const as: IFormatting;
 
@@ -290,7 +310,7 @@ declare namespace pgPromise {
         readonly $pool: pg.IPool
     }
 
-    interface IResultExt extends pg.IResult {
+    interface IResultExt<T = unknown> extends pg.IResult<T> {
         // Property 'duration' exists only in the following context:
         //  - for single-query events 'receive'
         //  - for method Database.result
@@ -311,7 +331,7 @@ declare namespace pgPromise {
         readonly spex: spexLib.ISpex
         readonly errors: typeof errors
         readonly utils: IUtils
-        readonly txMode: ITXMode
+        readonly txMode: typeof txMode
         readonly helpers: IHelpers
         readonly as: IFormatting
         readonly pg: typeof pg
@@ -353,7 +373,7 @@ declare namespace pgPromise {
         any<T = any>(query: QueryParam, values?: any): XPromise<T[]>
 
         // API: http://vitaly-t.github.io/pg-promise/Database.html#result
-        result<T = IResultExt>(query: QueryParam, values?: any, cb?: (value: IResultExt) => T, thisArg?: any): XPromise<T>
+        result<T, R = IResultExt<T>>(query: QueryParam, values?: any, cb?: (value: IResultExt<T>) => R, thisArg?: any): XPromise<R>
 
         // API: http://vitaly-t.github.io/pg-promise/Database.html#multiResult
         multiResult(query: QueryParam, values?: any): XPromise<pg.IResult[]>
@@ -398,7 +418,7 @@ declare namespace pgPromise {
 
         tx<T = any>(tag: string | number, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
 
-        tx<T = any>(options: { tag?: any, mode?: TransactionMode | null }, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
+        tx<T = any>(options: { tag?: any, mode?: _txMode.TransactionMode | null }, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
 
         // Conditional Transactions;
         // API: http://vitaly-t.github.io/pg-promise/Database.html#txIf
@@ -406,7 +426,7 @@ declare namespace pgPromise {
 
         txIf<T = any>(tag: string | number, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
 
-        txIf<T = any>(options: { tag?: any, mode?: TransactionMode | null, reusable?: boolean | ((t: ITask<Ext> & Ext) => boolean), cnd?: boolean | ((t: ITask<Ext> & Ext) => boolean) }, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
+        txIf<T = any>(options: { tag?: any, mode?: _txMode.TransactionMode | null, reusable?: boolean | ((t: ITask<Ext> & Ext) => boolean), cnd?: boolean | ((t: ITask<Ext> & Ext) => boolean) }, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
     }
 
     // Database object in connected state;
@@ -546,23 +566,6 @@ declare namespace pgPromise {
         }
     }
 
-    // Transaction Isolation Level;
-    // API: http://vitaly-t.github.io/pg-promise/txMode.html#.isolationLevel
-    enum isolationLevel {
-        none = 0,
-        serializable = 1,
-        repeatableRead = 2,
-        readCommitted = 3
-    }
-
-    // TransactionMode class;
-    // API: http://vitaly-t.github.io/pg-promise/txMode.TransactionMode.html
-    class TransactionMode {
-        constructor(options?: { tiLevel?: isolationLevel, readOnly?: boolean, deferrable?: boolean })
-
-        begin(cap?: boolean): string
-    }
-
     // Library's Initialization Options
     // API: http://vitaly-t.github.io/pg-promise/module-pg-promise.html
     interface IInitOptions<Ext = {}, C extends pg.IClient = pg.IClient> {
@@ -641,15 +644,8 @@ declare namespace pgPromise {
         value(value: any | (() => any)): string
     }
 
-    // Transaction Mode namespace;
-    // API: http://vitaly-t.github.io/pg-promise/txMode.html
-    interface ITXMode {
-        isolationLevel: typeof isolationLevel
-        TransactionMode: typeof TransactionMode
-    }
-
     interface ITaskArguments<T> extends IArguments {
-        options: { tag?: any, cnd?: any, mode?: TransactionMode | null } & T
+        options: { tag?: any, cnd?: any, mode?: _txMode.TransactionMode | null } & T
 
         cb(): any
     }

package/typescript/pg-subset.d.ts

@@ -39,10 +39,10 @@ declare namespace pg {
         format: string
     }
 
-    interface IResult {
+    interface IResult<T = unknown> extends Iterable<T> {
         command: string
         rowCount: number
-        rows: any[]
+        rows: T[]
         fields: IColumn[]
 
         // properties below are not available within Native Bindings:
@@ -290,13 +290,13 @@ declare namespace pg {
 
     interface IClient extends EventEmitter {
 
-        query(config: any, values: any[], callback: (err: Error, result: IResult) => void): undefined
+        query<T>(config: any, values: any[], callback: (err: Error, result: IResult<T>) => void): undefined
 
-        query(config: any, callback: (err: Error, result: IResult) => void): undefined
+        query<T>(config: any, callback: (err: Error, result: IResult<T>) => void): undefined
 
-        query(config: any, values: any[]): Promise<IResult>
+        query<T>(config: any, values: any[]): Promise<IResult<T>>
 
-        query(config: any): Promise<IResult>
+        query<T>(config: any): Promise<IResult<T>>
 
         connectionParameters: IConnectionParameters
         database: string