Skip to content
This repository has been archived by the owner on Mar 4, 2019. It is now read-only.

Commit

Permalink
update api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@dmfay
dmfay committed May 31, 2017
1 parent b3019d6 commit 3883551
Show file tree
Hide file tree
Showing 25 changed files with 1,963 additions and 1,341 deletions.
4 changes: 2 additions & 2 deletions docs/api/Entity.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -291,13 +291,13 @@ <h6>Properties</h6>
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-massive.html">massive</a></li><li><a href="module-where.html">where</a></li></ul><h3>Classes</h3><ul><li><a href="Entity.html">Entity</a></li><li><a href="Executable.html">Executable</a></li><li><a href="Massive.html">Massive</a></li><li><a href="Query.html">Query</a></li><li><a href="Queryable.html">Queryable</a></li><li><a href="SingleValueStream.html">SingleValueStream</a></li><li><a href="Table.html">Table</a></li></ul><h3>Global</h3><ul><li><a href="global.html"></a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-massive.html">massive</a></li><li><a href="module-mutators.html">mutators</a></li><li><a href="module-operations.html">operations</a></li><li><a href="module-where.html">where</a></li></ul><h3>Classes</h3><ul><li><a href="Entity.html">Entity</a></li><li><a href="Executable.html">Executable</a></li><li><a href="Massive.html">Massive</a></li><li><a href="Query.html">Query</a></li><li><a href="Queryable.html">Queryable</a></li><li><a href="SingleValueStream.html">SingleValueStream</a></li><li><a href="Table.html">Table</a></li></ul><h3>Global</h3><ul><li><a href="global.html"></a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri May 26 2017 00:22:22 GMT-0400 (EDT)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue May 30 2017 22:31:06 GMT-0400 (EDT)
</footer>

<script> prettyPrint(); </script>
Expand Down
4 changes: 2 additions & 2 deletions docs/api/Executable.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -536,13 +536,13 @@ <h5>Returns:</h5>
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-massive.html">massive</a></li><li><a href="module-where.html">where</a></li></ul><h3>Classes</h3><ul><li><a href="Entity.html">Entity</a></li><li><a href="Executable.html">Executable</a></li><li><a href="Massive.html">Massive</a></li><li><a href="Query.html">Query</a></li><li><a href="Queryable.html">Queryable</a></li><li><a href="SingleValueStream.html">SingleValueStream</a></li><li><a href="Table.html">Table</a></li></ul><h3>Global</h3><ul><li><a href="global.html"></a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-massive.html">massive</a></li><li><a href="module-mutators.html">mutators</a></li><li><a href="module-operations.html">operations</a></li><li><a href="module-where.html">where</a></li></ul><h3>Classes</h3><ul><li><a href="Entity.html">Entity</a></li><li><a href="Executable.html">Executable</a></li><li><a href="Massive.html">Massive</a></li><li><a href="Query.html">Query</a></li><li><a href="Queryable.html">Queryable</a></li><li><a href="SingleValueStream.html">SingleValueStream</a></li><li><a href="Table.html">Table</a></li></ul><h3>Global</h3><ul><li><a href="global.html"></a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri May 26 2017 00:22:22 GMT-0400 (EDT)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue May 30 2017 22:31:06 GMT-0400 (EDT)
</footer>

<script> prettyPrint(); </script>
Expand Down
18 changes: 9 additions & 9 deletions docs/api/Massive.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -473,7 +473,7 @@ <h6>Properties</h6>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_database.js.html">lib/database.js</a>, <a href="lib_database.js.html#line35">line 35</a>
<a href="lib_database.js.html">lib/database.js</a>, <a href="lib_database.js.html#line33">line 33</a>
</li></ul></dd>


Expand Down Expand Up @@ -655,7 +655,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_database.js.html">lib/database.js</a>, <a href="lib_database.js.html#line56">line 56</a>
<a href="lib_database.js.html">lib/database.js</a>, <a href="lib_database.js.html#line54">line 54</a>
</li></ul></dd>


Expand Down Expand Up @@ -809,7 +809,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_database.js.html">lib/database.js</a>, <a href="lib_database.js.html#line216">line 216</a>
<a href="lib_database.js.html">lib/database.js</a>, <a href="lib_database.js.html#line212">line 212</a>
</li></ul></dd>


Expand Down Expand Up @@ -1137,7 +1137,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_database.js.html">lib/database.js</a>, <a href="lib_database.js.html#line92">line 92</a>
<a href="lib_database.js.html">lib/database.js</a>, <a href="lib_database.js.html#line90">line 90</a>
</li></ul></dd>


Expand Down Expand Up @@ -2063,7 +2063,7 @@ <h6>Properties</h6>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_database.js.html">lib/database.js</a>, <a href="lib_database.js.html#line145">line 145</a>
<a href="lib_database.js.html">lib/database.js</a>, <a href="lib_database.js.html#line143">line 143</a>
</li></ul></dd>


Expand Down Expand Up @@ -2167,7 +2167,7 @@ <h4 class="name" id="reload"><span class="type-signature"></span>reload<span cla

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_database.js.html">lib/database.js</a>, <a href="lib_database.js.html#line117">line 117</a>
<a href="lib_database.js.html">lib/database.js</a>, <a href="lib_database.js.html#line115">line 115</a>
</li></ul></dd>


Expand Down Expand Up @@ -2322,7 +2322,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_database.js.html">lib/database.js</a>, <a href="lib_database.js.html#line196">line 196</a>
<a href="lib_database.js.html">lib/database.js</a>, <a href="lib_database.js.html#line194">line 194</a>
</li></ul></dd>


Expand Down Expand Up @@ -2364,13 +2364,13 @@ <h5>Parameters:</h5>
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-massive.html">massive</a></li><li><a href="module-where.html">where</a></li></ul><h3>Classes</h3><ul><li><a href="Entity.html">Entity</a></li><li><a href="Executable.html">Executable</a></li><li><a href="Massive.html">Massive</a></li><li><a href="Query.html">Query</a></li><li><a href="Queryable.html">Queryable</a></li><li><a href="SingleValueStream.html">SingleValueStream</a></li><li><a href="Table.html">Table</a></li></ul><h3>Global</h3><ul><li><a href="global.html"></a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-massive.html">massive</a></li><li><a href="module-mutators.html">mutators</a></li><li><a href="module-operations.html">operations</a></li><li><a href="module-where.html">where</a></li></ul><h3>Classes</h3><ul><li><a href="Entity.html">Entity</a></li><li><a href="Executable.html">Executable</a></li><li><a href="Massive.html">Massive</a></li><li><a href="Query.html">Query</a></li><li><a href="Queryable.html">Queryable</a></li><li><a href="SingleValueStream.html">SingleValueStream</a></li><li><a href="Table.html">Table</a></li></ul><h3>Global</h3><ul><li><a href="global.html"></a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri May 26 2017 00:22:22 GMT-0400 (EDT)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue May 30 2017 22:31:06 GMT-0400 (EDT)
</footer>

<script> prettyPrint(); </script>
Expand Down
8 changes: 4 additions & 4 deletions docs/api/Query.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -556,7 +556,7 @@ <h4 class="name" id="format"><span class="type-signature"></span>format<span cla

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_query_query.js.html">lib/query/query.js</a>, <a href="lib_query_query.js.html#line85">line 85</a>
<a href="lib_query_query.js.html">lib/query/query.js</a>, <a href="lib_query_query.js.html#line83">line 83</a>
</li></ul></dd>


Expand Down Expand Up @@ -638,7 +638,7 @@ <h4 class="name" id="selectList"><span class="type-signature"></span>selectList<

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_query_query.js.html">lib/query/query.js</a>, <a href="lib_query_query.js.html#line94">line 94</a>
<a href="lib_query_query.js.html">lib/query/query.js</a>, <a href="lib_query_query.js.html#line92">line 92</a>
</li></ul></dd>


Expand Down Expand Up @@ -680,13 +680,13 @@ <h4 class="name" id="selectList"><span class="type-signature"></span>selectList<
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-massive.html">massive</a></li><li><a href="module-where.html">where</a></li></ul><h3>Classes</h3><ul><li><a href="Entity.html">Entity</a></li><li><a href="Executable.html">Executable</a></li><li><a href="Massive.html">Massive</a></li><li><a href="Query.html">Query</a></li><li><a href="Queryable.html">Queryable</a></li><li><a href="SingleValueStream.html">SingleValueStream</a></li><li><a href="Table.html">Table</a></li></ul><h3>Global</h3><ul><li><a href="global.html"></a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-massive.html">massive</a></li><li><a href="module-mutators.html">mutators</a></li><li><a href="module-operations.html">operations</a></li><li><a href="module-where.html">where</a></li></ul><h3>Classes</h3><ul><li><a href="Entity.html">Entity</a></li><li><a href="Executable.html">Executable</a></li><li><a href="Massive.html">Massive</a></li><li><a href="Query.html">Query</a></li><li><a href="Queryable.html">Queryable</a></li><li><a href="SingleValueStream.html">SingleValueStream</a></li><li><a href="Table.html">Table</a></li></ul><h3>Global</h3><ul><li><a href="global.html"></a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri May 26 2017 00:22:22 GMT-0400 (EDT)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue May 30 2017 22:31:06 GMT-0400 (EDT)
</footer>

<script> prettyPrint(); </script>
Expand Down
170 changes: 162 additions & 8 deletions docs/api/Queryable.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -467,6 +467,160 @@ <h5>Returns:</h5>



<h4 class="name" id="countDoc"><span class="type-signature"></span>countDoc<span class="signature">(conditions)</span><span class="type-signature"> &rarr; {Promise}</span></h4>





<div class="description">
Count documents matching criteria. Unlike count, this function only supports
criteria objects.
</div>









<h5>Parameters:</h5>


<table class="params">
<thead>
<tr>

<th>Name</th>


<th>Type</th>





<th class="last">Description</th>
</tr>
</thead>

<tbody>


<tr>

<td class="name"><code>conditions</code></td>


<td class="type">


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



</td>





<td class="description last">A criteria object.</td>
</tr>


</tbody>
</table>






<dl class="details">


























<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_queryable.js.html">lib/queryable.js</a>, <a href="lib_queryable.js.html#line70">line 70</a>
</li></ul></dd>







</dl>













<h5>Returns:</h5>


<div class="param-desc">
Number of matching documents.
</div>



<dl>
<dt>
Type
</dt>
<dd>

<span class="param-type">Promise</span>


</dd>
</dl>










<h4 class="name" id="find"><span class="type-signature"></span>find<span class="signature">(conditions<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>


Expand Down Expand Up @@ -616,7 +770,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_queryable.js.html">lib/queryable.js</a>, <a href="lib_queryable.js.html#line71">line 71</a>
<a href="lib_queryable.js.html">lib/queryable.js</a>, <a href="lib_queryable.js.html#line84">line 84</a>
</li></ul></dd>


Expand Down Expand Up @@ -818,7 +972,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_queryable.js.html">lib/queryable.js</a>, <a href="lib_queryable.js.html#line85">line 85</a>
<a href="lib_queryable.js.html">lib/queryable.js</a>, <a href="lib_queryable.js.html#line98">line 98</a>
</li></ul></dd>


Expand Down Expand Up @@ -1014,7 +1168,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_queryable.js.html">lib/queryable.js</a>, <a href="lib_queryable.js.html#line99">line 99</a>
<a href="lib_queryable.js.html">lib/queryable.js</a>, <a href="lib_queryable.js.html#line113">line 113</a>
</li></ul></dd>


Expand Down Expand Up @@ -1264,7 +1418,7 @@ <h6>Properties</h6>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_queryable.js.html">lib/queryable.js</a>, <a href="lib_queryable.js.html#line117">line 117</a>
<a href="lib_queryable.js.html">lib/queryable.js</a>, <a href="lib_queryable.js.html#line131">line 131</a>
</li></ul></dd>


Expand Down Expand Up @@ -1490,7 +1644,7 @@ <h6>Properties</h6>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_queryable.js.html">lib/queryable.js</a>, <a href="lib_queryable.js.html#line165">line 165</a>
<a href="lib_queryable.js.html">lib/queryable.js</a>, <a href="lib_queryable.js.html#line179">line 179</a>
</li></ul></dd>


Expand Down Expand Up @@ -1646,7 +1800,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_queryable.js.html">lib/queryable.js</a>, <a href="lib_queryable.js.html#line180">line 180</a>
<a href="lib_queryable.js.html">lib/queryable.js</a>, <a href="lib_queryable.js.html#line194">line 194</a>
</li></ul></dd>


Expand Down Expand Up @@ -1710,13 +1864,13 @@ <h5>Returns:</h5>
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-massive.html">massive</a></li><li><a href="module-where.html">where</a></li></ul><h3>Classes</h3><ul><li><a href="Entity.html">Entity</a></li><li><a href="Executable.html">Executable</a></li><li><a href="Massive.html">Massive</a></li><li><a href="Query.html">Query</a></li><li><a href="Queryable.html">Queryable</a></li><li><a href="SingleValueStream.html">SingleValueStream</a></li><li><a href="Table.html">Table</a></li></ul><h3>Global</h3><ul><li><a href="global.html"></a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-massive.html">massive</a></li><li><a href="module-mutators.html">mutators</a></li><li><a href="module-operations.html">operations</a></li><li><a href="module-where.html">where</a></li></ul><h3>Classes</h3><ul><li><a href="Entity.html">Entity</a></li><li><a href="Executable.html">Executable</a></li><li><a href="Massive.html">Massive</a></li><li><a href="Query.html">Query</a></li><li><a href="Queryable.html">Queryable</a></li><li><a href="SingleValueStream.html">SingleValueStream</a></li><li><a href="Table.html">Table</a></li></ul><h3>Global</h3><ul><li><a href="global.html"></a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri May 26 2017 00:22:22 GMT-0400 (EDT)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue May 30 2017 22:31:06 GMT-0400 (EDT)
</footer>

<script> prettyPrint(); </script>
Expand Down
4 changes: 2 additions & 2 deletions docs/api/SingleValueStream.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -197,13 +197,13 @@ <h5>Parameters:</h5>
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-massive.html">massive</a></li><li><a href="module-where.html">where</a></li></ul><h3>Classes</h3><ul><li><a href="Entity.html">Entity</a></li><li><a href="Executable.html">Executable</a></li><li><a href="Massive.html">Massive</a></li><li><a href="Query.html">Query</a></li><li><a href="Queryable.html">Queryable</a></li><li><a href="SingleValueStream.html">SingleValueStream</a></li><li><a href="Table.html">Table</a></li></ul><h3>Global</h3><ul><li><a href="global.html"></a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-massive.html">massive</a></li><li><a href="module-mutators.html">mutators</a></li><li><a href="module-operations.html">operations</a></li><li><a href="module-where.html">where</a></li></ul><h3>Classes</h3><ul><li><a href="Entity.html">Entity</a></li><li><a href="Executable.html">Executable</a></li><li><a href="Massive.html">Massive</a></li><li><a href="Query.html">Query</a></li><li><a href="Queryable.html">Queryable</a></li><li><a href="SingleValueStream.html">SingleValueStream</a></li><li><a href="Table.html">Table</a></li></ul><h3>Global</h3><ul><li><a href="global.html"></a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri May 26 2017 00:22:22 GMT-0400 (EDT)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue May 30 2017 22:31:06 GMT-0400 (EDT)
</footer>

<script> prettyPrint(); </script>
Expand Down
Loading

0 comments on commit 3883551

Please sign in to comment.