documentation updates.

Author: Vitaly Tomilov

README.md

@@ -195,7 +195,7 @@ var obj = {
     two: 2
 };
 
-format("INSERT INTO table(${this~}) VALUES(${one}, ${two})", obj);
+format('INSERT INTO table(${this~}) VALUES(${one}, ${two})', obj);
 //=>INSERT INTO table("one","two") VALUES(1, 2)
 ```
 
@@ -237,13 +237,13 @@ Below is an example of formatting `LIKE` filter that ends with a second name:
 
 ```js
 // using $1# or $1:value syntax:
-query("...WHERE name LIKE '%$1#'", "O'Connor");
-query("...WHERE name LIKE '%$1:value'", "O'Connor");
+query('...WHERE name LIKE \'%$1#\'', 'O\'Connor');
+query('...WHERE name LIKE \'%$1:value\'', 'O\'Connor');
 //=> ...WHERE name LIKE '%O''Connor'
 
 // using ${propName#} or ${propName:value} syntax:
-query("...WHERE name LIKE '%${filter#}'", {filter: "O'Connor"});
-query("...WHERE name LIKE '%${filter:value}'", {filter: "O'Connor"});
+query('...WHERE name LIKE \'%${filter#}\'', {filter: 'O\'Connor'});
+query('...WHERE name LIKE \'%${filter:value}\'', {filter: 'O\'Connor'});
 //=> ...WHERE name LIKE '%O''Connor'
 ```
 
@@ -582,7 +582,6 @@ A transaction is a special type of task that automatically executes `BEGIN` + `C
 
 ```js
 db.tx(t => {
-    // `t` and `this` here are the same;
     // creating a sequence of transaction queries:
     var q1 = t.none('UPDATE users SET active=$1 WHERE id=$2', [true, 123]);
     var q2 = t.one('INSERT INTO audit(entity, id) VALUES($1, $2) RETURNING id',
@@ -754,7 +753,6 @@ If you prefer writing asynchronous code in a synchronous manner, you can impleme
 
 ```js
 function * getUser(t) {
-    // `t` and `this` here are the same;
     let user = yield t.oneOrNone('SELECT * FROM users WHERE id = $1', 123);
     return yield user || t.one('INSERT INTO users(name) VALUES($1) RETURNING *', 'John');
 }

lib/database.js

@@ -379,6 +379,9 @@ function Database(cn, dc, config) {
          *   - `.message` = `Multiple rows were not expected.`
          *   - `.code` = {@link errors.queryResultErrorCode.multiple queryResultErrorCode.multiple}
          *
+         * @see
+         * {@link Database.oneOrNone}
+         *
          * @example
          *
          * // a query with in-line value transformation:
@@ -390,7 +393,7 @@ function Database(cn, dc, config) {
          * @example
          *
          * // a query with in-line value transformation + conversion:
-         * db.one('SELECT count(*) FROM Users', null, c => +c.count)
+         * db.one('SELECT count(*) FROM Users', [], c => +c.count)
          *     .then(count=> {
          *         // count = a proper integer value, rather than an object with a string
          *     });
@@ -482,7 +485,8 @@ function Database(cn, dc, config) {
          *
          * @see
          * {@link Database.one one},
-         * {@link Database.none none}
+         * {@link Database.none none},
+         * {@link Database.manyOrNone manyOrNone}
          *
          * @example
          *
@@ -530,7 +534,10 @@ function Database(cn, dc, config) {
          * The resolved array is extended with hidden property `duration` - number of milliseconds
          * it took the client to execute the query.
          *
-         * @see {@link Database.any any}
+         * @see
+         * {@link Database.any any},
+         * {@link Database.many many},
+         * {@link Database.none none}
          *
          */
         obj.manyOrNone = function (query, values) {
@@ -623,7 +630,7 @@ function Database(cn, dc, config) {
          *
          * // use of value transformation:
          * // deleting rows and returning the number of rows deleted
-         * db.result('DELETE FROM Events WHERE id = $1', [123], r=>r.rowCount)
+         * db.result('DELETE FROM Events WHERE id = $1', [123], r => r.rowCount)
          *     .then(data=> {
          *         // data = number of rows that were deleted
          *     });
@@ -632,7 +639,7 @@ function Database(cn, dc, config) {
          *
          * // use of value transformation:
          * // getting only column details from a table
-         * db.result('SELECT * FROM Users LIMIT 0', null, r=>r.fields)
+         * db.result('SELECT * FROM Users LIMIT 0', null, r => r.fields)
          *     .then(data=> {
          *         // data = array of column descriptors
          *     });
@@ -968,7 +975,6 @@ function Database(cn, dc, config) {
          *
          * // using the regular callback syntax:
          * db.task(t => {
-         *         // t = this
          *         // t.ctx = task context object
          *
          *         return t.one('SELECT id FROM Users WHERE name = $1', 'John')
@@ -987,7 +993,7 @@ function Database(cn, dc, config) {
          * @example
          *
          * // using the ES6 arrow syntax:
-         * db.task(t=> {
+         * db.task(t => {
          *         // t.ctx = task context object
          *         
          *         return t.one('SELECT id FROM Users WHERE name = $1', 'John')
@@ -1006,8 +1012,7 @@ function Database(cn, dc, config) {
          * @example
          *
          * // using an ES6 generator for the callback:
-         * db.task(function*(t) {
-         *         // t = this
+         * db.task(function * (t) {
          *         // t.ctx = task context object
          *
          *         let user = yield t.one('SELECT id FROM Users WHERE name = $1', 'John');
@@ -1067,7 +1072,6 @@ function Database(cn, dc, config) {
          *
          * // using the regular callback syntax:
          * db.tx(t => {
-         *         // t = this
          *         // t.ctx = transaction context object
          *
          *         return t.one('INSERT INTO Users(name, age) VALUES($1, $2) RETURNING id', ['Mike', 25])
@@ -1108,8 +1112,7 @@ function Database(cn, dc, config) {
          * @example
          *
          * // using an ES6 generator for the callback:
-         * db.tx(function*(t) {
-         *         // t = this
+         * db.tx(function * (t) {
          *         // t.ctx = transaction context object
          *
          *         let user = yield t.one('INSERT INTO Users(name, age) VALUES($1, $2) RETURNING id', ['Mike', 25]);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-promise",
-  "version": "5.6.2",
+  "version": "5.6.3",
   "description": "Promises interface for PostgreSQL",
   "main": "lib/index.js",
   "typings": "typescript/pg-promise.d.ts",