Skip to content

Commit

Permalink
updated rendered docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@esatterwhite
esatterwhite committed Jun 5, 2017
1 parent 234be91 commit 57a367e
Show file tree
Hide file tree
Showing 55 changed files with 4,891 additions and 2,998 deletions.
14 changes: 14 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
v4.3.0
-------
* test: moves test harness out of the docker setup - c25f5c5bc7
* timers: setup storage before nats to allow errors to bubble - dc88b48eed
* tansports: fixes named function checks

v4.2.0
------
* Transports can define a shutdown handler

v4.1.0
------
* Allows for custom transports

v4.0.0
------
* Support crash recovery of timers
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ skyring run --storage:backend=leveldown --storage:path='/var/data/skyring'

Skyring ships with a single HTTP transport, but support custom transports. A `transport` is a named function
that can be executed when a timer triggers. To register a transport, you can pass an array of named functions, or
requireable paths to the skyring server constructor via via the `transports` option
requireable paths to the skyring server constructor via via the {@link module:skyring/lib/transports|transports} option

Optionally, for transports that need to perform some clean up work, a function property `shutdown` may be defined
on the transport
Expand Down
4 changes: 2 additions & 2 deletions docs/api/api_project.js
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
define({
"name": "skyring",
"version": "4.2.1",
"version": "4.3.0",
"description": "Distributed timers as a service",
"sampleUrl": false,
"apidoc": "0.2.0",
"generator": {
"name": "apidoc",
"time": "2017-06-03T20:06:10.692Z",
"time": "2017-06-04T20:15:52.536Z",
"url": "http://apidocjs.com",
"version": "0.16.1"
}
Expand Down
4 changes: 2 additions & 2 deletions docs/api/api_project.json
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"name": "skyring",
"version": "4.2.1",
"version": "4.3.0",
"description": "Distributed timers as a service",
"sampleUrl": false,
"apidoc": "0.2.0",
"generator": {
"name": "apidoc",
"time": "2017-06-03T20:06:10.692Z",
"time": "2017-06-04T20:15:52.536Z",
"url": "http://apidocjs.com",
"version": "0.16.1"
}
Expand Down
334 changes: 334 additions & 0 deletions docs/classes.list.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,334 @@
<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>Skyring Classes</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.dark.css">

<link type="text/css" rel="stylesheet" href="styles/site.slate.css">

</head>

<body>

<div class="navbar navbar-default navbar-fixed-top ">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="index.html">Skyring</a>
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse" id="topNavigation">
<ul class="nav navbar-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-keef.html">keef</a></li><li><a href="module-skyring.html">skyring</a></li><li><a href="module-skyring_conf.html">skyring/conf</a></li><li><a href="module-skyring_lib_json.html">skyring/lib/json</a></li><li><a href="module-skyring_lib_nats.html">skyring/lib/nats</a></li><li><a href="module-skyring_lib_server.html">skyring/lib/server</a></li><li><a href="module-skyring_lib_server_mock.html">skyring/lib/server/mock</a></li><li><a href="module-skyring_lib_server_node.html">skyring/lib/server/node</a></li><li><a href="module-skyring_lib_server_request.html">skyring/lib/server/request</a></li><li><a href="module-skyring_lib_server_response.html">skyring/lib/server/response</a></li><li><a href="module-skyring_lib_server_route.html">skyring/lib/server/route</a></li><li><a href="module-skyring_lib_server_router.html">skyring/lib/server/router</a></li><li><a href="module-skyring_lib_timer.html">skyring/lib/timer</a></li><li><a href="module-skyring_lib_transports.html">skyring/lib/transports</a></li><li><a href="module-skyring_lib_transports_http.html">skyring/lib/transports/http</a></li><li><a href="module-skyring_lib_transports_timer.html">skyring/lib/transports/timer</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="module-skyring_lib_server_mock.Request.html">skyring/lib/server/mock.Request</a></li><li><a href="module-skyring_lib_server_mock.Response.html">skyring/lib/server/mock.Response</a></li><li><a href="skyring_lib_server_request.html">skyring/lib/server/request</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-bootstrap.html">Bootstrapping A Cluster</a></li><li><a href="tutorial-transports.html">Custom Transports</a></li>
</ul>
</li>

</ul>

<div class="col-sm-3 col-md-3">
<form class="navbar-form" role="search">
<div class="input-group">
<input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
<div class="input-group-btn">
<button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
</div>
</div>
</form>
</div>

</div>

</div>
</div>


<div class="container" id="toc-content">
<div class="row">


<div class="col-md-8">

<div id="main">


<h1 class="page-title">Classes</h1>
<section>

<header>

<h2>

</h2>


</header>


<article>
<div class="container-overview">




<dl class="details">



































</dl>




</div>






<h3 class="subsection-title">Classes</h3>

<dl>
<dt><a href="module-skyring_lib_server.html">module:skyring/lib/server</a></dt>
<dd></dd>

<dt><a href="module-skyring_lib_server_mock.Request.html">Request</a></dt>
<dd></dd>

<dt><a href="module-skyring_lib_server_mock.Response.html">Response</a></dt>
<dd></dd>

<dt><a href="module-skyring_lib_server_node.html">module:skyring/lib/server/node</a></dt>
<dd></dd>

<dt><a href="module-skyring_lib_server_response.html">module:skyring/lib/server/response</a></dt>
<dd></dd>

<dt><a href="module-skyring_lib_server_route.html">module:skyring/lib/server/route</a></dt>
<dd></dd>

<dt><a href="module-skyring_lib_server_router.html">module:skyring/lib/server/router</a></dt>
<dd></dd>

<dt><a href="module-skyring_lib_timer.html">module:skyring/lib/timer</a></dt>
<dd></dd>

<dt><a href="module-skyring_lib_transports.html">module:skyring/lib/transports</a></dt>
<dd></dd>

<dt><a href="skyring_lib_server_request.html">skyring/lib/server/request</a></dt>
<dd></dd>
</dl>













</article>

</section>




</div>
</div>

<div class="clearfix"></div>


<div class="col-md-3">
<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
</div>


</div>
</div>


<div class="modal fade" id="searchResults">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
<h4 class="modal-title">Search results</h4>
</div>
<div class="modal-body"></div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
</div>
</div><!-- /.modal-content -->
</div><!-- /.modal-dialog -->
</div>


<footer>


<span class="copyright">
Eric Satterwhite &copy; 2016
</span>

<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>

on 2017-06-04T15:15:51-05:00

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>

<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>

<script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>


<script>
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );

$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );

$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).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 {
var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
lang = langClassMatch ? langClassMatch[1] : "javascript";
}

if ( lang ) {

$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );

}
} );

Sunlight.highlightAll( {
lineNumbers : false,
showMenu : true,
enableDoclinks : true
} );

$.catchAnchorLinks( {
navbarOffset: 10
} );
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
showAndHide : false,
smoothScrolling: true
} );

$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();

$( "table" ).each( function () {
var $this = $( this );
$this.addClass('table');
} );

} );
</script>



<!--Navigation and Symbol Display-->


<!--Google Analytics-->



<script type="text/javascript">
$(document).ready(function() {
SearcherDisplay.init();
});
</script>


</body>
</html>
Loading

0 comments on commit 57a367e

Please sign in to comment.