pg-promise 10.12.0 → 10.14.0

package/lib/formatting.js

@@ -98,7 +98,7 @@ function formatValue({value, fm, cc, options}) {
             if (value instanceof Date) {
                 return $to.date(value, isRaw);
             }
-            if (value instanceof Array) {
+            if (Array.isArray(value)) {
                 return $to.array(value, options);
             }
             if (value instanceof Buffer) {
@@ -115,9 +115,9 @@ function formatValue({value, fm, cc, options}) {
 // Arrays of any depth/dimension are supported.
 //
 // Top-level empty arrays are formatted as literal '{}' to avoid the necessity of explicit type casting,
-// as the server cannot automatically infer type of an empty non-literal array.
+// as the server cannot automatically infer the type of an empty non-literal array.
 function formatArray(array, options) {
-    const loop = a => `[` + a.map(value => value instanceof Array ? loop(value) : formatValue({
+    const loop = a => `[` + a.map(value => Array.isArray(value) ? loop(value) : formatValue({
         value,
         options
     })).join() + `]`;
@@ -128,7 +128,7 @@ function formatArray(array, options) {
 ///////////////////////////////////////////////////////////////////
 // Formats array/object/value as a list of comma-separated values.
 function formatCSV(values, options) {
-    if (values instanceof Array) {
+    if (Array.isArray(values)) {
         return values.map(value => formatValue({value, options})).join();
     }
     if (typeof values === `object` && values !== null) {
@@ -291,7 +291,7 @@ function formatQuery(query, values, raw, options) {
         return formatQuery(query, resolveFunc(ctf.toPostgres, values), raw || ctf.rawType, options);
     }
     if (typeof values === `object` && values !== null) {
-        if (values instanceof Array) {
+        if (Array.isArray(values)) {
             // $1, $2,... formatting to be applied;
             return formatAs.array({query, array: values, raw, options});
         }
@@ -688,7 +688,7 @@ const $as = {
         if (isNull(arr)) {
             return `null`;
         }
-        if (arr instanceof Array) {
+        if (Array.isArray(arr)) {
             return $to.array(arr, options);
         }
         throw new TypeError(`${wrapText(arr)} is not an Array object.`);

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.0",
+  "version": "10.14.0",
   "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.7.13",
+    "@types/node": "18.11.9",
     "bluebird": "3.7.2",
     "coveralls": "3.1.1",
-    "eslint": "8.23.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.2"
+    "typescript": "4.8.4"
   }
 }

package/typescript/README.MD

@@ -9,7 +9,7 @@ Typescript should be able to pick up the definitions without any manual configur
 ### Simple Usage
 
 ```ts
-import * as pgPromise from 'pg-promise';
+import pgPromise from 'pg-promise';
 
 const pgp = pgPromise({/* Initialization Options */});
 

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.
@@ -290,7 +290,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

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