Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vitaly-t committed May 25, 2024
1 parent 464b028 commit c9a7105
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 14 deletions.
7 changes: 7 additions & 0 deletions Table.html
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,13 @@ <h5 class="subsection-title">Properties:</h5>



<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="helpers.TableName.html">TableName</a>, <a href="helpers.html#._TN">_TN</a></li>
</ul>
</dd>



</dl>
Expand Down
4 changes: 2 additions & 2 deletions helpers.ColumnSet.html
Original file line number Diff line number Diff line change
Expand Up @@ -211,10 +211,10 @@ <h6>Properties</h6>
<span class="param-type"><a href="helpers.TableName.html">helpers.TableName</a></span>
|

<span class="param-type">string</span>
<span class="param-type"><a href="Table.html">Table</a></span>
|

<span class="param-type">Object</span>
<span class="param-type">string</span>



Expand Down
4 changes: 2 additions & 2 deletions helpers.TableName.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ <h5>Parameters:</h5>
<span class="param-type">string</span>
|

<span class="param-type">object</span>
<span class="param-type"><a href="Table.html">Table</a></span>



Expand All @@ -113,7 +113,7 @@ <h5>Parameters:</h5>
<td class="description last"><p>Table name details, depending on the type:</p>
<ul>
<li>table name, if <code>table</code> is a string</li>
<li>object <code>{table, [schema]}</code></li>
<li><a href="Table.html">Table</a> object</li>
</ul></td>
</tr>

Expand Down
17 changes: 12 additions & 5 deletions helpers.html
Original file line number Diff line number Diff line change
Expand Up @@ -416,13 +416,20 @@ <h4 class="name" id="._TN"><span class="type-signature">(static) </span>_TN<span

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="helpers_table-name.js.html">helpers/table-name.js</a>, <a href="helpers_table-name.js.html#line139">line 139</a>
<a href="helpers_table-name.js.html">helpers/table-name.js</a>, <a href="helpers_table-name.js.html#line141">line 141</a>
</li></ul></dd>





<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="helpers.TableName.html">TableName</a></li>
</ul>
</dd>



</dl>
Expand Down Expand Up @@ -788,10 +795,10 @@ <h5>Parameters:</h5>
<span class="param-type"><a href="helpers.TableName.html">helpers.TableName</a></span>
|

<span class="param-type">string</span>
<span class="param-type"><a href="Table.html">Table</a></span>
|

<span class="param-type">Object</span>
<span class="param-type">string</span>



Expand Down Expand Up @@ -1299,10 +1306,10 @@ <h5>Parameters:</h5>
<span class="param-type"><a href="helpers.TableName.html">helpers.TableName</a></span>
|

<span class="param-type">string</span>
<span class="param-type"><a href="Table.html">Table</a></span>
|

<span class="param-type">Object</span>
<span class="param-type">string</span>



Expand Down
2 changes: 1 addition & 1 deletion helpers_column-set.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-pg
*
* @param {object} [options]
*
* @param {helpers.TableName|string|{table,schema}} [options.table]
* @param {helpers.TableName|Table|string} [options.table]
* Table details.
*
* When it is a non-null value, and not a {@link helpers.TableName TableName} object, a new {@link helpers.TableName TableName} is constructed from the value.
Expand Down
2 changes: 1 addition & 1 deletion helpers_methods_insert.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-pg
* When the final {@link helpers.ColumnSet ColumnSet} is empty (no columns in it), the method will throw
* {@link external:Error Error} = `Cannot generate an INSERT without any columns.`
*
* @param {helpers.TableName|string|{table,schema}} [table]
* @param {helpers.TableName|Table|string} [table]
* Destination table.
*
* It is normally a required parameter. But when `columns` is passed in as a {@link helpers.ColumnSet ColumnSet} object
Expand Down
2 changes: 1 addition & 1 deletion helpers_methods_update.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-pg
* When the final {@link helpers.ColumnSet ColumnSet} is empty (no columns in it), the method will throw
* {@link external:Error Error} = `Cannot generate an UPDATE without any columns.`, unless option `emptyUpdate` was specified.
*
* @param {helpers.TableName|string|{table,schema}} [table]
* @param {helpers.TableName|Table|string} [table]
* Table to be updated.
*
* It is normally a required parameter. But when `columns` is passed in as a {@link helpers.ColumnSet ColumnSet} object
Expand Down
8 changes: 6 additions & 2 deletions helpers_table-name.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,11 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-pg
*
* Filter `:alias` is an alternative approach to splitting an SQL name into multiple ones.
*
* @param {string|object} table
* @param {string|Table} table
* Table name details, depending on the type:
*
* - table name, if `table` is a string
* - object `{table, [schema]}`
* - {@link Table} object
*
* @property {string} name
* Formatted/escaped full table name, combining `schema` + `table`.
Expand Down Expand Up @@ -163,6 +163,8 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-pg
*
* @property {string} [schema] - schema name, if specified
* @property {string} table - table name
*
* @see {@link helpers.TableName TableName}, {@link helpers._TN _TN}
*/

/**
Expand All @@ -182,6 +184,8 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-pg
* const cs2 = new ColumnSet(['id', 'name'], {table: _TN`${schema}.table`});
*
* @returns {Table}
*
* @see {@link helpers.TableName TableName}
*/
function _TN(a, ...args) {
if (Array.isArray(a) &amp;&amp; a.raw) {
Expand Down

0 comments on commit c9a7105

Please sign in to comment.