pg-promise 10.10.1 → 10.10.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-promise",
-  "version": "10.10.1",
+  "version": "10.10.2",
   "description": "PostgreSQL interface for Node.js",
   "main": "lib/index.js",
   "typings": "typescript/pg-promise.d.ts",
@@ -41,21 +41,21 @@
   },
   "dependencies": {
     "assert-options": "0.7.0",
-    "pg": "8.5.1",
+    "pg": "8.6.0",
     "pg-minify": "1.6.2",
     "spex": "3.2.0"
   },
   "devDependencies": {
-    "@types/node": "14.14.37",
+    "@types/node": "15.0.1",
     "bluebird": "3.7.2",
     "coveralls": "3.1.0",
-    "eslint": "7.23.0",
+    "eslint": "7.25.0",
     "istanbul": "0.4.5",
     "jasmine-node": "3.0.0",
     "jsdoc": "3.6.6",
     "JSONStream": "1.3.5",
-    "pg-query-stream": "4.0.0",
+    "pg-query-stream": "4.1.0",
     "tslint": "6.1.3",
-    "typescript": "4.2.3"
+    "typescript": "4.2.4"
   }
 }

package/typescript/README.MD

@@ -1,6 +1,6 @@
 ## TypeScript for pg-promise
 
-Complete TypeScript 3.x (`strict` mode) declarations for [pg-promise].
+Complete TypeScript declarations for [pg-promise].
 
 ### Inclusion
 
@@ -14,12 +14,14 @@ import * as pgPromise from 'pg-promise';
 const pgp = pgPromise({/* Initialization Options */});
 
 const db = pgp('postgres://username:password@host:port/database');
+
+const {value} = await db.one('SELECT 123 as value');
 ```
 
 #### With Extensions
 
 The library supports dynamic protocol extensions, via event [extend], which requires
-explicit extension interface to be declared, and parameterized as shown below.
+explicit extension interface to be declared and parameterized, as shown below.
 
 ```ts
 import * as pgPromise from 'pg-promise';
@@ -33,7 +35,7 @@ interface IExtensions {
 const options: pgPromise.IInitOptions<IExtensions> = {
     extend(obj) {
         obj.findUser = userId => {
-            return obj.one('SELECT * FROM Users WHERE id = $1', userId);
+            return obj.one('SELECT * FROM Users WHERE id = $1', [userId]);
         }
     }
 };
@@ -44,11 +46,17 @@ const pgp = pgPromise(options);
 // database object:
 const db = pgp('postgres://username:password@host:port/database');
 
-// now you can use the extensions everywhere (including tasks and transactions):
-db.findUser(123).then(...);
+// protocol is extended on each level:
+const user = await db.findUser(123);
+
+// ...including inside tasks and transactions:
+await db.task(async t => {
+    const user = await t.findUser(123);
+    // ...etc
+});
 ```
 
-For a complete and comprehensive example, check out [pg-promise-demo].
+For a comprehensive example, check out [pg-promise-demo].
 
 [pg-promise-demo]:https://github.com/vitaly-t/pg-promise-demo
 [extend]:http://vitaly-t.github.io/pg-promise/global.html#event:extend

package/typescript/pg-promise.d.ts

@@ -579,7 +579,8 @@ declare namespace pgPromise {
 
         query?(e: IEventContext<C>): void
 
-        receive?(data: any[], result: IResultExt, e: IEventContext<C>): void
+        // NOTE: result is undefined when data comes from QueryStream, i.e. via method Database.stream
+        receive?(data: any[], result: IResultExt | void, e: IEventContext<C>): void
 
         task?(e: IEventContext<C>): void