update docs

This commit is contained in:
Timothy Warren 2014-12-01 14:05:06 -05:00
parent 66f8546779
commit 85da806158
14 changed files with 85 additions and 56 deletions

View File

@ -110,7 +110,7 @@ module.exports = {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
on Tue Nov 18th 2014 using the <a
on Mon Dec 1st 2014 using the <a
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>

View File

@ -252,7 +252,7 @@ module.exports = d;</pre>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
on Tue Nov 18th 2014 using the <a
on Mon Dec 1st 2014 using the <a
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>

View File

@ -213,7 +213,7 @@ module.exports = h;</pre>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
on Tue Nov 18th 2014 using the <a
on Mon Dec 1st 2014 using the <a
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>

View File

@ -148,7 +148,7 @@ query.select('foo')
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
on Tue Nov 18th 2014 using the <a
on Mon Dec 1st 2014 using the <a
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>

View File

@ -354,7 +354,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
on Tue Nov 18th 2014 using the <a
on Mon Dec 1st 2014 using the <a
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>

View File

@ -170,7 +170,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
on Tue Nov 18th 2014 using the <a
on Mon Dec 1st 2014 using the <a
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>

View File

@ -1027,7 +1027,7 @@ in the passed array</p>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
on Tue Nov 18th 2014 using the <a
on Mon Dec 1st 2014 using the <a
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>

View File

@ -83,7 +83,7 @@
<dt>
<h4 class="name" id="module:node-query"><span class="type-signature"></span>require("node-query")<span class="signature">(drivername, connObject, connLib)</span><span class="type-signature"> &rarr; {queryBuilder}</span></h4>
<h4 class="name" id="module:node-query"><span class="type-signature"></span>require("node-query")<span class="signature">(drivername, connObject, <span class="optional">connLib</span>)</span><span class="type-signature"> &rarr; {queryBuilder}</span></h4>
</dt>
@ -113,6 +113,8 @@
<th>Type</th>
<th>Argument</th>
@ -138,6 +140,14 @@
</td>
<td class="attributes">
</td>
@ -161,6 +171,14 @@
</td>
<td class="attributes">
</td>
@ -184,10 +202,20 @@
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The name of the db connection library you are using, eg. mysql or mysql2</p></td>
<td class="description last"><p>The name of the db connection library you are using, eg. mysql or mysql2. Optional if the same as drivername</p></td>
</tr>
@ -385,7 +413,7 @@
<ul class="dummy">
<li>
<a href="node-query.js.html">node-query.js</a>,
<a href="node-query.js.html#sunlight-1-line-44">line 44</a>
<a href="node-query.js.html#sunlight-1-line-46">line 46</a>
</li>
</ul>
</dd>
@ -457,7 +485,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
on Tue Nov 18th 2014 using the <a
on Mon Dec 1st 2014 using the <a
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>

View File

@ -383,7 +383,7 @@
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-880">line 880</a>
<a href="query-builder.js.html#sunlight-1-line-879">line 879</a>
</li>
</ul>
</dd>
@ -519,7 +519,7 @@
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-416">line 416</a>
<a href="query-builder.js.html#sunlight-1-line-415">line 415</a>
</li>
</ul>
</dd>
@ -764,7 +764,7 @@
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-802">line 802</a>
<a href="query-builder.js.html#sunlight-1-line-801">line 801</a>
</li>
</ul>
</dd>
@ -955,7 +955,7 @@
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-942">line 942</a>
<a href="query-builder.js.html#sunlight-1-line-941">line 941</a>
</li>
</ul>
</dd>
@ -1154,7 +1154,7 @@
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-920">line 920</a>
<a href="query-builder.js.html#sunlight-1-line-919">line 919</a>
</li>
</ul>
</dd>
@ -1355,7 +1355,7 @@
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-903">line 903</a>
<a href="query-builder.js.html#sunlight-1-line-902">line 902</a>
</li>
</ul>
</dd>
@ -1546,7 +1546,7 @@
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-931">line 931</a>
<a href="query-builder.js.html#sunlight-1-line-930">line 930</a>
</li>
</ul>
</dd>
@ -1641,7 +1641,7 @@
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-363">line 363</a>
<a href="query-builder.js.html#sunlight-1-line-362">line 362</a>
</li>
</ul>
</dd>
@ -1788,7 +1788,7 @@
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-684">line 684</a>
<a href="query-builder.js.html#sunlight-1-line-683">line 683</a>
</li>
</ul>
</dd>
@ -1875,7 +1875,7 @@
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-783">line 783</a>
<a href="query-builder.js.html#sunlight-1-line-782">line 782</a>
</li>
</ul>
</dd>
@ -1962,7 +1962,7 @@
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-747">line 747</a>
<a href="query-builder.js.html#sunlight-1-line-746">line 746</a>
</li>
</ul>
</dd>
@ -2147,7 +2147,7 @@
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-489">line 489</a>
<a href="query-builder.js.html#sunlight-1-line-488">line 488</a>
</li>
</ul>
</dd>
@ -2357,7 +2357,7 @@
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-825">line 825</a>
<a href="query-builder.js.html#sunlight-1-line-824">line 824</a>
</li>
</ul>
</dd>
@ -2539,7 +2539,7 @@
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-845">line 845</a>
<a href="query-builder.js.html#sunlight-1-line-844">line 844</a>
</li>
</ul>
</dd>
@ -2771,7 +2771,7 @@
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-659">line 659</a>
<a href="query-builder.js.html#sunlight-1-line-658">line 658</a>
</li>
</ul>
</dd>
@ -2997,7 +2997,7 @@
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-438">line 438</a>
<a href="query-builder.js.html#sunlight-1-line-437">line 437</a>
</li>
</ul>
</dd>
@ -3176,7 +3176,7 @@
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-735">line 735</a>
<a href="query-builder.js.html#sunlight-1-line-734">line 734</a>
</li>
</ul>
</dd>
@ -3402,7 +3402,7 @@
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-451">line 451</a>
<a href="query-builder.js.html#sunlight-1-line-450">line 450</a>
</li>
</ul>
</dd>
@ -3593,7 +3593,7 @@
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-707">line 707</a>
<a href="query-builder.js.html#sunlight-1-line-706">line 706</a>
</li>
</ul>
</dd>
@ -3681,7 +3681,7 @@ prefixed with 'OR'</p>
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-760">line 760</a>
<a href="query-builder.js.html#sunlight-1-line-759">line 759</a>
</li>
</ul>
</dd>
@ -3866,7 +3866,7 @@ prefixed with 'OR'</p>
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-503">line 503</a>
<a href="query-builder.js.html#sunlight-1-line-502">line 502</a>
</li>
</ul>
</dd>
@ -4092,7 +4092,7 @@ prefixed with 'OR'</p>
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-464">line 464</a>
<a href="query-builder.js.html#sunlight-1-line-463">line 463</a>
</li>
</ul>
</dd>
@ -4180,7 +4180,7 @@ prefixed with 'OR NOT'</p>
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-772">line 772</a>
<a href="query-builder.js.html#sunlight-1-line-771">line 771</a>
</li>
</ul>
</dd>
@ -4406,7 +4406,7 @@ prefixed with 'OR NOT'</p>
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-477">line 477</a>
<a href="query-builder.js.html#sunlight-1-line-476">line 476</a>
</li>
</ul>
</dd>
@ -4591,7 +4591,7 @@ prefixed with 'OR NOT'</p>
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-529">line 529</a>
<a href="query-builder.js.html#sunlight-1-line-528">line 528</a>
</li>
</ul>
</dd>
@ -4750,7 +4750,7 @@ prefixed with 'OR NOT'</p>
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-597">line 597</a>
<a href="query-builder.js.html#sunlight-1-line-596">line 596</a>
</li>
</ul>
</dd>
@ -4886,7 +4886,7 @@ prefixed with 'OR NOT'</p>
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-573">line 573</a>
<a href="query-builder.js.html#sunlight-1-line-572">line 572</a>
</li>
</ul>
</dd>
@ -5022,7 +5022,7 @@ prefixed with 'OR NOT'</p>
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-562">line 562</a>
<a href="query-builder.js.html#sunlight-1-line-561">line 561</a>
</li>
</ul>
</dd>
@ -5181,7 +5181,7 @@ prefixed with 'OR NOT'</p>
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-621">line 621</a>
<a href="query-builder.js.html#sunlight-1-line-620">line 620</a>
</li>
</ul>
</dd>
@ -5320,7 +5320,7 @@ prefixed with 'OR NOT'</p>
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-382">line 382</a>
<a href="query-builder.js.html#sunlight-1-line-381">line 381</a>
</li>
</ul>
</dd>
@ -5502,7 +5502,7 @@ prefixed with 'OR NOT'</p>
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-633">line 633</a>
<a href="query-builder.js.html#sunlight-1-line-632">line 632</a>
</li>
</ul>
</dd>
@ -5712,7 +5712,7 @@ prefixed with 'OR NOT'</p>
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-861">line 861</a>
<a href="query-builder.js.html#sunlight-1-line-860">line 860</a>
</li>
</ul>
</dd>
@ -5897,7 +5897,7 @@ prefixed with 'OR NOT'</p>
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-517">line 517</a>
<a href="query-builder.js.html#sunlight-1-line-516">line 516</a>
</li>
</ul>
</dd>
@ -6056,7 +6056,7 @@ prefixed with 'OR NOT'</p>
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-585">line 585</a>
<a href="query-builder.js.html#sunlight-1-line-584">line 584</a>
</li>
</ul>
</dd>
@ -6192,7 +6192,7 @@ prefixed with 'OR NOT'</p>
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-551">line 551</a>
<a href="query-builder.js.html#sunlight-1-line-550">line 550</a>
</li>
</ul>
</dd>
@ -6328,7 +6328,7 @@ prefixed with 'OR NOT'</p>
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-540">line 540</a>
<a href="query-builder.js.html#sunlight-1-line-539">line 539</a>
</li>
</ul>
</dd>
@ -6487,7 +6487,7 @@ prefixed with 'OR NOT'</p>
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-609">line 609</a>
<a href="query-builder.js.html#sunlight-1-line-608">line 608</a>
</li>
</ul>
</dd>
@ -6551,7 +6551,7 @@ prefixed with 'OR NOT'</p>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
on Tue Nov 18th 2014 using the <a
on Mon Dec 1st 2014 using the <a
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>

View File

@ -466,7 +466,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
on Tue Nov 18th 2014 using the <a
on Mon Dec 1st 2014 using the <a
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>

View File

@ -158,7 +158,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
on Tue Nov 18th 2014 using the <a
on Mon Dec 1st 2014 using the <a
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>

View File

@ -86,10 +86,12 @@ var NodeQuery = function() {
* @alias module:node-query
* @param {String} drivername - The name of the database type, eg. mysql or pg
* @param {Object} connObject - A connection object from the database library you are connecting with
* @param {String} connLib - The name of the db connection library you are using, eg. mysql or mysql2
* @param {String} [connLib] - The name of the db connection library you are using, eg. mysql or mysql2. Optional if the same as drivername
* @return {queryBuilder}
*/
this.init = function (driverType, connObject, connLib) {
connLib = connLib || driverType;
var fs = require('fs'),
qb = require('./query-builder');
@ -149,7 +151,7 @@ module.exports = new NodeQuery();</pre>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
on Tue Nov 18th 2014 using the <a
on Mon Dec 1st 2014 using the <a
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>

View File

@ -305,7 +305,6 @@ var QueryBuilder = function(driver, adapter) {
});
},
whereNull: function(field, stmt, conj) {
conj = conj || 'AND';
field = driver.quoteIdentifiers(field);
var item = field + ' ' + stmt;
@ -1042,7 +1041,7 @@ module.exports = QueryBuilder;</pre>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
on Tue Nov 18th 2014 using the <a
on Mon Dec 1st 2014 using the <a
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>

View File

@ -184,7 +184,7 @@ module.exports = QueryParser;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
on Tue Nov 18th 2014 using the <a
on Mon Dec 1st 2014 using the <a
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>