ink-docstrap
Version:
[](https://nodei.co/npm/ink-docstrap/)
3,054 lines • 42.8 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>DocStrap Module: documents/probe</title>
<!--[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">
<link type="text/css" rel="stylesheet" href="styles/site.amelia.css">
</head>
<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>
<ul class="dropdown-menu ">
<li>
<a href="module-base.html">base</a>
</li>
<li>
<a href="chains_.html">base/chains</a>
</li>
<li>
<a href="binder.html">documents/binder</a>
</li>
<li>
<a href="model_.html">documents/model</a>
</li>
<li>
<a href="probe.html">documents/probe</a>
</li>
<li>
<a href="schema_.html">documents/schema</a>
</li>
<li>
<a href="collector.html">ink/collector</a>
</li>
<li>
<a href="bussable_.html">mixins/bussable</a>
</li>
<li>
<a href="signalable_.html">mixins/signalable</a>
</li>
<li>
<a href="format.html">strings/format</a>
</li>
<li>
<a href="logger.html">utils/logger</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="base.html">base</a>
</li>
<li>
<a href="chains.html">base/chains</a>
</li>
<li>
<a href="model.html">documents/model</a>
</li>
<li>
<a href="probe.queryOperators.html">queryOperators</a>
</li>
<li>
<a href="probe.updateOperators.html">updateOperators</a>
</li>
<li>
<a href="collector-ACollector.html">ACollector</a>
</li>
<li>
<a href="collector-CollectorBase_.html">CollectorBase</a>
</li>
<li>
<a href="collector-OCollector.html">OCollector</a>
</li>
<li>
<a href="signalable-Signal.html">Signal</a>
</li>
<li>
<a href="logger.Logger.html">Logger</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="mixins.list.html" class="dropdown-toggle" data-toggle="dropdown">Mixins<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="schema.html">documents/schema</a>
</li>
<li>
<a href="bussable.html">mixins/bussable</a>
</li>
<li>
<a href="signalable.html">mixins/signalable</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="tutorials.list.html" class="dropdown-toggle" data-toggle="dropdown">Tutorials<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="tutorial-Teeth.html">Brush Teeth</a>
</li>
<li>
<a href="tutorial-Car.html">Drive Car</a>
</li>
<li>
<a href="tutorial-Test.html">Fence Test</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="global.html#utils/logger">utils/logger</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<h1 class="page-title">Module: documents/probe</h1>
<section>
<header>
<h2>
documents/probe
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Queries objects in memory using a mongo-like notation for reaching into objects and filtering for records</p></div>
<dl class="details">
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li>Terry Weiss</li>
</ul>
</dd>
<dt class="tag-license">License:</dt>
<dd class="tag-license">
<ul class="dummy">
<li>MIT</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="probe.js.html">documents/probe.js</a>,
<a href="probe.js.html#sunlight-1-line-2">line 2</a>
</li>
</ul>
</dd>
</dl>
</div>
<h3 class="subsection-title">Requires</h3>
<ul>
<li>module:lodash</li>
</ul>
<h3 class="subsection-title">Classes</h3>
<dl>
<dt><a href="probe.queryOperators.html">queryOperators</a></dt>
<dd></dd>
<dt><a href="probe.updateOperators.html">updateOperators</a></dt>
<dd></dd>
</dl>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="delimiter"><span class="type-signature"><static> </span>delimiter<span class="type-signature"> :string</span></h4>
</dt>
<dd>
<div class="description">
<p>The delimiter to use when splitting an expression</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>'.'</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="probe.js.html">documents/probe.js</a>,
<a href="probe.js.html#sunlight-1-line-154">line 154</a>
</li>
</ul>
</dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="all"><span class="type-signature"><static> </span>all<span class="signature">(obj, qu)</span><span class="type-signature"> → {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns true if all items match 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>obj</code></td>
<td class="type">
<span class="param-type">array</span>
|
<span class="param-type">object</span>
</td>
<td class="description last"><p>The object to query</p></td>
</tr>
<tr>
<td class="name"><code>qu</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The query to execute. See <a href="probe.queryOperators.html">module:documents/probe.queryOperators</a> for the operators you can use.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="probe.js.html">documents/probe.js</a>,
<a href="probe.js.html#sunlight-1-line-871">line 871</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="any"><span class="type-signature"><static> </span>any<span class="signature">(obj, qu)</span><span class="type-signature"> → {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns true if any of the items match 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>obj</code></td>
<td class="type">
<span class="param-type">array</span>
|
<span class="param-type">object</span>
</td>
<td class="description last"><p>The object to query</p></td>
</tr>
<tr>
<td class="name"><code>qu</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The query to execute. See <a href="probe.queryOperators.html">module:documents/probe.queryOperators</a> for the operators you can use.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="probe.js.html">documents/probe.js</a>,
<a href="probe.js.html#sunlight-1-line-882">line 882</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="every"><span class="type-signature"><static> </span>every<span class="signature">(obj, qu)</span><span class="type-signature"> → {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns true if all items match the query. Aliases as <code>all</code></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>obj</code></td>
<td class="type">
<span class="param-type">array</span>
|
<span class="param-type">object</span>
</td>
<td class="description last"><p>The object to query</p></td>
</tr>
<tr>
<td class="name"><code>qu</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The query to execute</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="probe.js.html">documents/probe.js</a>,
<a href="probe.js.html#sunlight-1-line-950">line 950</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="find"><span class="type-signature"><static> </span>find<span class="signature">(obj, qu)</span><span class="type-signature"> → {array}</span></h4>
</dt>
<dd>
<div class="description">
<p>Find all records that match a 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>obj</code></td>
<td class="type">
<span class="param-type">array</span>
|
<span class="param-type">object</span>
</td>
<td class="description last"><p>The object to query</p></td>
</tr>
<tr>
<td class="name"><code>qu</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The query to execute. See <a href="probe.queryOperators.html">module:documents/probe.queryOperators</a> for the operators you can use.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="probe.js.html">documents/probe.js</a>,
<a href="probe.js.html#sunlight-1-line-750">line 750</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The results</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">array</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="findKeys"><span class="type-signature"><static> </span>findKeys<span class="signature">(obj, qu)</span><span class="type-signature"> → {array}</span></h4>
</dt>
<dd>
<div class="description">
<p>Find all records that match a query and returns the keys for those items. This is similar to <a href="probe.html#find">module:documents/probe.find</a> but instead of returning
records, returns the keys. If <code>obj</code> is an object it will return the hash key. If 'obj' is an array, it will return the index</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>obj</code></td>
<td class="type">
<span class="param-type">array</span>
|
<span class="param-type">object</span>
</td>
<td class="description last"><p>The object to query</p></td>
</tr>
<tr>
<td class="name"><code>qu</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The query to execute. See <a href="probe.queryOperators.html">module:documents/probe.queryOperators</a> for the operators you can use.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="probe.js.html">documents/probe.js</a>,
<a href="probe.js.html#sunlight-1-line-769">line 769</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">array</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="findOne"><span class="type-signature"><static> </span>findOne<span class="signature">(obj, qu)</span><span class="type-signature"> → {object}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the first record that matches the query. Aliased as <code>seek</code>.</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>obj</code></td>
<td class="type">
<span class="param-type">array</span>
|
<span class="param-type">object</span>
</td>
<td class="description last"><p>The object to query</p></td>
</tr>
<tr>
<td class="name"><code>qu</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The query to execute. See <a href="probe.queryOperators.html">module:documents/probe.queryOperators</a> for the operators you can use.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="probe.js.html">documents/probe.js</a>,
<a href="probe.js.html#sunlight-1-line-788">line 788</a>
</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="findOneKey"><span class="type-signature"><static> </span>findOneKey<span class="signature">(obj, qu)</span><span class="type-signature"> → {object}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the first record that matches the query and returns its key or index depending on whether <code>obj</code> is an object or array respectively.
Aliased as <code>seekKey</code>.</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>obj</code></td>
<td class="type">
<span class="param-type">array</span>
|
<span class="param-type">object</span>
</td>
<td class="description last"><p>The object to query</p></td>
</tr>
<tr>
<td class="name"><code>qu</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The query to execute. See <a href="probe.queryOperators.html">module:documents/probe.queryOperators</a> for the operators you can use.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="probe.js.html">documents/probe.js</a>,
<a href="probe.js.html#sunlight-1-line-813">line 813</a>
</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="get"><span class="type-signature"><static> </span>get<span class="signature">(path, record)</span><span class="type-signature"> → {*}</span></h4>
</dt>
<dd>
<div class="description">
<p>Reaches into an object and allows you to get at a value deeply nested in an object. This is not a query, but a
straight reach in, useful for event bindings</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>path</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last"><p>The split path of the element to work with</p></td>
</tr>
<tr>
<td class="name"><code>record</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The record to reach into</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="probe.js.html">documents/probe.js</a>,
<a href="probe.js.html#sunlight-1-line-930">line 930</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Whatever was found in the record</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">*</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="mixin"><span class="type-signature"><static> </span>mixin<span class="signature">(obj, collection)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Binds the query and update methods to a specific object and adds the methods to that object. When called these
methods can skip the first parameter so that find(object, query) can just be called as object.find(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>obj</code></td>
<td class="type">
<span class="param-type">object</span>
|
<span class="param-type">array</span>
</td>
<td class="description last"><p>The object or array to bind to</p></td>
</tr>
<tr>
<td class="name"><code>collection</code></td>
<td class="type">
<span class="param-type">object</span>
|
<span class="param-type">array</span>
</td>
<td class="description last"><p>If the collection is not the same as <code>this</code> but is a property, or even
a whole other object, you specify that here. Otherwise the <code>obj</code> is assumed to be the same as the collecion</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="probe.js.html">documents/probe.js</a>,
<a href="probe.js.html#sunlight-1-line-992">line 992</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="proxy"><span class="type-signature"><static> </span>proxy<span class="signature">(obj)</span><span class="type-signature"> → {object}</span></h4>
</dt>
<dd>
<div class="description">
<p>Binds the query and update methods to a new object. When called these
methods can skip the first parameter so that find(object, query) can just be called as find(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>obj</code></td>
<td class="type">
<span class="param-type">object</span>
|
<span class="param-type">array</span>
</td>
<td class="description last"><p>The object or array to bind to</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="probe.js.html">documents/probe.js</a>,
<a href="probe.js.html#sunlight-1-line-975">line 975</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>An object with method bindings in place</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="remove"><span class="type-signature"><static> </span>remove<span class="signature">(obj, qu)</span><span class="type-signature"> → {object|array}</span></h4>
</dt>
<dd>
<div class="description">
<p>Remove all items in the object/array that match 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>obj</code></td>
<td class="type">
<span class="param-type">array</span>
|
<span class="param-type">object</span>
</td>
<td class="description last"><p>The object to query</p></td>
</tr>
<tr>
<td class="name"><code>qu</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The query to execute. See <a href="probe.queryOperators.html">module:documents/probe.queryOperators</a> for the operators you can use.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="probe.js.html">documents/probe.js</a>,
<a href="probe.js.html#sunlight-1-line-838">line 838</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The array or object as appropriate without the records.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
|
<span class="param-type">array</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="set"><span class="type-signature"><static> </span>set<span class="signature">(path, record, setter, newValue)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>This will write the value into a record at the path, creating intervening objects if they don't exist. This does not work as filtered
update and is meant to be used on a single record. It is a nice way of setting a property at an arbitrary depth at will.</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>path</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last"><p>The split path of the element to work with</p></td>
</tr>
<tr>
<td class="name"><code>record</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The record to reach into</p></td>
</tr>
<tr>
<td class="name"><code>setter</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The set operation. See <a href="probe.updateOperators.html">module:documents/probe.updateOperators</a> for the operators you can use.</p></td>
</tr>
<tr>
<td class="name"><code>newValue</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The value to write to the, or if the operator is $pull, the query of items to look for</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="probe.js.html">documents/probe.js</a>,
<a href="probe.js.html#sunlight-1-line-918">line 918</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="some"><span class="type-signature"><static> </span>some<span class="signature">(obj, qu)</span><span class="type-signature"> → {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns true if any of the items match the query. Aliases as <code>any</code></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>obj</code></td>
<td class="type">
<span class="param-type">array</span>
|
<span class="param-type">object</span>
</td>
<td class="description last"><p>The object to query</p></td>
</tr>
<tr>
<td class="name"><code>qu</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The query to execute</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="probe.js.html">documents/probe.js</a>,
<a href="probe.js.html#sunlight-1-line-941">line 941</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="unique"><span class="type-signature"><static> </span>unique<span class="signature">(obj, qu)</span><span class="type-signature"> → {array}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the set of unique records that match a 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>obj</code></td>
<td class="type">
<span class="param-type">array</span>
|
<span class="param-type">object</span>
</td>
<td class="description last"><p>The object to query</p></td>
</tr>
<tr>
<td class="name"><code>qu</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The query to execute. See <a href="probe.queryOperators.html">module:documents/probe.queryOperators</a> for the operators you can use.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="probe.js.html">documents/probe.js</a>,
<a href="probe.js.html#sunlight-1-line-902">line 902</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">array</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="update"><span class="type-signature"><static> </span>update<span class="signature">(obj, qu, setDocument)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Updates all records in obj that match the query. See <a href="probe.updateOperators.html">module:documents/probe.updateOperators</a> for the operators that are supported.</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>obj</code></td>
<td class="type">
<span class="param-type">object</span>
|
<span class="param-type">array</span>
</td>
<td class="description last"><p>The object to update</p></td>
</tr>
<tr>
<td class="name"><code>qu</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The query which will be used to identify the records to updated</p></td>
</tr>
<tr>
<td class="name"><code>setDocument</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The update operator. See <a href="probe.updateOperators.html">module:documents/probe.updateOperators</a></p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="probe.js.html">documents/probe.js</a>,
<a href="probe.js.html#sunlight-1-line-734">line 734</a>
</li>
</ul>
</dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
DocStrap Copyright © 2012-2013 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-alpha5</a>
on Sun Jun 1st 2014 using the <a
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
</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>
<script>
$( function () {
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
// $( ".tutorial-section pre, .readme-section pre" ).addClass( "sunlight-highlight-javascript" ).addClass( "linenums" );
$( ".tutorial-section pre, .readme-section pre" ).each( function () {
var $this = $( this );
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";
}
if ( lang ) {
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
}
} );
Sunlight.highlightAll( {
lineNumbers : true,
showMenu:true,
enableDoclinks:true
} );
} );
</script>
<!--Google Analytics-->
<!--Navigation and Symbol Display-->
</body>
</html>