update docs for 4.3

esatterwhite · Jun 3, 2017 · e7ad159 · e7ad159
1 parent 59ade79
commit e7ad159
Show file tree

Hide file tree

Showing 36 changed files with 49 additions and 44 deletions.
diff --git a/docs/api/api_project.js b/docs/api/api_project.js
@@ -1,12 +1,12 @@
 define({
   "name": "skyring",
-  "version": "4.1.0",
+  "version": "4.2.1",
   "description": "Distributed timers as a service",
   "sampleUrl": false,
   "apidoc": "0.2.0",
   "generator": {
     "name": "apidoc",
-    "time": "2017-05-28T03:13:01.614Z",
+    "time": "2017-06-03T20:06:10.692Z",
     "url": "http://apidocjs.com",
     "version": "0.16.1"
   }

diff --git a/docs/api/api_project.json b/docs/api/api_project.json
@@ -1,12 +1,12 @@
 {
   "name": "skyring",
-  "version": "4.1.0",
+  "version": "4.2.1",
   "description": "Distributed timers as a service",
   "sampleUrl": false,
   "apidoc": "0.2.0",
   "generator": {
     "name": "apidoc",
-    "time": "2017-05-28T03:13:01.614Z",
+    "time": "2017-06-03T20:06:10.692Z",
     "url": "http://apidocjs.com",
     "version": "0.16.1"
   }

diff --git a/docs/index.html b/docs/index.html
@@ -228,7 +228,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-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
@@ -181,7 +181,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-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
@@ -146,7 +146,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-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
@@ -208,7 +208,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-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
@@ -302,7 +302,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-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
@@ -288,7 +288,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-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
@@ -312,7 +312,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-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
@@ -187,7 +187,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-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
@@ -183,7 +183,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-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
@@ -230,7 +230,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06: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
@@ -286,7 +286,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-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
@@ -117,7 +117,7 @@ <h1 class="page-title">Source: lib/timer.js</h1>
  * @param {String} options.storage.path A directory path to a leveldb instance. One will be created if it doesn't already exist.
  * If the backend is memdown, this is optional and randomly generated per timer instance
  * @param {Function} [onReady=()=>{}] A callback function to call after initial recovery has completed
- * @param {String[]|Function[]} [optsion.transports] an array of custom transport functions, or requireable paths that resolve to functions. All transport function must be named functions
+ * @param {String[]|Function[]} [options.transports] an array of custom transport functions, or requireable paths that resolve to functions. All transport function must be named functions
  * If not specified, configuration values will be used
  **/
 class Timer extends Map {
@@ -130,8 +130,6 @@ <h1 class="page-title">Source: lib/timer.js</h1>
     }, options);
     this._sid = null;
     this._bail = false;
-    this.nats = nats.createClient( this.options.nats );
-    this.transports = new Transports(this.options.transports);
     const store_opts = conf.get('storage');
     const opts = Object.assign(store_opts, this.options.storage);
     store(opts);
@@ -148,6 +146,8 @@ <h1 class="page-title">Source: lib/timer.js</h1>
       }
     }
     debug('storage path', opts);
+    this.nats = nats.createClient( this.options.nats );
+    this.transports = new Transports(this.options.transports);
     this[storage] = levelup(opts.path, {
       valueEncoding: 'json'
     , db: require( opts.backend )
@@ -197,6 +197,11 @@ <h1 class="page-title">Source: lib/timer.js</h1>
   create(id, body, cb) {
     const payload = body;
     const transport = this.transports[payload.callback.transport];
+    if (!transport) {
+      const err = new Error(`Unknown transport ${payload.callback.transport}`)
+      err.code = 'ENOTRANSPORT'
+      return setImmediate(cb, err)
+    }
     if ( this.has( id ) ) {
       const err = new Error(`Timer with id ${id} already exists` );
       err.code = 'EKEYEXISTS';
@@ -458,7 +463,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-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
@@ -127,7 +127,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-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
@@ -179,7 +179,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-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
@@ -117,11 +117,11 @@ <h1 class="page-title">Source: lib/transports/index.js</h1>
         throw new Error('Transports must accept five parameters');
       }
 
-      if (typeof transport.name !== 'string' &amp;&amp; transport.name.length &lt;= 0) {
+      if (typeof transport.name !== 'string' || transport.name.length &lt;= 0) {
         throw new TypeError('transports.name is required and must be a string');
       }
 
-      if (hasOwn(exports, transport.name)) {
+      if (hasOwn(this, transport.name)) {
         const error = new Error(`A transport with name ${transport.name} is already defined`);
         error.name = 'EEXIST';
         throw error;
@@ -201,7 +201,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-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
@@ -310,7 +310,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-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
@@ -225,7 +225,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-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
@@ -705,7 +705,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-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
@@ -501,7 +501,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-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
@@ -489,7 +489,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-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
@@ -1229,7 +1229,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:01-05:00
+		on 2017-06-03T15:06:10-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
@@ -226,7 +226,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:01-05:00
+		on 2017-06-03T15:06:10-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
@@ -1574,7 +1574,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:01-05:00
+		on 2017-06-03T15:06:10-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
@@ -218,7 +218,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:01-05:00
+		on 2017-06-03T15:06:10-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
@@ -218,7 +218,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:01-05:00
+		on 2017-06-03T15:06:10-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
@@ -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.4.3</a>
 
-		on 2017-05-27T22:13:01-05:00
+		on 2017-06-03T15:06:10-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
@@ -1838,7 +1838,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:01-05:00
+		on 2017-06-03T15:06:10-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_timer.html b/docs/module-skyring_lib_timer.html
@@ -475,7 +475,7 @@ <h6 class="method-params-label method-subparams-label">Properties</h6>
 
         <tr>
 
-                <td class="name"><code>optsion.transports</code></td>
+                <td class="name"><code>options.transports</code></td>
 
 
             <td class="type">
@@ -2166,7 +2166,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:01-05:00
+		on 2017-06-03T15:06:10-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_transports.html b/docs/module-skyring_lib_transports.html
@@ -346,7 +346,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:01-05:00
+		on 2017-06-03T15:06:10-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_transports_http.html b/docs/module-skyring_lib_transports_http.html
@@ -398,7 +398,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:01-05:00
+		on 2017-06-03T15:06:10-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_transports_timer.html b/docs/module-skyring_lib_transports_timer.html
@@ -212,7 +212,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:01-05:00
+		on 2017-06-03T15:06:10-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/modules.list.html b/docs/modules.list.html
@@ -211,7 +211,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/node_modules_keef_index.js.html b/docs/node_modules_keef_index.js.html
@@ -383,7 +383,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-05-27T22:13:00-05:00
+		on 2017-06-03T15:06:10-05:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/quicksearch.html b/docs/quicksearch.html