refactoring TypeScript for _TN function

vitaly-t · May 25, 2024 · 8802545 · 8802545
1 parent 464e844
commit 8802545
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/lib/helpers/table-name.js b/lib/helpers/table-name.js
@@ -140,7 +140,7 @@ npm.utils.addInspection(TableName, function () {
  * @function helpers._TN
  * @description
  * Table-Name helper function, to convert any `"schema.table"` string
- * into `{schema, table}` object.
+ * into `{schema, table}` object. It also works as a template-tag function.
  *
  * @example
  * const {ColumnSet, _TN} = pgp.helpers;
@@ -149,14 +149,15 @@ npm.utils.addInspection(TableName, function () {
  * const cs1 = new ColumnSet(['id', 'name'], {table: _TN('schema.table')});
  *
  * // Using as a template-tag function:
- * const cs2 = new ColumnSet(['id', 'name'], {table: _TN`schema.table`});
+ * const schema = 'schema';
+ * const cs2 = new ColumnSet(['id', 'name'], {table: _TN`${schema}.table`});
  *
  * @returns {Table}
  */
 function _TN(a, ...args) {
  if (Array.isArray(a) && a.raw) {
  a = a.map((b, i) => b + (i < args.length ? args[i] : '')).join('');
- }
+ } // else 'a' is a string
  const [schema, table] = a.split('.');
  return table === undefined ? {table: schema} : {schema, table};
 }

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "pg-promise",
- "version": "11.7.4",
+ "version": "11.7.5",
  "description": "PostgreSQL interface for Node.js",
  "main": "lib/index.js",
  "typings": "typescript/pg-promise.d.ts",

diff --git a/typescript/pg-promise.d.ts b/typescript/pg-promise.d.ts
@@ -708,7 +708,8 @@ declare namespace pgPromise {
  ColumnSet: typeof ColumnSet
  TableName: typeof TableName
 
- _TN: (data: TemplateStringsArray | string, ...args: Array<any>) => ITable
+ _TN(data: TemplateStringsArray, ...args: Array<any>): ITable
+ _TN(s: string) :ITable
  }
 
  interface IGenericPromise {