pg-promise 12.5.0 → 12.6.1

package/lib/errors/parameterized-query-error.js

@@ -11,7 +11,8 @@ const {QueryFileError} = require('./query-file-error');
 
 const npm = {
     os: require('os'),
-    utils: require('../utils')
+    utils: require('../utils'),
+    inspect: require('util').inspect
 };
 
 /**
@@ -56,40 +57,15 @@ class ParameterizedQueryError extends Error {
     }
 }
 
-/**
- * @method errors.ParameterizedQueryError#toString
- * @description
- * Creates a well-formatted multi-line string that represents the error.
- *
- * It is called automatically when writing the object into the console.
- *
- * @param {number} [level=0]
- * Nested output level, to provide visual offset.
- *
- * @returns {string}
- */
-ParameterizedQueryError.prototype.toString = function (level) {
-    level = level > 0 ? parseInt(level) : 0;
-    const gap0 = npm.utils.messageGap(level),
-        gap1 = npm.utils.messageGap(level + 1),
-        gap2 = npm.utils.messageGap(level + 2),
-        lines = [
-            'ParameterizedQueryError {',
-            gap1 + 'message: "' + this.message + '"',
-            gap1 + 'result: {',
-            gap2 + 'text: ' + npm.utils.toJson(this.result.text),
-            gap2 + 'values: ' + npm.utils.toJson(this.result.values),
-            gap1 + '}'
-        ];
+npm.utils.addInspection(ParameterizedQueryError, function () {
+    const obj = {
+        message: this.message,
+        result: this.result
+    };
     if (this.error) {
-        lines.push(gap1 + 'error: ' + this.error.toString(level + 1));
+        obj.error = this.error;
     }
-    lines.push(gap0 + '}');
-    return lines.join(npm.os.EOL);
-};
-
-npm.utils.addInspection(ParameterizedQueryError, function () {
-    return this.toString();
+    return 'ParameterizedQueryError ' + npm.inspect(obj, {breakLength: 100, depth: 5, colors: true});
 });
 
 module.exports = {ParameterizedQueryError};

package/lib/errors/prepared-statement-error.js

@@ -11,7 +11,8 @@ const {QueryFileError} = require('./query-file-error');
 
 const npm = {
     os: require('os'),
-    utils: require('../utils')
+    utils: require('../utils'),
+    inspect: require('util').inspect
 };
 
 /**
@@ -56,41 +57,15 @@ class PreparedStatementError extends Error {
     }
 }
 
-/**
- * @method errors.PreparedStatementError#toString
- * @description
- * Creates a well-formatted multi-line string that represents the error.
- *
- * It is called automatically when writing the object into the console.
- *
- * @param {number} [level=0]
- * Nested output level, to provide visual offset.
- *
- * @returns {string}
- */
-PreparedStatementError.prototype.toString = function (level) {
-    level = level > 0 ? parseInt(level) : 0;
-    const gap0 = npm.utils.messageGap(level),
-        gap1 = npm.utils.messageGap(level + 1),
-        gap2 = npm.utils.messageGap(level + 2),
-        lines = [
-            'PreparedStatementError {',
-            gap1 + 'message: "' + this.message + '"',
-            gap1 + 'result: {',
-            gap2 + 'name: ' + npm.utils.toJson(this.result.name),
-            gap2 + 'text: ' + npm.utils.toJson(this.result.text),
-            gap2 + 'values: ' + npm.utils.toJson(this.result.values),
-            gap1 + '}'
-        ];
+npm.utils.addInspection(PreparedStatementError, function () {
+    const obj = {
+        message: this.message,
+        result: this.result
+    };
     if (this.error) {
-        lines.push(gap1 + 'error: ' + this.error.toString(level + 1));
+        obj.error = this.error;
     }
-    lines.push(gap0 + '}');
-    return lines.join(npm.os.EOL);
-};
-
-npm.utils.addInspection(PreparedStatementError, function () {
-    return this.toString();
+    return 'PreparedStatementError ' + npm.inspect(obj, {breakLength: 100, depth: 5, colors: true});
 });
 
 module.exports = {PreparedStatementError};

package/lib/errors/query-file-error.js

@@ -10,7 +10,8 @@
 const npm = {
     os: require('os'),
     utils: require('../utils'),
-    minify: require('pg-minify')
+    minify: require('pg-minify'),
+    inspect: require('util').inspect
 };
 
 /**
@@ -59,37 +60,16 @@ class QueryFileError extends Error {
     }
 }
 
-/**
- * @method errors.QueryFileError#toString
- * @description
- * Creates a well-formatted multi-line string that represents the error.
- *
- * It is called automatically when writing the object into the console.
- *
- * @param {number} [level=0]
- * Nested output level, to provide visual offset.
- *
- * @returns {string}
- */
-QueryFileError.prototype.toString = function (level) {
-    level = level > 0 ? parseInt(level) : 0;
-    const gap0 = npm.utils.messageGap(level),
-        gap1 = npm.utils.messageGap(level + 1),
-        lines = [
-            'QueryFileError {',
-            gap1 + 'message: "' + this.message + '"',
-            gap1 + 'options: ' + npm.utils.toJson(this.options),
-            gap1 + 'file: "' + this.file + '"'
-        ];
+npm.utils.addInspection(QueryFileError, function () {
+    const obj = {
+        message: this.message,
+        file: this.file,
+        options: this.options
+    };
     if (this.error) {
-        lines.push(gap1 + 'error: ' + this.error.toString(level + 1));
+        obj.error = this.error;
     }
-    lines.push(gap0 + '}');
-    return lines.join(npm.os.EOL);
-};
-
-npm.utils.addInspection(QueryFileError, function () {
-    return this.toString();
+    return 'QueryFileError ' + npm.inspect(obj, {breakLength: 100, depth: 5, colors: true});
 });
 
 module.exports = {QueryFileError};

package/lib/errors/query-result-error.js

@@ -10,7 +10,8 @@
 const npm = {
     os: require('os'),
     utils: require('../utils'),
-    text: require('../text')
+    text: require('../text'),
+    inspect: require('util').inspect
 };
 
 /**
@@ -102,7 +103,7 @@ const errorMessages = [
  *   error(err, e) {
  *       if (err instanceof QueryResultError) {
  *           // A query returned unexpected number of records, and thus rejected;
- *           
+ *
  *           // we can check the error code, if we want specifics:
  *           if(err.code === qrec.noData) {
  *               // expected some data, but received none;
@@ -112,7 +113,7 @@ const errorMessages = [
  *           // you will get a nicely formatted output.
  *
  *           console.log(err);
- *           
+ *
  *           // See also: err, e.query, e.params, etc.
  *       }
  *   }
@@ -137,38 +138,17 @@ class QueryResultError extends Error {
     }
 }
 
-/**
- * @method errors.QueryResultError#toString
- * @description
- * Creates a well-formatted multi-line string that represents the error.
- *
- * It is called automatically when writing the object into the console.
- *
- * @param {number} [level=0]
- * Nested output level, to provide visual offset.
- *
- * @returns {string}
- */
-QueryResultError.prototype.toString = function (level) {
-    level = level > 0 ? parseInt(level) : 0;
-    const gap0 = npm.utils.messageGap(level),
-        gap1 = npm.utils.messageGap(level + 1),
-        lines = [
-            'QueryResultError {',
-            gap1 + 'code: queryResultErrorCode.' + errorMessages[this.code].name,
-            gap1 + 'message: "' + this.message + '"',
-            gap1 + 'received: ' + this.received,
-            gap1 + 'query: ' + (typeof this.query === 'string' ? '"' + this.query + '"' : npm.utils.toJson(this.query))
-        ];
+npm.utils.addInspection(QueryResultError, function () {
+    const obj = {
+        code: 'queryResultErrorCode.' + errorMessages[this.code].name,
+        message: this.message,
+        received: this.received,
+        query: typeof this.query === 'string' ? this.query : npm.utils.toJson(this.query)
+    };
     if (this.values !== undefined) {
-        lines.push(gap1 + 'values: ' + npm.utils.toJson(this.values));
+        obj.values = this.values;
     }
-    lines.push(gap0 + '}');
-    return lines.join(npm.os.EOL);
-};
-
-npm.utils.addInspection(QueryResultError, function () {
-    return this.toString();
+    return 'QueryResultError ' + npm.inspect(obj, {breakLength: 100, depth: 5, colors: true});
 });
 
 module.exports = {

package/lib/helpers/column-set.js

@@ -428,7 +428,7 @@ ColumnSet.prototype.assignColumns = function (options) {
  * @description
  * Creates a new {@link helpers.ColumnSet ColumnSet}, by joining the two sets of columns.
  *
- * If the two sets contain a column with the same `name` (case-sensitive), an error is thrown (unless `opts.skip` is set to `true`).
+ * If the two sets contain a column with the same `name` (case-sensitive), an error is thrown (unless `options.skip` is set to `true`).
  *
  * @param {helpers.Column|helpers.ColumnSet|array} columns
  * Columns to be appended, of the same type as parameter `columns` during {@link helpers.ColumnSet ColumnSet} construction, except:
@@ -611,43 +611,4 @@ function colDesc(column, source) {
     return a;
 }
 
-/**
- * @method helpers.ColumnSet#toString
- * @description
- * Creates a well-formatted multi-line string that represents the object.
- *
- * It is called automatically when writing the object into the console.
- *
- * @param {number} [level=0]
- * Nested output level, to provide visual offset.
- *
- * @returns {string}
- */
-ColumnSet.prototype.toString = function (level) {
-    level = level > 0 ? parseInt(level) : 0;
-    const gap0 = npm.utils.messageGap(level),
-        gap1 = npm.utils.messageGap(level + 1),
-        lines = [
-            'ColumnSet {'
-        ];
-    if (this.table) {
-        lines.push(gap1 + 'table: ' + this.table);
-    }
-    if (this.columns.length) {
-        lines.push(gap1 + 'columns: [');
-        this.columns.forEach(c => {
-            lines.push(c.toString(2));
-        });
-        lines.push(gap1 + ']');
-    } else {
-        lines.push(gap1 + 'columns: []');
-    }
-    lines.push(gap0 + '}');
-    return lines.join(npm.os.EOL);
-};
-
-npm.utils.addInspection(ColumnSet, function () {
-    return this.toString();
-});
-
 module.exports = {ColumnSet};

package/lib/helpers/column.js

@@ -289,55 +289,6 @@ function isValidVariable(name) {
     return !!m && m[0] === name;
 }
 
-/**
- * @method helpers.Column#toString
- * @description
- * Creates a well-formatted multi-line string that represents the object.
- *
- * It is called automatically when writing the object into the console.
- *
- * @param {number} [level=0]
- * Nested output level, to provide visual offset.
- *
- * @returns {string}
- */
-Column.prototype.toString = function (level) {
-    level = level > 0 ? parseInt(level) : 0;
-    const gap0 = npm.utils.messageGap(level),
-        gap1 = npm.utils.messageGap(level + 1),
-        lines = [
-            gap0 + 'Column {',
-            gap1 + 'name: ' + npm.utils.toJson(this.name)
-        ];
-    if ('prop' in this) {
-        lines.push(gap1 + 'prop: ' + npm.utils.toJson(this.prop));
-    }
-    if ('mod' in this) {
-        lines.push(gap1 + 'mod: ' + npm.utils.toJson(this.mod));
-    }
-    if ('cast' in this) {
-        lines.push(gap1 + 'cast: ' + npm.utils.toJson(this.cast));
-    }
-    if ('cnd' in this) {
-        lines.push(gap1 + 'cnd: ' + npm.utils.toJson(this.cnd));
-    }
-    if ('def' in this) {
-        lines.push(gap1 + 'def: ' + npm.utils.toJson(this.def));
-    }
-    if ('init' in this) {
-        lines.push(gap1 + 'init: [Function]');
-    }
-    if ('skip' in this) {
-        lines.push(gap1 + 'skip: [Function]');
-    }
-    lines.push(gap0 + '}');
-    return lines.join(npm.os.EOL);
-};
-
-npm.utils.addInspection(Column, function () {
-    return this.toString();
-});
-
 /**
  * @typedef helpers.ColumnConfig
  * @description

package/lib/helpers/table-name.js

@@ -114,18 +114,12 @@ TableName.prototype[npm.format.ctf.rawType] = true; // use as pre-formatted
  * @description
  * Creates a well-formatted string that represents the object.
  *
- * It is called automatically when writing the object into the console.
- *
  * @returns {string}
  */
 TableName.prototype.toString = function () {
     return this.name;
 };
 
-npm.utils.addInspection(TableName, function () {
-    return this.toString();
-});
-
 /**
  * @interface Table
  * @description

package/lib/query-file.js

@@ -18,7 +18,8 @@ const npm = {
     path: require('path'),
     minify: require('pg-minify'),
     utils: require('./utils'),
-    formatting: require('./formatting')
+    formatting: require('./formatting'),
+    inspect: require('util').inspect
 };
 
 const file$query = Symbol('QueryFile.query');
@@ -312,38 +313,18 @@ QueryFile.prototype[npm.formatting.as.ctf.toPostgres] = function (self) {
 
 QueryFile.prototype[npm.formatting.as.ctf.rawType] = true; // use as pre-formatted
 
-/**
- * @method QueryFile#toString
- * @description
- * Creates a well-formatted multi-line string that represents the object's current state.
- *
- * It is called automatically when writing the object into the console.
- *
- * @param {number} [level=0]
- * Nested output level, to provide visual offset.
- *
- * @returns {string}
- */
-QueryFile.prototype.toString = function (level) {
-    level = level > 0 ? parseInt(level) : 0;
-    const gap = npm.utils.messageGap(level + 1);
-    const lines = [
-        'QueryFile {'
-    ];
+npm.utils.addInspection(QueryFile, function () {
+    const s = 'QueryFile ';
+    const obj = {
+        file: this.file,
+        options: this.options
+    };
     this.prepare();
-    lines.push(gap + 'file: "' + this.file + '"');
-    lines.push(gap + 'options: ' + npm.utils.toJson(this.options));
     if (this.error) {
-        lines.push(gap + 'error: ' + this.error.toString(level + 1));
-    } else {
-        lines.push(gap + 'query: "' + this[QueryFile.$query] + '"');
+        obj.error = this.error;
     }
-    lines.push(npm.utils.messageGap(level) + '}');
-    return lines.join(npm.os.EOL);
-};
-
-npm.utils.addInspection(QueryFile, function () {
-    return this.toString();
+    obj.query = this[QueryFile.$query];
+    return s + npm.inspect(obj, {breakLength: 100, depth: 5, colors: true});
 });
 
 module.exports = {QueryFile};

package/lib/tx-mode.js

@@ -8,9 +8,13 @@
  */
 
 const {InnerState} = require('./inner-state');
-const {addInspection} = require('./utils');
 const {assert} = require('./assert');
 
+const npm = {
+    addInspection: require('./utils').addInspection,
+    inspect: require('util').inspect
+};
+
 /**
  * @enum {number}
  * @alias txMode.isolationLevel
@@ -22,7 +26,7 @@ const {assert} = require('./assert');
  * @see $[Transaction Isolation]
  */
 const isolationLevel = {
-    /** Isolation level not specified. */
+    /** Isolation level isn't specified. */
     none: 0,
 
     /** `ISOLATION LEVEL SERIALIZABLE` */
@@ -161,8 +165,9 @@ class TransactionMode extends InnerState {
     }
 }
 
-addInspection(TransactionMode, function () {
-    return this.begin(true);
+npm.addInspection(TransactionMode, function () {
+    const obj = {SQL: this.begin(true)};
+    return 'TransactionMode ' + npm.inspect(obj, {breakLength: 100, depth: 5, colors: true});
 });
 
 /**
@@ -187,4 +192,3 @@ module.exports = {
     isolationLevel,
     TransactionMode
 };
-

package/lib/types/parameterized-query.js

@@ -14,7 +14,8 @@ const {assert} = require('../assert');
 
 const npm = {
     EOL: require('os').EOL,
-    utils: require('../utils')
+    utils: require('../utils'),
+    inspect: require('util').inspect
 };
 
 /**
@@ -162,43 +163,26 @@ ParameterizedQuery.prototype.parse = function () {
     return _i.target;
 };
 
-/**
- * @method ParameterizedQuery#toString
- * @description
- * Creates a well-formatted multi-line string that represents the object's current state.
- *
- * It is called automatically when writing the object into the console.
- *
- * @param {number} [level=0]
- * Nested output level, to provide visual offset.
- *
- * @returns {string}
- */
-ParameterizedQuery.prototype.toString = function (level) {
-    level = level > 0 ? parseInt(level) : 0;
-    const gap = npm.utils.messageGap(level + 1);
+npm.utils.addInspection(ParameterizedQuery, function () {
     const pq = this.parse();
-    const lines = [
-        'ParameterizedQuery {'
-    ];
+    const obj = {};
     if (npm.utils.isText(pq.text)) {
-        lines.push(gap + 'text: "' + pq.text + '"');
+        obj.text = pq.text;
     }
     if (this.values !== undefined) {
-        lines.push(gap + 'values: ' + npm.utils.toJson(this.values));
+        obj.values = this.values;
     }
     if (this.binary !== undefined) {
-        lines.push(gap + 'binary: ' + npm.utils.toJson(this.binary));
+        obj.binary = this.binary;
     }
     if (this.rowMode !== undefined) {
-        lines.push(gap + 'rowMode: ' + npm.utils.toJson(this.rowMode));
+        obj.rowMode = this.rowMode;
     }
     if (this.error !== undefined) {
-        lines.push(gap + 'error: ' + this.error.toString(level + 1));
+        obj.error = this.error.message;
     }
-    lines.push(npm.utils.messageGap(level) + '}');
-    return lines.join(npm.EOL);
-};
+    return 'ParameterizedQuery ' + npm.inspect(obj, {breakLength: 100, depth: 5, colors: true});
+});
 
 module.exports = {ParameterizedQuery};
 

package/lib/types/prepared-statement.js

@@ -14,7 +14,8 @@ const {assert} = require('../assert');
 
 const npm = {
     EOL: require('os').EOL,
-    utils: require('../utils')
+    utils: require('../utils'),
+    inspect: require('util').inspect
 };
 
 /**
@@ -206,47 +207,31 @@ PreparedStatement.prototype.parse = function () {
     return _i.target;
 };
 
-/**
- * @method PreparedStatement#toString
- * @description
- * Creates a well-formatted multi-line string that represents the object's current state.
- *
- * It is called automatically when writing the object into the console.
- *
- * @param {number} [level=0]
- * Nested output level, to provide visual offset.
- *
- * @returns {string}
- */
-PreparedStatement.prototype.toString = function (level) {
-    level = level > 0 ? parseInt(level) : 0;
-    const gap = npm.utils.messageGap(level + 1);
-    const ps = this.parse();
-    const lines = [
-        'PreparedStatement {',
-        gap + 'name: ' + npm.utils.toJson(this.name)
-    ];
-    if (npm.utils.isText(ps.text)) {
-        lines.push(gap + 'text: "' + ps.text + '"');
+npm.utils.addInspection(PreparedStatement, function () {
+    const pq = this.parse();
+    const obj = {
+        name: this.name
+    };
+    if (npm.utils.isText(pq.text)) {
+        obj.text = pq.text;
     }
     if (this.values !== undefined) {
-        lines.push(gap + 'values: ' + npm.utils.toJson(this.values));
+        obj.values = this.values;
     }
     if (this.binary !== undefined) {
-        lines.push(gap + 'binary: ' + npm.utils.toJson(this.binary));
+        obj.binary = this.binary;
     }
     if (this.rowMode !== undefined) {
-        lines.push(gap + 'rowMode: ' + npm.utils.toJson(this.rowMode));
+        obj.rowMode = this.rowMode;
     }
     if (this.rows !== undefined) {
-        lines.push(gap + 'rows: ' + npm.utils.toJson(this.rows));
+        obj.rows = this.rows;
     }
-    if (this.error) {
-        lines.push(gap + 'error: ' + this.error.toString(level + 1));
+    if (this.error !== undefined) {
+        obj.error = this.error.message;
     }
-    lines.push(npm.utils.messageGap(level) + '}');
-    return lines.join(npm.EOL);
-};
+    return 'PreparedStatement ' + npm.inspect(obj, {breakLength: 100, depth: 5, colors: true});
+});
 
 module.exports = {PreparedStatement};
 

package/lib/types/server-formatting.js

@@ -1,5 +1,4 @@
 const {InnerState} = require('../inner-state');
-const {addInspection} = require('../utils');
 const utils = require('../utils');
 
 /**
@@ -90,8 +89,4 @@ function setValues(v) {
     }
 }
 
-addInspection(ServerFormatting, function () {
-    return this.toString();
-});
-
 module.exports = {ServerFormatting};

package/lib/utils/index.js

@@ -73,12 +73,6 @@ function getSafeConnection(cn) {
     return maskPassword(cn);
 }
 
-///////////////////////////////////////////
-// Returns a space gap for console output;
-function messageGap(level) {
-    return ' '.repeat(level * 4);
-}
-
 /////////////////////////////////////////
 // Provides platform-neutral inheritance;
 function inherits(child, parent) {
@@ -193,7 +187,6 @@ const exp = {
     addReadProp,
     addReadProperties,
     getSafeConnection,
-    messageGap,
     inherits,
     isConnectivityError
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-promise",
-  "version": "12.5.0",
+  "version": "12.6.1",
   "description": "PostgreSQL interface for Node.js",
   "main": "lib/index.js",
   "typings": "typescript/pg-promise.d.ts",
@@ -50,12 +50,12 @@
     "pg-query-stream": "4.12.0"
   },
   "devDependencies": {
-    "@eslint/js": "9.39.2",
-    "@types/node": "25.1.0",
+    "@eslint/js": "10.0.1",
+    "@types/node": "25.2.3",
     "coveralls": "3.1.1",
-    "cspell": "9.6.2",
-    "eslint": "9.39.2",
-    "globals": "17.2.0",
+    "cspell": "9.6.4",
+    "eslint": "10.0.0",
+    "globals": "17.3.0",
     "jasmine-node": "3.0.0",
     "jsdoc": "4.0.5",
     "JSONStream": "1.3.5",