Implementing #322

vitaly-t · May 10, 2017 · a0e2197 · a0e2197
1 parent 495f870
commit a0e2197
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 12 deletions.
diff --git a/lib/database.js b/lib/database.js
@@ -300,7 +300,7 @@ function Database(cn, dc, config) {
     $npm.utils.addReadProp(this, '$cn', cn, true);
 
     /**
-     * @member {string|object} Database.$dc
+     * @member {} Database.$dc
      * @readonly
      * @description
      * **Added in v5.6.8**
@@ -808,7 +808,7 @@ function Database(cn, dc, config) {
          * - Use of a custom iterator has a much better performance than the standard {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map Array.map}
          * - Automatic `this` context through the database protocol
          *
-         * @param {String|Object} query
+         * @param {string|object} query
          * Query to be executed, which can any of the following types:
          * - A non-empty query string
          * - Prepared Statement `{name, text, values, ...}` or {@link PreparedStatement} object

diff --git a/lib/events.js b/lib/events.js
@@ -476,7 +476,7 @@ var $events = {
     /**
      * @event unexpected
      * @param {string} event - unhandled event name.
-     * @param {String|Error} e - unhandled error.
+     * @param {string|Error} e - unhandled error.
      * @private
      */
     unexpected: (event, e) => {

diff --git a/lib/helpers/columnSet.js b/lib/helpers/columnSet.js
@@ -235,15 +235,13 @@ function ColumnSet(columns, options) {
 
     /**
      * @name helpers.ColumnSet#names
-     * @type String
+     * @type string
      * @readonly
      * @description
      * **Added in v5.5.5**
      *
      * Returns a string - comma-separated list of all column names, properly escaped.
      *
-     * This method is primarily for internal use.
-     *
      * @example
      * var cs = new ColumnSet(['id^', {name: 'cells', cast: 'int[]'}, 'doc:json']);
      * console.log(cs.names);
@@ -260,15 +258,13 @@ function ColumnSet(columns, options) {
 
     /**
      * @name helpers.ColumnSet#variables
-     * @type String
+     * @type string
      * @readonly
      * @description
      * **Added in v5.5.5**
      *
      * Returns a string - formatting template for all column values.
      *
-     * This method is primarily for internal use.
-     *
      * @example
      * var cs = new ColumnSet(['id^', {name: 'cells', cast: 'int[]'}, 'doc:json']);
      * console.log(cs.variables);

diff --git a/test/typescript/init.ts b/test/typescript/init.ts
@@ -1,4 +1,5 @@
 import * as pgPromise from '../../typescript/pg-promise';
+import {IConnectionParameters} from "../../typescript/pg-subset";
 
 var pgp: pgPromise.IMain = pgPromise({
     capSQL: true,
@@ -19,6 +20,11 @@ interface Test {
 
 var db = <pgPromise.IDatabase<Test>&Test>pgp('connection');
 
+var connection1:string = <string>db.$cn;
+var connection2:IConnectionParameters = <IConnectionParameters>db.$cn;
+
+var context:any = db.$dc;
+
 db.one('');
 
 db.one(new pgPromise.QueryFile(''));

diff --git a/typescript/pg-promise.d.ts b/typescript/pg-promise.d.ts
@@ -1,5 +1,5 @@
 ////////////////////////////////////////
-// Requires pg-promise v5.6.7 or later.
+// Requires pg-promise v5.6.8 or later.
 ////////////////////////////////////////
 
 import * as XPromise from './ext-promise'; // External Promise Provider
@@ -288,9 +288,17 @@ declare namespace pgPromise {
     interface IDatabase<Ext> extends IBaseProtocol<Ext> {
         connect(options?: TConnectionOptions): XPromise<IConnected<Ext>>;
 
-        // A hidden property, for integrating with third-party libraries.
+        /////////////////////////////////////////////////////////////////////////////
+        // Hidden, read-only properties, for integrating with third-party libraries:
+
         // API: http://vitaly-t.github.io/pg-promise/Database.html#$config
-        $config: ILibConfig<Ext>;
+        readonly $config: ILibConfig<Ext>;
+
+        // API: http://vitaly-t.github.io/pg-promise/Database.html#$cn
+        readonly $cn: string|IConfig;
+
+        // API: http://vitaly-t.github.io/pg-promise/Database.html#$dc
+        readonly $dc: any;
     }
 
     type IConfig = pg.IConnectionParameters;