antfarm
Version:
File automation framework for ants.
910 lines • 51.8 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FolderNest | 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="foldernest.html">FolderNest</a>
</li>
</ul>
<h1>Class FolderNest</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>A folder nest is a nest which contains a backing folder at a specific _path. If the folder does not exist,
antfarm can optionally create it.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="nest.html" class="tsd-signature-type">Nest</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">FolderNest</span>
<ul class="tsd-hierarchy">
<li>
<a href="autofoldernest.html" class="tsd-signature-type">AutoFolderNest</a>
</li>
</ul>
</li>
</ul>
</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 tsd-is-overwrite"><a href="foldernest.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-inherited tsd-is-protected"><a href="foldernest.html#_id" class="tsd-kind-icon">_id</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="foldernest.html#_name" class="tsd-kind-icon">_name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="foldernest.html#_tunnel" class="tsd-kind-icon">_tunnel</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="foldernest.html#allowcreate" class="tsd-kind-icon">allow<wbr>Create</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="foldernest.html#e" class="tsd-kind-icon">e</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="foldernest.html#heldjobs" class="tsd-kind-icon">held<wbr>Jobs</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="foldernest.html#path" class="tsd-kind-icon">path</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="foldernest.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="foldernest.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="foldernest.html#tunnel" class="tsd-kind-icon">tunnel</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 tsd-is-overwrite"><a href="foldernest.html#arrive" class="tsd-kind-icon">arrive</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="foldernest.html#checkdirectorysync" class="tsd-kind-icon">check<wbr>Directory<wbr>Sync</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="foldernest.html#createjob" class="tsd-kind-icon">create<wbr>Job</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="foldernest.html#getheldjob" class="tsd-kind-icon">get<wbr>Held<wbr>Job</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="foldernest.html#getheldjobs" class="tsd-kind-icon">get<wbr>Held<wbr>Jobs</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="foldernest.html#getunwatchedjobs" class="tsd-kind-icon">get<wbr>Unwatched<wbr>Jobs</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="foldernest.html#holdjob" class="tsd-kind-icon">hold<wbr>Job</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="foldernest.html#isunixhiddenpath" class="tsd-kind-icon">is<wbr>Unix<wbr>Hidden<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="foldernest.html#load" class="tsd-kind-icon">load</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="foldernest.html#register" class="tsd-kind-icon">register</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="foldernest.html#take" class="tsd-kind-icon">take</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="foldernest.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="foldernest.html#watch" class="tsd-kind-icon">watch</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="foldernest.html#watchhold" class="tsd-kind-icon">watch<wbr>Hold</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 tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Folder<wbr>Nest<span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="environment.html" class="tsd-signature-type">Environment</a>, path<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, allowCreate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="foldernest.html" class="tsd-signature-type">FolderNest</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overwrites <a href="nest.html">Nest</a>.<a href="nest.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/folderNest.ts#L22">lib/nest/folderNest.ts:22</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><span class="tsd-flag ts-flagOptional">Optional</span> path: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> allowCreate: <span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="foldernest.html" class="tsd-signature-type">FolderNest</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-inherited tsd-is-protected">
<a name="_id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _id</h3>
<div class="tsd-signature tsd-kind-icon">_id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="nest.html">Nest</a>.<a href="nest.html#_id">_id</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/nest.ts#L12">lib/nest/nest.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited 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">
<p>Inherited from <a href="nest.html">Nest</a>.<a href="nest.html#_name">_name</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/nest.ts#L13">lib/nest/nest.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="_tunnel" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _tunnel</h3>
<div class="tsd-signature tsd-kind-icon">_tunnel<span class="tsd-signature-symbol">:</span> <a href="tunnel.html" class="tsd-signature-type">Tunnel</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="nest.html">Nest</a>.<a href="nest.html#_tunnel">_tunnel</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/nest.ts#L14">lib/nest/nest.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="allowcreate" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> allow<wbr>Create</h3>
<div class="tsd-signature tsd-kind-icon">allow<wbr>Create<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/folderNest.ts#L21">lib/nest/folderNest.ts:21</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited 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">
<p>Inherited from <a href="nest.html">Nest</a>.<a href="nest.html#e">e</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/nest.ts#L15">lib/nest/nest.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="heldjobs" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> held<wbr>Jobs</h3>
<div class="tsd-signature tsd-kind-icon">held<wbr>Jobs<span class="tsd-signature-symbol">:</span> <a href="filejob.html" class="tsd-signature-type">FileJob</a><span class="tsd-signature-symbol"> | </span><a href="folderjob.html" class="tsd-signature-type">FolderJob</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/folderNest.ts#L22">lib/nest/folderNest.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="path" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> path</h3>
<div class="tsd-signature tsd-kind-icon">path<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/nest/folderNest.ts#L20">lib/nest/folderNest.ts:20</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3>id</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> id<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">
<p>Inherited from <a href="nest.html">Nest</a>.<a href="nest.html#id">id</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/nest.ts#L23">lib/nest/nest.ts:23</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-accessor tsd-parent-kind-class tsd-is-inherited">
<a name="name" class="tsd-anchor"></a>
<h3>name</h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<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">
<p>Inherited from <a href="nest.html">Nest</a>.<a href="nest.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/nest.ts#L31">lib/nest/nest.ts:31</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">
<p>Inherited from <a href="nest.html">Nest</a>.<a href="nest.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/nest.ts#L35">lib/nest/nest.ts:35</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 tsd-is-inherited">
<a name="tunnel" class="tsd-anchor"></a>
<h3>tunnel</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> tunnel<span class="tsd-signature-symbol">(</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">
<p>Inherited from <a href="nest.html">Nest</a>.<a href="nest.html#tunnel">tunnel</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/nest.ts#L39">lib/nest/nest.ts:39</a></li>
</ul>
</aside>
<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 ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="arrive" class="tsd-anchor"></a>
<h3>arrive</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">arrive<span class="tsd-signature-symbol">(</span>job<span class="tsd-signature-symbol">: </span><a href="filejob.html" class="tsd-signature-type">FileJob</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">
<p>Overwrites <a href="nest.html">Nest</a>.<a href="nest.html#arrive">arrive</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/folderNest.ts#L165">lib/nest/folderNest.ts:165</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Arrive function that calls the super.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>job: <a href="filejob.html" class="tsd-signature-type">FileJob</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="checkdirectorysync" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> check<wbr>Directory<wbr>Sync</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">check<wbr>Directory<wbr>Sync<span class="tsd-signature-symbol">(</span>directory<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/nest/folderNest.ts#L38">lib/nest/folderNest.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check if the _path for the backing folder is created. If not, optionally create it.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>directory: <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 tsd-is-protected">
<a name="createjob" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> create<wbr>Job</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">create<wbr>Job<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, arrive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/nest/folderNest.ts#L58">lib/nest/folderNest.ts:58</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Function that creates and arrives new jobs. Can produce file or folder jobs.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>path: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> arrive: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getheldjob" class="tsd-anchor"></a>
<h3>get<wbr>Held<wbr>Job</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Held<wbr>Job<span class="tsd-signature-symbol">(</span>jobId<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">any</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/nest/folderNest.ts#L249">lib/nest/folderNest.ts:249</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a held job with a job id. Removes it from the held job queue,
so you should move it out of the folder after using this.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>jobId: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
<h4 id="example">Example</h4>
<pre><code class="lang-js"><span class="hljs-keyword">var</span> tunnel = af.createTunnel(<span class="hljs-string">"Checkpoint example"</span>);
<span class="hljs-keyword">var</span> webhook = af.createWebhookNest([<span class="hljs-string">"test"</span>, <span class="hljs-string">"example"</span>], <span class="hljs-string">"get"</span>);
<span class="hljs-keyword">var</span> holding_folder = af.createAutoFolderNest([<span class="hljs-string">"test"</span>, <span class="hljs-string">"checkpoint"</span>]);
<span class="hljs-keyword">var</span> im = webhook.getInterfaceManager();
<span class="hljs-comment">// Watch for jobs, hold, and provide to the interface.</span>
im.checkNest(holding_folder);
tunnel.watch(webhook);
tunnel.run(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">job, nest</span>)</span>{
<span class="hljs-comment">// Get the job_id from the webhook request</span>
<span class="hljs-keyword">var</span> job_id = job.getParameter(<span class="hljs-string">"job_id"</span>);
<span class="hljs-comment">// Get the held job from the holding folder</span>
<span class="hljs-keyword">var</span> checkpoint_job = holding_folder.getHeldJob(job_id);
<span class="hljs-comment">// Move somewhere else</span>
checkpoint_job.move(af.createAutoFolderNest([<span class="hljs-string">"test"</span>, <span class="hljs-string">"outfolder"</span>]));
});
</code></pre>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getheldjobs" class="tsd-anchor"></a>
<h3>get<wbr>Held<wbr>Jobs</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Held<wbr>Jobs<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="filejob.html" class="tsd-signature-type">FileJob</a><span class="tsd-signature-symbol"> | </span><a href="folderjob.html" class="tsd-signature-type">FolderJob</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/nest/folderNest.ts#L210">lib/nest/folderNest.ts:210</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns all held jobs.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="filejob.html" class="tsd-signature-type">FileJob</a><span class="tsd-signature-symbol"> | </span><a href="folderjob.html" class="tsd-signature-type">FolderJob</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getunwatchedjobs" class="tsd-anchor"></a>
<h3>get<wbr>Unwatched<wbr>Jobs</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Unwatched<wbr>Jobs<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/nest/folderNest.ts#L189">lib/nest/folderNest.ts:189</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Loads jobs that have piled up in the nest if it was not watched.
No longer used.</p>
</div>
</div>
<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>
<p>Array of jobs</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="holdjob" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> hold<wbr>Job</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">hold<wbr>Job<span class="tsd-signature-symbol">(</span>job<span class="tsd-signature-symbol">: </span><a href="filejob.html" class="tsd-signature-type">FileJob</a><span class="tsd-signature-symbol"> | </span><a href="folderjob.html" class="tsd-signature-type">FolderJob</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/nest/folderNest.ts#L218">lib/nest/folderNest.ts:218</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Adds job to array of held jobs.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>job: <a href="filejob.html" class="tsd-signature-type">FileJob</a><span class="tsd-signature-symbol"> | </span><a href="folderjob.html" class="tsd-signature-type">FolderJob</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="isunixhiddenpath" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> is<wbr>Unix<wbr>Hidden<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">is<wbr>Unix<wbr>Hidden<wbr>Path<span class="tsd-signature-symbol">(</span>path<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">boolean</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/nest/folderNest.ts#L99">lib/nest/folderNest.ts:99</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Checks whether a _path starts with or contains a hidden file or a folder.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>path: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The _path of the file that needs to be validated.
returns {boolean} - <code>true</code> if the source is blacklisted and otherwise <code>false</code>.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="load" class="tsd-anchor"></a>
<h3>load</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>hold<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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/nest/folderNest.ts#L107">lib/nest/folderNest.ts:107</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Initial load of the contents of the directory.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> hold: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
<div class="tsd-comment tsd-typography">
<p>Optional flag to hold jobs found.</p>
</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-inherited">
<a name="register" class="tsd-anchor"></a>
<h3>register</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">register<span class="tsd-signature-symbol">(</span>tunnel<span class="tsd-signature-symbol">: </span><a href="tunnel.html" class="tsd-signature-type">Tunnel</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">
<p>Inherited from <a href="nest.html">Nest</a>.<a href="nest.html#register">register</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/nest.ts#L43">lib/nest/nest.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tunnel: <a href="tunnel.html" class="tsd-signature-type">Tunnel</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="take" class="tsd-anchor"></a>
<h3>take</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">take<span class="tsd-signature-symbol">(</span>job<span class="tsd-signature-symbol">: </span><a href="filejob.html" class="tsd-signature-type">FileJob</a>, 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/nest/folderNest.ts#L174">lib/nest/folderNest.ts:174</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Picks up a job from another nest.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>job: <a href="filejob.html" class="tsd-signature-type">FileJob</a></h5>
</li>
<li>
<h5>callback: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>Callback is given the job in its parameter.</p>
</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-inherited">
<a name="tostring" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<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">
<p>Inherited from <a href="nest.html">Nest</a>.<a href="nest.html#tostring">toString</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/nest.ts#L27">lib/nest/nest.ts:27</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>hold<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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/nest/folderNest.ts#L131">lib/nest/folderNest.ts:131</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Watches the folder.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> hold: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
<div class="tsd-comment tsd-typography">
<p>Optional flag to hold jobs found.</p>
</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="watchhold" class="tsd-anchor"></a>
<h3>watch<wbr>Hold</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">watch<wbr>Hold<span class="tsd-signature-symbol">(</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/nest/folderNest.ts#L155">lib/nest/folderNest.ts:155</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Watches and holds jobs found.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</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="foldernest.html" class="tsd-kind-icon">Folder<wbr>Nest</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="foldernest.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="foldernest.html#_id" class="tsd-kind-icon">_id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="foldernest.html#_name" class="tsd-kind-icon">_name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="foldernest.html#_tunnel" class="tsd-kind-icon">_tunnel</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="foldernest.html#allowcreate" class="tsd-kind-icon">allow<wbr>Create</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="foldernest.html#e" class="tsd-kind-icon">e</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="foldernest.html#heldjobs" class="tsd-kind-icon">held<wbr>Jobs</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="foldernest.html#path" class="tsd-kind-icon">path</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="foldernest.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<a href="foldernest.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="foldernest.html#tunnel" class="tsd-kind-icon">tunnel</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="foldernest.html#arrive" class="tsd-kind-icon">arrive</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="foldernest.html#checkdirectorysync" class="tsd-kind-icon">check<wbr>Directory<wbr>Sync</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="foldernest.html#createjob" class="tsd-kind-icon">create<wbr>Job</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="foldernest.html#getheldjob" class="tsd-kind-icon">get<wbr>Held<wbr>Job</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="foldernest.html#getheldjobs" class="tsd-kind-icon">get<wbr>Held<wbr>Jobs</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="foldernest.html#getunwatchedjobs" class="tsd-kind-icon">get<wbr>Unwatched<wbr>Jobs</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="foldernest.html#holdjob" class="tsd-kind-icon">hold<wbr>Job</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="foldernest.html#isunixhiddenpath" class="tsd-kind-icon">is<wbr>Unix<wbr>Hidden<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="foldernest.html#load" class="tsd-kind-icon">load</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="foldernest.html#register" class="tsd-kind-icon">register</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="foldernest.html#take" class="tsd-kind-icon">take</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="foldernest.html#tostring" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="foldernest.html#watch" class="tsd-kind-icon">watch</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="foldernest.html#watchhold" class="tsd-kind-icon">watch<wbr>Hold</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>