From 4687db7e7ba4f23e1c03d87e2d8d5ebc2759427e Mon Sep 17 00:00:00 2001 From: Vitaly Tomilov Date: Wed, 18 Nov 2020 12:37:07 +0000 Subject: [PATCH] docs --- lib/database.js | 4 ++-- lib/formatting.js | 4 ++-- package.json | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/database.js b/lib/database.js index 22e645ed..6190a4c1 100644 --- a/lib/database.js +++ b/lib/database.js @@ -961,7 +961,7 @@ function Database(cn, dc, config) { * @param {string} funcName * Name of the function to be executed. * When it is not same-case, or contains extended symbols, it is double-quoted, as per the `:alias` filter, - * which also supports `.` to auto-split into multiple SQL names. + * which also supports `.`, to auto-split into a composite name. * * @param {array|value|function} [values] * Parameters for the function - one value | array of values | function returning value(s). @@ -991,7 +991,7 @@ function Database(cn, dc, config) { * @param {string} procName * Name of the stored procedure to be executed. * When it is not same-case, or contains extended symbols, it is double-quoted, as per the `:alias` filter, - * which also supports `.` to auto-split into multiple SQL names. + * which also supports `.`, to auto-split into a composite SQL name. * * @param {array|value|function} [values] * Parameters for the procedure - one value | array of values | function returning value(s). diff --git a/lib/formatting.js b/lib/formatting.js index b847b03d..61f30cbd 100644 --- a/lib/formatting.js +++ b/lib/formatting.js @@ -501,14 +501,14 @@ const $as = { * @description * Simpler (non-verbose) version of method {@link formatting.name name}, to handle only a regular string-identifier * that's mostly used as an SQL alias, i.e. it doesn't support `*` or an array/object of names, which in the context of - * an SQL alias would be incorrect. However, it supports `.` as name-separator, for simpler escaping composite names. + * an SQL alias would be incorrect. However, it supports `.` as name-separator, for simpler escaping of composite names. * * The surrounding double quotes are not added when the alias uses a simple syntax: * - it is a same-case single word, without spaces * - it can contain underscores, and can even start with them * - it can contain digits and `$`, but cannot start with those * - * The method will automatically split the string based on `.`, to support composite SQL names. + * The method will automatically split the string with `.`, to support composite SQL names. * * When formatting a query, a variable makes use of this method via modifier `:alias`. See method {@link formatting.format format}. * diff --git a/package.json b/package.json index 361820bd..b4858df0 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "spex": "3.0.2" }, "devDependencies": { - "@types/node": "14.14.7", + "@types/node": "14.14.8", "bluebird": "3.7.2", "coveralls": "3.1.0", "eslint": "7.13.0",