timw4mail/node-query
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
83af1d3946
node-query/docs/module-query-builder.html

5696 lines
74 KiB
HTML
Raw Normal View History

A bunch of random progress
2014-10-20 16:56:45 -04:00
<!DOCTYPE html>
First basic working state
2014-10-23 10:53:16 -04:00
A bunch of random progress
2014-10-20 16:56:45 -04:00
<html lang="en">
<head>
First basic working state
2014-10-23 10:53:16 -04:00
<meta charset="utf-8">
<title>DocStrap Module: query-builder</title>
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
<link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
</head>
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<a class="brand" href="index.html">DocStrap</a>
<ul class="nav">
<li class="dropdown">
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b
class="caret"></b></a>
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
<ul class="dropdown-menu ">
<li>
<a href="module-adapter.html">adapter</a>
</li>
<li>
<a href="module-driver.html">driver</a>
</li>
<li>
<a href="module-helpers.html">helpers</a>
</li>
<li>
<a href="module-node-query.html">node-query</a>
</li>
<li>
<a href="module-query-builder.html">query-builder</a>
</li>
Update docs
2014-10-27 10:35:44 -04:00
<li>
<a href="module-query-parser.html">query-parser</a>
</li>
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
</ul>
</li>
</ul>
</div>
</div>
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
<div class="row-fluid">
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
<div class="span8">
<div id="main">
<h1 class="page-title">Module: query-builder</h1>
<section>
<header>
<h2>
query-builder
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
<a href="query-builder.js.html#sunlight-1-line-3">line 3</a>
</li>
</ul>
</dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt class="name" id="state">
<h4><span class="type-signature">&lt;private, inner> </span>state<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Variables controlling the sql building</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Fix quoting identifiers with comma-seperated values
2014-10-23 15:49:17 -04:00
<a href="query-builder.js.html#sunlight-1-line-12">line 12</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="from"><span class="type-signature"></span>from<span class="signature">(tableName)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Specify the database table to select from</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>tableName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The table to use for the current query</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-396">line 396</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(<span class="optional">table</span>, <span class="optional">limit</span>, <span class="optional">offset</span>, callback)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Get the results of the compiled query</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>table</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The table to select from</p></td>
</tr>
<tr>
<td class="name"><code>limit</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>A limit for the query</p></td>
</tr>
<tr>
<td class="name"><code>offset</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>An offset for the query</p></td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>A callback for receiving the result</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-738">line 738</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>void</p>
</div>
</dd>
<dt>
<h4 class="name" id="getCompiledDelete"><span class="type-signature"></span>getCompiledDelete<span class="signature">(table, <span class="optional">reset</span>)</span><span class="type-signature"> &rarr; {String}</span></h4>
</dt>
<dd>
<div class="description">
<p>Return generated delete query SQL</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>table</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>the name of the table to delete from</p></td>
</tr>
<tr>
<td class="name"><code>reset</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Whether to reset the query builder so another query can be built</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-849">line 849</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getCompiledInsert"><span class="type-signature"></span>getCompiledInsert<span class="signature">(table, <span class="optional">reset</span>)</span><span class="type-signature"> &rarr; {String}</span></h4>
</dt>
<dd>
<div class="description">
<p>Return generated insert query SQL</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>table</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>the name of the table to insert into</p></td>
</tr>
<tr>
<td class="name"><code>reset</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Whether to reset the query builder so another query can be built</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-827">line 827</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getCompiledSelect"><span class="type-signature"></span>getCompiledSelect<span class="signature">(<span class="optional">table</span>, <span class="optional">reset</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Return generated select query SQL</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>table</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>the name of the table to retrieve from</p></td>
</tr>
<tr>
<td class="name"><code>reset</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Whether to reset the query builder so another query can be built</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-811">line 811</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>String</p>
</div>
</dd>
<dt>
<h4 class="name" id="getCompiledUpdate"><span class="type-signature"></span>getCompiledUpdate<span class="signature">(table, <span class="optional">reset</span>)</span><span class="type-signature"> &rarr; {String}</span></h4>
</dt>
<dd>
<div class="description">
<p>Return generated update query SQL</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>table</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>the name of the table to update</p></td>
</tr>
<tr>
<td class="name"><code>reset</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Whether to reset the query builder so another query can be built</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-838">line 838</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getState"><span class="type-signature">&lt;private> </span>getState<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the current class state for testing or other purposes</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-343">line 343</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="groupBy"><span class="type-signature"></span>groupBy<span class="signature">(field)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Group the results by the selected field(s)</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Array</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-620">line 620</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="groupEnd"><span class="type-signature"></span>groupEnd<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Ends a logical grouping started with one of the groupStart methods</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-719">line 719</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="groupStart"><span class="type-signature"></span>groupStart<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Adds an open paren to the current query for logical grouping</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-683">line 683</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="having"><span class="type-signature"></span>having<span class="signature">(key, <span class="optional">val</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Add a 'having' clause</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Object</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The name of the field and the comparision operator, or an object</p></td>
</tr>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The value to compare if the value of key is a string</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-469">line 469</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="insert"><span class="type-signature"></span>insert<span class="signature">(table, <span class="optional">data</span>, callback)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Run the generated insert query</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>table</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The table to insert into</p></td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>Data to insert, if not already added with the 'set' method</p></td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>Callback for handling response from the database</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-761">line 761</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>void</p>
</div>
</dd>
<dt>
Update docs
2014-10-27 10:35:44 -04:00
<h4 class="name" id="join"><span class="type-signature"></span>join<span class="signature">(table, cond, <span class="optional">type</span>)</span><span class="type-signature"></span></h4>
First basic working state
2014-10-23 10:53:16 -04:00
</dt>
<dd>
<div class="description">
<p>Add a join clause to the query</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Update docs
2014-10-27 10:35:44 -04:00
<td class="name"><code>table</code></td>
First basic working state
2014-10-23 10:53:16 -04:00
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The table you are joining</p></td>
</tr>
<tr>
<td class="name"><code>cond</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
Update docs
2014-10-27 10:35:44 -04:00
<td class="description last"><p>The join condition.</p></td>
First basic working state
2014-10-23 10:53:16 -04:00
</tr>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'inner'
</td>
<td class="description last"><p>The type of join, which defaults to inner</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-595">line 595</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="like"><span class="type-signature"></span>like<span class="signature">(field, val, <span class="optional">pos</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Add a 'like/ and like' clause to the query</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The name of the field to compare to</p></td>
</tr>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The value to compare to</p></td>
</tr>
<tr>
<td class="name"><code>pos</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
both
</td>
<td class="description last"><p>The placement of the wildcard character(s): before, after, or both</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-418">line 418</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="limit"><span class="type-signature"></span>limit<span class="signature">(limit, <span class="optional">offset</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Put a limit on the query</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>limit</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The maximum number of rows to fetch</p></td>
</tr>
<tr>
<td class="name"><code>offset</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The row number to start from</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-671">line 671</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="notLike"><span class="type-signature"></span>notLike<span class="signature">(field, val, <span class="optional">pos</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Add a 'not like/ and not like' clause to the query</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The name of the field to compare to</p></td>
</tr>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The value to compare to</p></td>
</tr>
<tr>
<td class="name"><code>pos</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
both
</td>
<td class="description last"><p>The placement of the wildcard character(s): before, after, or both</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-431">line 431</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="orderBy"><span class="type-signature"></span>orderBy<span class="signature">(field, <span class="optional">type</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Order the results by the selected field(s)</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
Fix quoting identifiers with comma-seperated values
2014-10-23 15:49:17 -04:00
<td class="description last"><p>The field(s) to order by</p></td>
First basic working state
2014-10-23 10:53:16 -04:00
</tr>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'ASC'
</td>
<td class="description last"><p>The order direction, ASC or DESC</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-643">line 643</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="orGroupStart"><span class="type-signature"></span>orGroupStart<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Adds an open paren to the current query for logical grouping,
prefixed with 'OR'</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-696">line 696</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="orHaving"><span class="type-signature"></span>orHaving<span class="signature">(key, <span class="optional">val</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Add an 'or having' clause</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Object</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The name of the field and the comparision operator, or an object</p></td>
</tr>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The value to compare if the value of key is a string</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-483">line 483</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="orLike"><span class="type-signature"></span>orLike<span class="signature">(field, val, <span class="optional">pos</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Add an 'or like' clause to the query</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The name of the field to compare to</p></td>
</tr>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The value to compare to</p></td>
</tr>
<tr>
<td class="name"><code>pos</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
both
</td>
<td class="description last"><p>The placement of the wildcard character(s): before, after, or both</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-444">line 444</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="orNotGroupStart"><span class="type-signature"></span>orNotGroupStart<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Adds an open paren to the current query for logical grouping,
prefixed with 'OR NOT'</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-708">line 708</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="orNotLike"><span class="type-signature"></span>orNotLike<span class="signature">(field, val, <span class="optional">pos</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Add an 'or not like' clause to the query</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The name of the field to compare to</p></td>
</tr>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The value to compare to</p></td>
</tr>
<tr>
<td class="name"><code>pos</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
both
</td>
<td class="description last"><p>The placement of the wildcard character(s): before, after, or both</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-457">line 457</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="orWhere"><span class="type-signature"></span>orWhere<span class="signature">(key, <span class="optional">val</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Set a 'or where' clause</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Object</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The name of the field and the comparision operator, or an object</p></td>
</tr>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The value to compare if the value of key is a string</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-509">line 509</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="orWhereIn"><span class="type-signature"></span>orWhereIn<span class="signature">(key, val)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Set a 'or where in' clause</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>the field to search</p></td>
</tr>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last"><p>the array of items to search in</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-533">line 533</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="orWhereNotIn"><span class="type-signature"></span>orWhereNotIn<span class="signature">(key, val)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Set a 'or where not in' clause</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>the field to search</p></td>
</tr>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last"><p>the array of items to search in</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-557">line 557</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="select"><span class="type-signature"></span>select<span class="signature">(fields)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Specify rows to select in the query</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fields</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Array</span>
</td>
<td class="description last"><p>The fields to select from the current table</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-362">line 362</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="set"><span class="type-signature"></span>set<span class="signature">(key, <span class="optional">val</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Set values for insertion or updating</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Object</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The key or object to use</p></td>
</tr>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The value if using a scalar key</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-569">line 569</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">(table, <span class="optional">data</span>, callback)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Run the generated update query</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>table</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The table to insert into</p></td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>Data to insert, if not already added with the 'set' method</p></td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>Callback for handling response from the database</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-779">line 779</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>void</p>
</div>
</dd>
<dt>
<h4 class="name" id="where"><span class="type-signature"></span>where<span class="signature">(key, <span class="optional">val</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Set a 'where' clause</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Object</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The name of the field and the comparision operator, or an object</p></td>
</tr>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The value to compare if the value of key is a string</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-497">line 497</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="whereIn"><span class="type-signature"></span>whereIn<span class="signature">(key, val)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Set a 'where in' clause</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>the field to search</p></td>
</tr>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last"><p>the array of items to search in</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-521">line 521</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
<dt>
<h4 class="name" id="whereNotIn"><span class="type-signature"></span>whereNotIn<span class="signature">(key, val)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Set a 'where not in' clause</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>the field to search</p></td>
</tr>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last"><p>the array of items to search in</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="query-builder.js.html">query-builder.js</a>,
Update docs
2014-10-27 10:35:44 -04:00
<a href="query-builder.js.html#sunlight-1-line-545">line 545</a>
First basic working state
2014-10-23 10:53:16 -04:00
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>this</p>
</div>
</dd>
</dl>
</article>
</section>
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
</div>
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
<div class="clearfix"></div>
<footer>
<span class="copyright">
DocStrap Copyright © 2012-2014 The contributors to the JSDoc3 and DocStrap projects.
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
Update docs
2014-10-27 10:35:44 -04:00
on Mon Oct 27th 2014 using the <a
First basic working state
2014-10-23 10:53:16 -04:00
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
</div>
<!--<script src="scripts/sunlight.js"></script>-->
<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
<script>
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : "100px"
} );
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();
// $( ".tutorial-section pre, .readme-section pre" ).addClass( "sunlight-highlight-javascript" ).addClass( "linenums" );
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
$( ".tutorial-section pre, .readme-section pre" ).each( function () {
var $this = $( this );
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
var example = $this.find( "code" );
exampleText = example.html();
var lang = /{@lang (.*?)}/.exec( exampleText );
if ( lang && lang[1] ) {
exampleText = exampleText.replace( lang[0], "" );
example.html( exampleText );
lang = lang[1];
} else {
lang = "javascript";
}
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
if ( lang ) {
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
}
} );
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
Sunlight.highlightAll( {
lineNumbers : true,
showMenu : true,
enableDoclinks : true
} );
} );
</script>
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
<!--Navigation and Symbol Display-->
A bunch of random progress
2014-10-20 16:56:45 -04:00
First basic working state
2014-10-23 10:53:16 -04:00
<!--Google Analytics-->
A bunch of random progress
2014-10-20 16:56:45 -04:00
</body>
</html>
Reference in New Issue Copy Permalink