morefun-forerunnerdb
Version:
A NoSQL document store database for browsers and Node.js.
4,358 lines (1,006 loc) • 56.6 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="access"><span class="type-signature"></span>access<span class="type-signature"></span></h4>
<div class="description">
Defines an access rule for an object and HTTP method combination. When
access is requested via a REST call, the function provided will be
executed and the callback from that method will determine if the
access will be allowed or denied. Multiple access functions can
be provided for a single model and method allowing authentication
checks to be stacked.
This call also allows you to pass a wildcard "*" instead of the objType,
objName and methodName parameters which will match all items. This
allows you to set permissions globally.
If no access permissions are present ForerunnerDB will automatically
deny any request to the resource by default.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="NodeApiServer.js.html">NodeApiServer.js</a>, <a href="NodeApiServer.js.html#line733">line 733</a>
</li></ul></dd>
</dl>
<h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"></span></h4>
<div class="description">
Get / set the procedure name.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Procedure.js.html">Procedure.js</a>, <a href="Procedure.js.html#line40">line 40</a>
</li></ul></dd>
</dl>
<h4 class="name" id="NodeRAS"><span class="type-signature"></span>NodeRAS<span class="type-signature"></span></h4>
<div class="description">
Data files saved by this storage engine are composed of an initial header
section which contains meta-data used to identify data entry boundaries
and then a body section which contains the data proper.
You can think of the data file being composed of many JSON objects. The
header is one object and the body is an array of multiple other objects.
At the binary level we always start with a data length followed by a
marker that denotes the length end, after which the data will follow.
e.g. 20:{"hello": "thgbfsw"}20:{"hello": "thgbfsw"}
The first entry will always be the header or "meta-data". The meta-data
includes all the information we need to locate entries in the body randomly
so you can think of it as the body's index. It can also contain arbitrary
data apart from the index that may include flags denoting middleware usage
etc.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="NodeRAS.js.html">NodeRAS.js</a>, <a href="NodeRAS.js.html#line28">line 28</a>
</li></ul></dd>
</dl>
<h4 class="name" id="server"><span class="type-signature"></span>server<span class="type-signature"></span></h4>
<div class="description">
Set the url of the server to use for API.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="NodeApiClient.js.html">NodeApiClient.js</a>, <a href="NodeApiClient.js.html#line43">line 43</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setData"><span class="type-signature"></span>setData<span class="type-signature"></span></h4>
<div class="description">
Sets the collection's data to the array / documents passed. If any
data already exists in the collection it will be removed before the
new data is set via the remove() method, and the remove event will
fire as well.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Collection.js.html">Collection.js</a>, <a href="Collection.js.html#line368">line 368</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setData"><span class="type-signature"></span>setData<span class="type-signature"></span></h4>
<div class="description">
Sets the collection's data to the array / documents passed. If any
data already exists in the collection it will be removed before the
new data is set via the remove() method, and the remove event will
fire as well.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Collection.js.html">Collection.js</a>, <a href="Collection.js.html#line341">line 341</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setData"><span class="type-signature"></span>setData<span class="type-signature"></span></h4>
<div class="description">
Sets the collection's data to the array / documents passed. If any
data already exists in the collection it will be removed before the
new data is set via the remove() method, and the remove event will
fire as well.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Collection.js.html">Collection.js</a>, <a href="Collection.js.html#line382">line 382</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setData"><span class="type-signature"></span>setData<span class="type-signature"></span></h4>
<div class="description">
Sets the collection's data to the array / documents passed. If any
data already exists in the collection it will be removed before the
new data is set via the remove() method, and the remove event will
fire as well.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Collection.js.html">Collection.js</a>, <a href="Collection.js.html#line354">line 354</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setData"><span class="type-signature"></span>setData<span class="type-signature"></span></h4>
<div class="description">
Sets the collection's data to the array / documents passed. If any
data already exists in the collection it will be removed before the
new data is set via the remove() method, and the remove event will
fire as well.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Collection.js.html">Collection.js</a>, <a href="Collection.js.html#line412">line 412</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setData"><span class="type-signature"></span>setData<span class="type-signature"></span></h4>
<div class="description">
Sets the collection's data to the array / documents passed. If any
data already exists in the collection it will be removed before the
new data is set via the remove() method, and the remove event will
fire as well.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Collection.js.html">Collection.js</a>, <a href="Collection.js.html#line397">line 397</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Shared"><span class="type-signature"></span>Shared<span class="type-signature"></span></h4>
<div class="description">
This is a skeleton module definition that you can use as a springboard to
develop new modules easily. It includes registering the module with
ForerunnerDB and shows how to use common helper methods such as mixins
and method synthesis, as well as providing a pattern to allow the constructor
method to be overridden by other modules.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SkeletonModule.js.html">SkeletonModule.js</a>, <a href="SkeletonModule.js.html#line11">line 11</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Shared"><span class="type-signature"></span>Shared<span class="type-signature"></span></h4>
<div class="description">
The condition class monitors a data source and updates it's internal
state depending on clauses that it has been given. When all clauses
are satisfied the then() callback is fired. If conditions were met
but data changed that made them un-met, the else() callback is fired.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Condition.js.html">Condition.js</a>, <a href="Condition.js.html#line11">line 11</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="%22boolean,function%22"><span class="type-signature"></span>"boolean, function"<span class="signature">(removePersistent, callback)</span><span class="type-signature"></span></h4>
<div class="description">
Drop collections and optionally drop persistent storage with callback.
</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>removePersistent</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last">True to drop persistent storage, false to keep it.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#function">function</a></span>
</td>
<td class="description last">Callback method.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Persist.js.html">Persist.js</a>, <a href="Persist.js.html#line500">line 500</a>
</li></ul></dd>
</dl>
<h4 class="name" id="%22boolean,function%22"><span class="type-signature"></span>"boolean, function"<span class="signature">(removePersistent, callback)</span><span class="type-signature"></span></h4>
<div class="description">
Drop collections and optionally drop persistent storage with callback.
</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>removePersistent</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last">True to drop persistent storage, false to keep it.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#function">function</a></span>
</td>
<td class="description last">Callback method.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="NodePersist.js.html">NodePersist.js</a>, <a href="NodePersist.js.html#line523">line 523</a>
</li></ul></dd>
</dl>
<h4 class="name" id="%22object,function%22"><span class="type-signature"></span>"object, function"<span class="signature">(query, callback)</span><span class="type-signature"></span></h4>
<div class="description">
Sync with this collection on the server-side.
</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>query</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">A query object.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#function">function</a></span>
</td>
<td class="description last">The callback method to call once
the connection to the server has been established.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="NodeApiClient.js.html">NodeApiClient.js</a>, <a href="NodeApiClient.js.html#line432">line 432</a>
</li></ul></dd>
</dl>
<h4 class="name" id="%22object,object,function%22"><span class="type-signature"></span>"object, object, function"<span class="signature">(query, options, callback)</span><span class="type-signature"></span></h4>
<div class="description">
Sync with this collection on the server-side.
</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>query</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">A query object.</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">An options object.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#function">function</a></span>
</td>
<td class="description last">The callback method to call once
the connection to the server has been established.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="NodeApiClient.js.html">NodeApiClient.js</a>, <a href="NodeApiClient.js.html#line479">line 479</a>
</li></ul></dd>
</dl>
<h4 class="name" id="%22string,*,function%22"><span class="type-signature"></span>"string, *, function"<span class="signature">(event, id, listener)</span><span class="type-signature"></span></h4>
<div class="description">
Attach an event listener to the passed event only if the passed
id matches the document id for the event being fired.
</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>event</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The name of the event to listen for.</td>
</tr>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">The document id to match against.</td>
</tr>
<tr>
<td class="name"><code>listener</code></td>
<td class="type">
<span class="param-type"><a href="global.html#function">function</a></span>
</td>
<td class="description last">The method to call when the event is fired.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mixin.Events.js.html">Mixin.Events.js</a>, <a href="Mixin.Events.js.html#line32">line 32</a>
</li></ul></dd>
</dl>
<h4 class="name" id="%22string,function%22"><span class="type-signature"></span>"string, function"<span class="signature">(collectionName, callback)</span><span class="type-signature"></span></h4>
<div class="description">
Sync with this collection on the server-side.
</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>collectionName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The collection to sync from.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#function">function</a></span>
</td>
<td class="description last">The callback method to call once
the connection to the server has been established.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="NodeApiClient.js.html">NodeApiClient.js</a>, <a href="NodeApiClient.js.html#line422">line 422</a>
</li></ul></dd>
</dl>
<h4 class="name" id="%22string,function%22"><span class="type-signature"></span>"string, function"<span class="signature">(event, listener)</span><span class="type-signature"></span></h4>
<div class="description">
Attach an event listener to the passed event.
</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>event</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The name of the event to listen for.</td>
</tr>
<tr>
<td class="name"><code>listener</code></td>
<td class="type">
<span class="param-type"><a href="global.html#function">function</a></span>
</td>
<td class="description last">The method to call when the event is fired.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mixin.Events.js.html">Mixin.Events.js</a>, <a href="Mixin.Events.js.html#line16">line 16</a>
</li></ul></dd>
</dl>
<h4 class="name" id="%22string,object,function%22"><span class="type-signature"></span>"string, object, function"<span class="signature">(collectionName, query, callback)</span><span class="type-signature"></span></h4>
<div class="description">
Sync with this collection on the server-side.
</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>collectionName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The collection to sync from.</td>
</tr>
<tr>
<td class="name"><code>query</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">A query object.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#function">function</a></span>
</td>
<td class="description last">The callback method to call once
the connection to the server has been established.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="NodeApiClient.js.html">NodeApiClient.js</a>, <a href="NodeApiClient.js.html#line455">line 455</a>
</li></ul></dd>
</dl>
<h4 class="name" id="%22string,object,object,function%22"><span class="type-signature"></span>"string, object, object, function"<span class="signature">(collectionName, query, options, callback)</span><span class="type-signature"></span></h4>
<div class="description">
Sync with this collection on the server-side.
</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>collectionName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The collection to sync from.</td>
</tr>
<tr>
<td class="name"><code>query</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">A query object.</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">An options object.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#function">function</a></span>
</td>
<td class="description last">The callback method to call once
the connection to the server has been established.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="NodeApiClient.js.html">NodeApiClient.js</a>, <a href="NodeApiClient.js.html#line491">line 491</a>
</li></ul></dd>
</dl>
<h4 class="name" id="%22string,string,function%22"><span class="type-signature"></span>"string, string, function"<span class="signature">(objectType, objectName, callback)</span><span class="type-signature"></span></h4>
<div class="description">
Sync with this collection on the server-side.
</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>objectType</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The type of object to sync to e.g.
"collection" or "view".</td>
</tr>
<tr>
<td class="name"><code>objectName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The name of the object to sync from.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#function">function</a></span>
</td>
<td class="description last">The callback method to call once
the connection to the server has been established.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="NodeApiClient.js.html">NodeApiClient.js</a>, <a href="NodeApiClient.js.html#line444">line 444</a>
</li></ul></dd>
</dl>
<h4 class="name" id="%22string,string,object,function%22"><span class="type-signature"></span>"string, string, object, function"<span class="signature">(objectType, objectName, query, callback)</span><span class="type-signature"></span></h4>
<div class="description">
Sync with this collection on the server-side.
</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>objectType</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The type of object to sync to e.g.
"collection" or "view".</td>
</tr>
<tr>
<td class="name"><code>objectName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The name of the object to sync from.</td>
</tr>
<tr>
<td class="name"><code>query</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">A query object.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#function">function</a></span>
</td>
<td class="description last">The callback method to call once
the connection to the server has been established.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="NodeApiClient.js.html">NodeApiClient.js</a>, <a href="NodeApiClient.js.html#line468">line 468</a>
</li></ul></dd>
</dl>
<h4 class="name" id="%22string,string,object,object,function%22"><span class="type-signature"></span>"string, string, object, object, function"<span class="signature">(objectType, objectName, query, options, callback)</span><span class="type-signature"></span></h4>
<div class="description">
Sync with this collection on the server-side.
</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>objectType</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The type of object to sync to e.g.
"collection" or "view".</td>
</tr>
<tr>
<td class="name"><code>objectName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The name of the object to sync from.</td>
</tr>
<tr>
<td class="name"><code>query</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">A query object.</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">An options object.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#function">function</a></span>
</td>
<td class="description last">The callback method to call once
the connection to the server has been established.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="NodeApiClient.js.html">NodeApiClient.js</a>, <a href="NodeApiClient.js.html#line505">line 505</a>
</li></ul></dd>
</dl>
<h4 class="name" id="boolean"><span class="type-signature"></span>boolean<span class="signature">(removePersistent)</span><span class="type-signature"></span></h4>
<div class="description">
Drop collection and optionally drop persistent storage.
</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>removePersistent</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last">True to drop persistent storage, false to keep it.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="NodePersist.js.html">NodePersist.js</a>, <a href="NodePersist.js.html#line498">line 498</a>
</li></ul></dd>
</dl>
<h4 class="name" id="boolean"><span class="type-signature"></span>boolean<span class="signature">(removePersistent)</span><span class="type-signature"></span></h4>
<div class="description">
Drop collection and optionally drop persistent storage.
</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>removePersistent</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last">True to drop persistent storage, false to keep it.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Persist.js.html">Persist.js</a>, <a href="Persist.js.html#line475">line 475</a>
</li></ul></dd>
</dl>
<h4 class="name" id="checksum"><span class="type-signature"></span>checksum<span class="signature">(str)</span><span class="type-signature"> → {Number}</span></h4>
<div class="description">
Returns a checksum of a string.
</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>str</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The string to checksum.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Checksum.js.html">Checksum.js</a>, <a href="Checksum.js.html#line28">line 28</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The checksum generated.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Number</span>
</dd>
</dl>
<h4 class="name" id="Condition"><span class="type-signature"></span>Condition<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Create a constructor method that calls the instance's init method.
This allows the constructor to be overridden by other modules because
they can override the init method with their own.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Condition.js.html">Condition.js</a>, <a href="Condition.js.html#line21">line 21</a>
</li></ul></dd>
</dl>
<h4 class="name" id="function"><span class="type-signature"></span>function<span class="signature">(callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Saves an entire database's data to persistent storage.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#function">function</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The method to call when the save function
has completed.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Persist.js.html">Persist.js</a>, <a href="Persist.js.html#line792">line 792</a>
</li></ul></dd>
</dl>
<h4 class="name" id="function"><span class="type-signature"></span>function<span class="signature">(callback)</span><span class="type-signature"></span></h4>
<div class="description">
Drop collection and persistent storage with callback.
</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>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#function">function</a></span>
</td>
<td class="description last">Callback method.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="NodePersist.js.html">NodePersist.js</a>, <a href="NodePersist.js.html#line488">line 488</a>
</li></ul></dd>
</dl>
<h4 class="name" id="function"><span class="type-signature"></span>function<span class="signature">(callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Loads an entire database's data from persistent storage.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#function">function</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The method to call when the load function
has completed.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Persist.js.html">Persist.js</a>, <a href="Persist.js.html#line741">line 741</a>
</li></ul></dd>
</dl>
<h4 class="name" id="function"><span class="type-signature"></span>function<span class="signature">(callback)</span><span class="type-signature"></span></h4>
<div class="description">
Drop collection and persistent storage with callback.
</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>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#function">function</a></span>
</td>
<td class="description last">Callback method.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Persist.js.html">Persist.js</a>, <a href="Persist.js.html#line465">line 465</a>
</li></ul></dd>
</dl>
<h4 class="name" id="function"><span class="type-signature"></span>function<span class="signature">(callback)</span><span class="type-signature"></span></h4>
<div class="description">
Sync with this collection on the server-side.
</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>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#function">function</a></span>
</td>
<td class="description last">The callback method to call once
the connection to the server has been established.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="NodeApiClient.js.html">NodeApiClient.js</a>, <a href="NodeApiClient.js.html#line412">line 412</a>
</li></ul></dd>
</dl>
<h4 class="name" id="MyModule"><span class="type-signature"></span>MyModule<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Create a constructor method that calls the instance's init method.
This allows the constructor to be overridden by other modules because
they can override the init method with their own.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SkeletonModule.js.html">SkeletonModule.js</a>, <a href="SkeletonModule.js.html#line22">line 22</a>
</li></ul></dd>
</dl>
<h4 class="name" id="NodeRAS"><span class="type-signature"></span>NodeRAS<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Create a constructor method that calls the instance's init method.
This allows the constructor to be overridden by other modules because
they can override the init method with their own.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="NodeRAS.js.html">NodeRAS.js</a>, <a href="NodeRAS.js.html#line36">line 36</a>
</li></ul></dd>
</dl>