antfarm
Version:
File automation framework for ants.
919 lines • 51.6 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Tunnel | Antfarm 🐜</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<link rel="stylesheet" href="../assets/css/ant.css">
<script src="../assets/js/modernizr.js"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Antfarm 🐜</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="tunnel.html">Tunnel</a>
</li>
</ul>
<h1>Class Tunnel</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Tunnels are runnable work flow units that can watch nests.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Tunnel</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="tunnel.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="tunnel.html#_name" class="tsd-kind-icon">_name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="tunnel.html#_nests" class="tsd-kind-icon">_nests</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="tunnel.html#_run_fail" class="tsd-kind-icon">_run_<wbr>fail</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="tunnel.html#_run_list" class="tsd-kind-icon">_run_<wbr>list</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="tunnel.html#_run_sync_list" class="tsd-kind-icon">_run_<wbr>sync_<wbr>list</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="tunnel.html#e" class="tsd-kind-icon">e</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="tunnel.html#job_counter" class="tsd-kind-icon">job_<wbr>counter</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="tunnel.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="tunnel.html#nests" class="tsd-kind-icon">nests</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="tunnel.html#runfail" class="tsd-kind-icon">run<wbr>Fail</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="tunnel.html#runlist" class="tsd-kind-icon">run<wbr>List</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="tunnel.html#runsynclist" class="tsd-kind-icon">run<wbr>Sync<wbr>List</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="tunnel.html#arrive" class="tsd-kind-icon">arrive</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="tunnel.html#executefail" class="tsd-kind-icon">execute<wbr>Fail</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="tunnel.html#executematch" class="tsd-kind-icon">execute<wbr>Match</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="tunnel.html#executerun" class="tsd-kind-icon">execute<wbr>Run</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="tunnel.html#executerunsync" class="tsd-kind-icon">execute<wbr>Run<wbr>Sync</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="tunnel.html#fail" class="tsd-kind-icon">fail</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="tunnel.html#match" class="tsd-kind-icon">match</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="tunnel.html#run" class="tsd-kind-icon">run</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="tunnel.html#runsync" class="tsd-kind-icon">run<wbr>Sync</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="tunnel.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="tunnel.html#watch" class="tsd-kind-icon">watch</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private-protected">
<h3>Object literals</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-object-literal tsd-parent-kind-class tsd-is-protected"><a href="tunnel.html#match_obj" class="tsd-kind-icon">match_<wbr>obj</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Tunnel<span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="environment.html" class="tsd-signature-type">Environment</a>, tunnelName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="tunnel.html" class="tsd-signature-type">Tunnel</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L28">lib/tunnel/tunnel.ts:28</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>e: <a href="environment.html" class="tsd-signature-type">Environment</a></h5>
</li>
<li>
<h5>tunnelName: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="tunnel.html" class="tsd-signature-type">Tunnel</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="_name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _name</h3>
<div class="tsd-signature tsd-kind-icon">_name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L15">lib/tunnel/tunnel.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="_nests" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _nests</h3>
<div class="tsd-signature tsd-kind-icon">_nests<span class="tsd-signature-symbol">:</span> <a href="nest.html" class="tsd-signature-type">Nest</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L16">lib/tunnel/tunnel.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="_run_fail" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _run_<wbr>fail</h3>
<div class="tsd-signature tsd-kind-icon">_run_<wbr>fail<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L19">lib/tunnel/tunnel.ts:19</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="_run_list" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _run_<wbr>list</h3>
<div class="tsd-signature tsd-kind-icon">_run_<wbr>list<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L17">lib/tunnel/tunnel.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="_run_sync_list" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _run_<wbr>sync_<wbr>list</h3>
<div class="tsd-signature tsd-kind-icon">_run_<wbr>sync_<wbr>list<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L18">lib/tunnel/tunnel.ts:18</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="e" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> e</h3>
<div class="tsd-signature tsd-kind-icon">e<span class="tsd-signature-symbol">:</span> <a href="environment.html" class="tsd-signature-type">Environment</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L20">lib/tunnel/tunnel.ts:20</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="job_counter" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> job_<wbr>counter</h3>
<div class="tsd-signature tsd-kind-icon">job_<wbr>counter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L21">lib/tunnel/tunnel.ts:21</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
<a name="name" class="tsd-anchor"></a>
<h3>name</h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> name<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> name<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L43">lib/tunnel/tunnel.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L47">lib/tunnel/tunnel.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="nests" class="tsd-anchor"></a>
<h3>nests</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> nests<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="nest.html" class="tsd-signature-type">Nest</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L51">lib/tunnel/tunnel.ts:51</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="nest.html" class="tsd-signature-type">Nest</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
<a name="runfail" class="tsd-anchor"></a>
<h3>run<wbr>Fail</h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> runFail<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> runFail<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L63">lib/tunnel/tunnel.ts:63</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L67">lib/tunnel/tunnel.ts:67</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>callback: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="runlist" class="tsd-anchor"></a>
<h3>run<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> runList<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L55">lib/tunnel/tunnel.ts:55</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="runsynclist" class="tsd-anchor"></a>
<h3>run<wbr>Sync<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> runSyncList<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L59">lib/tunnel/tunnel.ts:59</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="arrive" class="tsd-anchor"></a>
<h3>arrive</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">arrive<span class="tsd-signature-symbol">(</span>job<span class="tsd-signature-symbol">: </span><a href="job.html" class="tsd-signature-type">Job</a>, nest<span class="tsd-signature-symbol">?: </span><a href="nest.html" class="tsd-signature-type">Nest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L82">lib/tunnel/tunnel.ts:82</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>job: <a href="job.html" class="tsd-signature-type">Job</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> nest: <a href="nest.html" class="tsd-signature-type">Nest</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="executefail" class="tsd-anchor"></a>
<h3>execute<wbr>Fail</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">execute<wbr>Fail<span class="tsd-signature-symbol">(</span>job<span class="tsd-signature-symbol">: </span><a href="job.html" class="tsd-signature-type">Job</a>, nest<span class="tsd-signature-symbol">: </span><a href="nest.html" class="tsd-signature-type">Nest</a>, reason<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L169">lib/tunnel/tunnel.ts:169</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Fail run event.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>job: <a href="job.html" class="tsd-signature-type">Job</a></h5>
</li>
<li>
<h5>nest: <a href="nest.html" class="tsd-signature-type">Nest</a></h5>
</li>
<li>
<h5>reason: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="executematch" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> execute<wbr>Match</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">execute<wbr>Match<span class="tsd-signature-symbol">(</span>job<span class="tsd-signature-symbol">: </span><a href="job.html" class="tsd-signature-type">Job</a>, nest<span class="tsd-signature-symbol">: </span><a href="nest.html" class="tsd-signature-type">Nest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L193">lib/tunnel/tunnel.ts:193</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Match execution</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>job: <a href="job.html" class="tsd-signature-type">Job</a></h5>
</li>
<li>
<h5>nest: <a href="nest.html" class="tsd-signature-type">Nest</a></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="executerun" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> execute<wbr>Run</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">execute<wbr>Run<span class="tsd-signature-symbol">(</span>job<span class="tsd-signature-symbol">: </span><a href="job.html" class="tsd-signature-type">Job</a>, nest<span class="tsd-signature-symbol">: </span><a href="nest.html" class="tsd-signature-type">Nest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L119">lib/tunnel/tunnel.ts:119</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Asynchronous run event.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>job: <a href="job.html" class="tsd-signature-type">Job</a></h5>
</li>
<li>
<h5>nest: <a href="nest.html" class="tsd-signature-type">Nest</a></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="executerunsync" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> execute<wbr>Run<wbr>Sync</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">execute<wbr>Run<wbr>Sync<span class="tsd-signature-symbol">(</span>job<span class="tsd-signature-symbol">: </span><a href="job.html" class="tsd-signature-type">Job</a>, nest<span class="tsd-signature-symbol">: </span><a href="nest.html" class="tsd-signature-type">Nest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L139">lib/tunnel/tunnel.ts:139</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Synchronous run event.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>job: <a href="job.html" class="tsd-signature-type">Job</a></h5>
</li>
<li>
<h5>nest: <a href="nest.html" class="tsd-signature-type">Nest</a></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="fail" class="tsd-anchor"></a>
<h3>fail</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">fail<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L110">lib/tunnel/tunnel.ts:110</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Failed jobs runner.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>callback: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="match" class="tsd-anchor"></a>
<h3>match</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">match<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, orphanMinutes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L182">lib/tunnel/tunnel.ts:182</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface for matching two or more _files together based on an array of glob filename patterns.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>pattern: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>orphanMinutes: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>callback: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="run" class="tsd-anchor"></a>
<h3>run</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L94">lib/tunnel/tunnel.ts:94</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Run program logic asynchronously.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>callback: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="runsync" class="tsd-anchor"></a>
<h3>run<wbr>Sync</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">run<wbr>Sync<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L102">lib/tunnel/tunnel.ts:102</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Run program logic synchronously.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>callback: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="tostring" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L39">lib/tunnel/tunnel.ts:39</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="watch" class="tsd-anchor"></a>
<h3>watch</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">watch<span class="tsd-signature-symbol">(</span>nest<span class="tsd-signature-symbol">: </span><a href="foldernest.html" class="tsd-signature-type">FolderNest</a><span class="tsd-signature-symbol"> | </span><a href="webhooknest.html" class="tsd-signature-type">WebhookNest</a><span class="tsd-signature-symbol"> | </span><a href="ftpnest.html" class="tsd-signature-type">FtpNest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L75">lib/tunnel/tunnel.ts:75</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Instructs the tunnel to watch a nest for new jobs.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>nest: <a href="foldernest.html" class="tsd-signature-type">FolderNest</a><span class="tsd-signature-symbol"> | </span><a href="webhooknest.html" class="tsd-signature-type">WebhookNest</a><span class="tsd-signature-symbol"> | </span><a href="ftpnest.html" class="tsd-signature-type">FtpNest</a></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private-protected">
<h2>Object literals</h2>
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-class tsd-is-protected">
<a name="match_obj" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> match_<wbr>obj</h3>
<div class="tsd-signature tsd-kind-icon">match_<wbr>obj<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L23">lib/tunnel/tunnel.ts:23</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="match_obj.orphan_minutes" class="tsd-anchor"></a>
<h3>orphan_<wbr>minutes</h3>
<div class="tsd-signature tsd-kind-icon">orphan_<wbr>minutes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L27">lib/tunnel/tunnel.ts:27</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="match_obj.pattern" class="tsd-anchor"></a>
<h3>pattern</h3>
<div class="tsd-signature tsd-kind-icon">pattern<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L26">lib/tunnel/tunnel.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="match_obj.queue" class="tsd-anchor"></a>
<h3>queue</h3>
<div class="tsd-signature tsd-kind-icon">queue<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = []</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L24">lib/tunnel/tunnel.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="match_obj.run-1" class="tsd-anchor"></a>
<h3>run</h3>
<div class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L25">lib/tunnel/tunnel.ts:25</a></li>
</ul>
</aside>
</section>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="tunnel.html" class="tsd-kind-icon">Tunnel</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="tunnel.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="tunnel.html#_name" class="tsd-kind-icon">_name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="tunnel.html#_nests" class="tsd-kind-icon">_nests</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="tunnel.html#_run_fail" class="tsd-kind-icon">_run_<wbr>fail</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="tunnel.html#_run_list" class="tsd-kind-icon">_run_<wbr>list</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="tunnel.html#_run_sync_list" class="tsd-kind-icon">_run_<wbr>sync_<wbr>list</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="tunnel.html#e" class="tsd-kind-icon">e</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="tunnel.html#job_counter" class="tsd-kind-icon">job_<wbr>counter</a>
</li>
<li class=" tsd-kind-accessor tsd-parent-kind-class">
<a href="tunnel.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="tunnel.html#nests" class="tsd-kind-icon">nests</a>
</li>
<li class=" tsd-kind-accessor tsd-parent-kind-class">
<a href="tunnel.html#runfail" class="tsd-kind-icon">run<wbr>Fail</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="tunnel.html#runlist" class="tsd-kind-icon">run<wbr>List</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="tunnel.html#runsynclist" class="tsd-kind-icon">run<wbr>Sync<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="tunnel.html#arrive" class="tsd-kind-icon">arrive</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="tunnel.html#executefail" class="tsd-kind-icon">execute<wbr>Fail</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="tunnel.html#executematch" class="tsd-kind-icon">execute<wbr>Match</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="tunnel.html#executerun" class="tsd-kind-icon">execute<wbr>Run</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="tunnel.html#executerunsync" class="tsd-kind-icon">execute<wbr>Run<wbr>Sync</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="tunnel.html#fail" class="tsd-kind-icon">fail</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="tunnel.html#match" class="tsd-kind-icon">match</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="tunnel.html#run" class="tsd-kind-icon">run</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="tunnel.html#runsync" class="tsd-kind-icon">run<wbr>Sync</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="tunnel.html#tostring" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="tunnel.html#watch" class="tsd-kind-icon">watch</a>
</li>
<li class=" tsd-kind-object-literal tsd-parent-kind-class tsd-is-protected">
<a href="tunnel.html#match_obj" class="tsd-kind-icon">match_<wbr>obj</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.io" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>