@@ -53,7 +53,9 @@ var $arr = require('../array');
53
53
* @see
54
54
*
55
55
* {@link helpers.ColumnSet#columns columns },
56
+ * {@link helpers.ColumnSet#names names},
56
57
* {@link helpers.ColumnSet#table table},
58
+ * {@link helpers.ColumnSet#variables variables} |
57
59
* {@link helpers.ColumnSet.extend extend},
58
60
* {@link helpers.ColumnSet.merge merge}
59
61
*
@@ -234,11 +236,17 @@ function ColumnSet(columns, options) {
234
236
235
237
/**
236
238
* @name helpers.ColumnSet#names
237
- * @private
238
239
* @type String
239
240
* @readonly
240
241
* @description
241
- * A string that contains a comma-separated list of escaped column names, wrapped in `()`.
242
+ * **Added in v5.6.0**
243
+ *
244
+ * Returns a string - comma-separated list of all column names, properly escaped.
245
+ *
246
+ * @example
247
+ * var cs = new ColumnSet(['id^', {name: 'cells', cast: 'int[]'}, 'doc:json']);
248
+ * console.log(cs.names);
249
+ * //=> "id","cells","doc"
242
250
*/
243
251
Object . defineProperty ( this , 'names' , {
244
252
get : function ( ) {
@@ -253,12 +261,17 @@ function ColumnSet(columns, options) {
253
261
254
262
/**
255
263
* @name helpers.ColumnSet#variables
256
- * @private
257
264
* @type String
258
265
* @readonly
259
266
* @description
260
- * Generates a formatting template - a string that contains
261
- * a comma-separated list of all variables with casting.
267
+ * **Added in v5.6.0**
268
+ *
269
+ * Returns a string - formatting template for all column values.
270
+ *
271
+ * @example
272
+ * var cs = new ColumnSet(['id^', {name: 'cells', cast: 'int[]'}, 'doc:json']);
273
+ * console.log(cs.variables);
274
+ * //=> ${id^},${cells}::int[],${doc:json}
262
275
*/
263
276
Object . defineProperty ( this , 'variables' , {
264
277
get : function ( ) {
0 commit comments