doc: update module and pi docs

update generated documentations
esatterwhite · Nov 7, 2018 · 8f5acc3 · 8f5acc3
1 parent f95a18d
commit 8f5acc3
Show file tree

Hide file tree

Showing 48 changed files with 63 additions and 60 deletions.
diff --git a/docs/api/api_data.js b/docs/api/api_data.js
@@ -15,7 +15,7 @@ define({ "api": [
             "type": "Number",
             "optional": false,
             "field": "timeout",
-            "description": "<p>the time in miliseconds before the timer executes</p>"
+            "description": "<p>the time in milliseconds from now the timer should execute. This must be in the range: 0 &lt; timeout &lt; 2^31 - 1.</p>"
           },
           {
             "group": "Parameter",
@@ -173,7 +173,7 @@ define({ "api": [
             "type": "Number",
             "optional": false,
             "field": "timeout",
-            "description": "<p>the time in miliseconds before the timer executes</p>"
+            "description": "<p>the time in milliseconds from now the timer should execute. This must be in the range: 0 &lt; timeout &lt; 2^31 - 1.</p>"
           },
           {
             "group": "Parameter",

diff --git a/docs/api/api_data.json b/docs/api/api_data.json
@@ -15,7 +15,7 @@
             "type": "Number",
             "optional": false,
             "field": "timeout",
-            "description": "<p>the time in miliseconds before the timer executes</p>"
+            "description": "<p>the time in milliseconds from now the timer should execute. This must be in the range: 0 &lt; timeout &lt; 2^31 - 1.</p>"
           },
           {
             "group": "Parameter",
@@ -173,7 +173,7 @@
             "type": "Number",
             "optional": false,
             "field": "timeout",
-            "description": "<p>the time in miliseconds before the timer executes</p>"
+            "description": "<p>the time in milliseconds from now the timer should execute. This must be in the range: 0 &lt; timeout &lt; 2^31 - 1.</p>"
           },
           {
             "group": "Parameter",

diff --git a/docs/api/api_project.js b/docs/api/api_project.js
@@ -1,13 +1,13 @@
 define({
   "name": "skyring",
-  "version": "6.0.0",
+  "version": "6.1.0",
   "description": "Distributed timers as a service",
   "sampleUrl": false,
   "defaultVersion": "0.0.0",
   "apidoc": "0.3.0",
   "generator": {
     "name": "apidoc",
-    "time": "2018-03-11T18:53:52.639Z",
+    "time": "2018-11-07T02:04:12.519Z",
     "url": "http://apidocjs.com",
     "version": "0.17.6"
   }

diff --git a/docs/api/api_project.json b/docs/api/api_project.json
@@ -1,13 +1,13 @@
 {
   "name": "skyring",
-  "version": "6.0.0",
+  "version": "6.1.0",
   "description": "Distributed timers as a service",
   "sampleUrl": false,
   "defaultVersion": "0.0.0",
   "apidoc": "0.3.0",
   "generator": {
     "name": "apidoc",
-    "time": "2018-03-11T18:53:52.639Z",
+    "time": "2018-11-07T02:04:12.519Z",
     "url": "http://apidocjs.com",
     "version": "0.17.6"
   }

diff --git a/docs/classes.list.html b/docs/classes.list.html
@@ -247,7 +247,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/global.html b/docs/global.html
@@ -820,7 +820,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/index.html b/docs/index.html
@@ -108,19 +108,19 @@
 
     <section class="readme-section">
         <article><p><img src="https://github.com/esatterwhite/skyring/raw/master/assets/skyring-inverted.png" alt="skyring"></p>
-<p><a href="https://travis-ci.org/esatterwhite/skyring"><img src="https://img.shields.io/travis/esatterwhite/skyring.svg?style=flat-square" alt="Travis"></a>
+<p><a href="skyring"><img src="https://img.shields.io/travis/esatterwhite/skyring/master.svg?style=flat-square" alt="Travis branch"></a>
 <a href="https://www.npmjs.com/package/skyring"><img src="https://img.shields.io/npm/v/skyring.svg?style=flat-square" alt="npm"></a>
-<a href="https://www.npmjs.com/package/skyring"><img src="https://img.shields.io/npm/l/skyring.svg?style=flat-square" alt="npm"></a>
+<a href="https://github.com/esatterwhite/skyring"><img src="https://img.shields.io/npm/l/skyring.svg?style=flat-square" alt="npm"></a>
 <a href="https://david-dm.org/esatterwhite/skyring"><img src="https://img.shields.io/david/esatterwhite/skyring.svg?style=flat-square" alt="David"></a>
 <a href="https://codeclimate.com/github/esatterwhite/skyring"><img src="https://img.shields.io/codeclimate/maintainability/esatterwhite/skyring.svg?style=flat-square" alt="Code Climate"></a>
 <a href="https://quay.io/repository/esatterwhite/skyring"><img src="https://quay.io/repository/esatterwhite/skyring/status" alt="Docker Repository on Quay" title="Docker Repository on Quay"></a></p>
 <ul>
 <li><a href="https://esatterwhite.github.io/skyring/">Module Docs</a></li>
 <li><a href="https://esatterwhite.github.io/skyring/api">API Docs</a></li>
 </ul>
-<h1>Skyring</h1><p>A distributed reliable timer service providing similar functionality to using <code>setTimeout</code>.
-<code>Skyring</code> servers are clustered  into a <em>hashring</em> using consistent hashing to partition timers to specific nodes in the ring.  Skyring exposes a simple HTTP API That allows to you create and cancel timers. Timer execution comes in to the form of an HTTP webhook ( more transports to come )</p>
-<h1>Architechture Overview</h1><p><img src="https://raw.githubusercontent.com/esatterwhite/skyring/master/assets/skyring-arch.png" width="100%" max-width="800px"></p>
+<h1>Skyring</h1><p>A distributed reliable timer service providing <code>setTimeout</code> functionality in a distributed fashion.
+<code>Skyring</code> servers are clustered into a <em>hashring</em> using consistent hashing to partition timers to specific nodes in the ring.  Skyring exposes a simple HTTP API that allows to you create and cancel timers. Timer execution comes in to the form of an HTTP webhook ( more transports to come )</p>
+<h1>Architechture Overview</h1><p><img src="https://raw.githubusercontent.com/esatterwhite/skyring/master/assets/skyring-arch-inverted.png" width="100%" max-width="800px"></p>
 <h1>Install</h1><pre class="prettyprint source"><code>npm install -s skyring</code></pre><h2>Run A Local Cluster</h2><h3>Start a nats instance</h3><p>Download the <a href="https://github.com/nats-io/gnatsd/releases">nats binary</a> and start it using the defaults</p>
 <pre class="prettyprint source lang-bash"><code>$ gnats -D -V</code></pre><p>To verify that it is working, you can <code>telnet</code> directly to the server and ping it.</p>
 <pre class="prettyprint source lang-bash"><code>$ telnet localhost 4222
@@ -164,6 +164,9 @@ <h1>Timer API</h1><p>A request can be issued to any active node in the cluster.
 The minimum <em>recommended</em> cluster size is 3 nodes, 2 of which being seed or bootstrapping nodes. A cluster of this size can average
 between 2K - 5K requests per second.</p>
 <h2>Create a timer</h2><h5><strong>POST <code>/timer</code></strong></h5><p><strong>Request</strong></p>
+<p>Since timers managed in <code>Skyring</code> are done so through the use of <code>setTimeout</code>, there is a maximum <code>timeout</code> value of <code>2^31 - 1</code> or
+<code>2147483647</code> milliseconds, which is approximately <code>24.8</code> days. Attempting to request a timeout great than this value will result in a
+<code>400 Bad Request</code> response. Additionally, the <code>timeout</code> must be greater than <code>0</code>.</p>
 <pre class="prettyprint source lang-bash"><code>curl -i -XPOST http://localhost:8080/timer -d '{
   &quot;timeout&quot;: 6000,
   &quot;data&quot; : &quot;{\&quot;foo\&quot;:\&quot;bar\&quot;}&quot;,
@@ -271,7 +274,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/index.js.html b/docs/index.js.html
@@ -202,7 +202,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_json.js.html b/docs/lib_json.js.html
@@ -167,7 +167,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_nats.js.html b/docs/lib_nats.js.html
@@ -229,7 +229,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_server_index.js.html b/docs/lib_server_index.js.html
@@ -333,7 +333,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_server_mock.js.html b/docs/lib_server_mock.js.html
@@ -317,7 +317,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_server_node.js.html b/docs/lib_server_node.js.html
@@ -340,7 +340,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_server_request.js.html b/docs/lib_server_request.js.html
@@ -220,7 +220,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_server_response.js.html b/docs/lib_server_response.js.html
@@ -261,7 +261,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_server_route.js.html b/docs/lib_server_route.js.html
@@ -250,7 +250,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:10-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_server_router.js.html b/docs/lib_server_router.js.html
@@ -308,7 +308,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_timer.js.html b/docs/lib_timer.js.html
@@ -216,7 +216,7 @@ <h1 class="page-title">Source: lib/timer.js</h1>
    * @method module:skyring/lib/timer#create
    * @param {String} id A unique Id of the time
    * @param {Object} body Configuration options for the timer instance
-   * @param {Number} body.timeout Duration in milisecods to delay execution of the timer
+   * @param {Number} body.timeout the time in milliseconds from now the timer should execute. This must be in the range: 0 &lt; timeout &lt; 2^31 - 1.
    * @param {String} body.data The data to be assicated with the timer, when it is executed
    * @param {Number} [body.created=Date.now()] timestamp when the timer is created. if not set, will default to now
    * @param {Object} callback Options for the outbound transport for the timer when it executes
@@ -643,7 +643,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_transports_callback.js.html b/docs/lib_transports_callback.js.html
@@ -148,7 +148,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_transports_http.js.html b/docs/lib_transports_http.js.html
@@ -200,7 +200,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_transports_index.js.html b/docs/lib_transports_index.js.html
@@ -110,7 +110,7 @@ <h1 class="page-title">Source: lib/transports/index.js</h1>
     , http      = require('./http')
     , kLoad     = Symbol('kLoad')
     , kShutdown = Symbol.for('kShutdown')
-    , ENV       = conf.get('NODE_ENV')
+    , ENV       = conf.get('node_env')
     , defaults  = toArray(conf.get('transport'))
     ;
 
@@ -277,7 +277,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-keef.html b/docs/module-keef.html
@@ -331,7 +331,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring.html b/docs/module-skyring.html
@@ -246,7 +246,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_conf.html b/docs/module-skyring_conf.html
@@ -726,7 +726,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_json.html b/docs/module-skyring_lib_json.html
@@ -522,7 +522,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_nats.html b/docs/module-skyring_lib_nats.html
@@ -510,7 +510,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_server.html b/docs/module-skyring_lib_server.html
@@ -1143,7 +1143,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_server_mock.Request.html b/docs/module-skyring_lib_server_mock.Request.html
@@ -269,7 +269,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_server_mock.Response.html b/docs/module-skyring_lib_server_mock.Response.html
@@ -269,7 +269,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_server_mock.html b/docs/module-skyring_lib_server_mock.html
@@ -255,7 +255,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_server_node.html b/docs/module-skyring_lib_server_node.html
@@ -1723,7 +1723,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_server_request.html b/docs/module-skyring_lib_server_request.html
@@ -241,7 +241,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_server_response.html b/docs/module-skyring_lib_server_response.html
@@ -1499,7 +1499,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_server_route.html b/docs/module-skyring_lib_server_route.html
@@ -628,7 +628,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_server_router.html b/docs/module-skyring_lib_server_router.html
@@ -1879,7 +1879,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 
-		on 2018-03-11T13:53:52-05:00
+		on 2018-11-06T21:04:11-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>