antfarm
Version:
File automation framework for ants.
1,757 lines • 98.5 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FileJob | 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="filejob.html">FileJob</a>
</li>
</ul>
<h1>Class FileJob</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="job.html" class="tsd-signature-type">Job</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">FileJob</span>
<ul class="tsd-hierarchy">
<li>
<a href="ftpfilejob.html" class="tsd-signature-type">FtpFileJob</a>
</li>
<li>
<a href="s3filejob.html" class="tsd-signature-type">S3FileJob</a>
</li>
<li>
<a href="packedjob.html" class="tsd-signature-type">PackedJob</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="filejob.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="filejob.html#_file" class="tsd-kind-icon">_file</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="filejob.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="filejob.html#_lifecycle" class="tsd-kind-icon">_life<wbr>Cycle</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="filejob.html#_locallyavailable" class="tsd-kind-icon">_locally<wbr>Available</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="filejob.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="filejob.html#_nest" class="tsd-kind-icon">_nest</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="filejob.html#_properties" class="tsd-kind-icon">_properties</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="filejob.html#_tunnel" class="tsd-kind-icon">_tunnel</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="filejob.html#_type" class="tsd-kind-icon">_type</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="filejob.html#e" class="tsd-kind-icon">e</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="filejob.html#basename" class="tsd-kind-icon">basename</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="filejob.html#contenttype" class="tsd-kind-icon">content<wbr>Type</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="filejob.html#dirname" class="tsd-kind-icon">dirname</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="filejob.html#extension" class="tsd-kind-icon">extension</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="filejob.html#file" class="tsd-kind-icon">file</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#files" class="tsd-kind-icon">files</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#islocallyavailable" class="tsd-kind-icon">is<wbr>Locally<wbr>Available</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#lifecycle" class="tsd-kind-icon">life<wbr>Cycle</a></li>
<li class="tsd-kind-set-signature tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#locallyavailable" class="tsd-kind-icon">locally<wbr>Available</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-overwrite"><a href="filejob.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite"><a href="filejob.html#nameproper" class="tsd-kind-icon">name<wbr>Proper</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#nest" class="tsd-kind-icon">nest</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-overwrite"><a href="filejob.html#path" class="tsd-kind-icon">path</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#properties" class="tsd-kind-icon">properties</a></li>
<li class="tsd-kind-set-signature tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#propertyvalues" class="tsd-kind-icon">property<wbr>Values</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite"><a href="filejob.html#size" class="tsd-kind-icon">size</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite"><a href="filejob.html#sizebytes" class="tsd-kind-icon">size<wbr>Bytes</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#tunnel" class="tsd-kind-icon">tunnel</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#type" class="tsd-kind-icon">type</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-inherited tsd-is-protected"><a href="filejob.html#createlifeevent" class="tsd-kind-icon">create<wbr>Life<wbr>Event</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#email" class="tsd-kind-icon">email</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#fail" class="tsd-kind-icon">fail</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#getfile" class="tsd-kind-icon">get<wbr>File</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#getjson" class="tsd-kind-icon">getJSON</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#getproperty" class="tsd-kind-icon">get<wbr>Property</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#getpropertytype" class="tsd-kind-icon">get<wbr>Property<wbr>Type</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#getpropertyvalue" class="tsd-kind-icon">get<wbr>Property<wbr>Value</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="filejob.html#isfile" class="tsd-kind-icon">is<wbr>File</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="filejob.html#isfolder" class="tsd-kind-icon">is<wbr>Folder</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#log" class="tsd-kind-icon">log</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="filejob.html#move" class="tsd-kind-icon">move</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#pack" class="tsd-kind-icon">pack</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="filejob.html#remove" class="tsd-kind-icon">remove</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="filejob.html#rename" class="tsd-kind-icon">rename</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#setpropertyvalue" class="tsd-kind-icon">set<wbr>Property<wbr>Value</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#transfer" class="tsd-kind-icon">transfer</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="filejob.html#unpack" class="tsd-kind-icon">unpack</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>File<wbr>Job<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="filejob.html" class="tsd-signature-type">FileJob</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overwrites <a href="job.html">Job</a>.<a href="job.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/fileJob.ts#L7">lib/job/fileJob.ts:7</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>FileJob constructor.</p>
</div>
</div>
<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>path: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="filejob.html" class="tsd-signature-type">FileJob</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="_file" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _file</h3>
<div class="tsd-signature tsd-kind-icon">_file<span class="tsd-signature-symbol">:</span> <a href="file.html" class="tsd-signature-type">File</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/fileJob.ts#L7">lib/job/fileJob.ts:7</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="_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="job.html">Job</a>.<a href="job.html#_id">_id</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L23">lib/job/job.ts:23</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="_lifecycle" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _life<wbr>Cycle</h3>
<div class="tsd-signature tsd-kind-icon">_life<wbr>Cycle<span class="tsd-signature-symbol">:</span> <a href="lifeevent.html" class="tsd-signature-type">LifeEvent</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#_lifecycle">_lifeCycle</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L22">lib/job/job.ts:22</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="_locallyavailable" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _locally<wbr>Available</h3>
<div class="tsd-signature tsd-kind-icon">_locally<wbr>Available<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#_locallyavailable">_locallyAvailable</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L21">lib/job/job.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="_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="job.html">Job</a>.<a href="job.html#_name">_name</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L17">lib/job/job.ts:17</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="_nest" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _nest</h3>
<div class="tsd-signature tsd-kind-icon">_nest<span class="tsd-signature-symbol">:</span> <a href="nest.html" class="tsd-signature-type">Nest</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#_nest">_nest</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L19">lib/job/job.ts:19</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="_properties" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _properties</h3>
<div class="tsd-signature tsd-kind-icon">_properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#_properties">_properties</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L24">lib/job/job.ts:24</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="job.html">Job</a>.<a href="job.html#_tunnel">_tunnel</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L18">lib/job/job.ts:18</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="_type" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _type</h3>
<div class="tsd-signature tsd-kind-icon">_type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#_type">_type</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L25">lib/job/job.ts:25</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="job.html">Job</a>.<a href="job.html#e">e</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L20">lib/job/job.ts:20</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-get-signature tsd-parent-kind-class">
<a name="basename" class="tsd-anchor"></a>
<h3>basename</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> basename<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/job/fileJob.ts#L98">lib/job/fileJob.ts:98</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the file _basename.</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class">
<a name="contenttype" class="tsd-anchor"></a>
<h3>content<wbr>Type</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> contentType<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/job/fileJob.ts#L82">lib/job/fileJob.ts:82</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the file content type.</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class">
<a name="dirname" class="tsd-anchor"></a>
<h3>dirname</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> dirname<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/job/fileJob.ts#L48">lib/job/fileJob.ts:48</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the file directory _name.</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class">
<a name="extension" class="tsd-anchor"></a>
<h3>extension</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> extension<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/job/fileJob.ts#L90">lib/job/fileJob.ts:90</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the file extension.</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class">
<a name="file" class="tsd-anchor"></a>
<h3>file</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> file<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="file.html" class="tsd-signature-type">File</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/job/fileJob.ts#L24">lib/job/fileJob.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the file object.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="file.html" class="tsd-signature-type">File</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="files" class="tsd-anchor"></a>
<h3>files</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> files<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>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#files">files</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L411">lib/job/job.ts:411</a></li>
</ul>
</aside>
<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-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="job.html">Job</a>.<a href="job.html#id">id</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L116">lib/job/job.ts:116</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the ID.</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="islocallyavailable" class="tsd-anchor"></a>
<h3>is<wbr>Locally<wbr>Available</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> isLocallyAvailable<span class="tsd-signature-symbol">(</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">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#islocallyavailable">isLocallyAvailable</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L62">lib/job/job.ts:62</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check if job is locally available.</p>
</div>
</div>
<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-accessor tsd-parent-kind-class tsd-is-inherited">
<a name="lifecycle" class="tsd-anchor"></a>
<h3>life<wbr>Cycle</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> lifeCycle<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="lifeevent.html" class="tsd-signature-type">LifeEvent</a><span class="tsd-signature-symbol">></span></li>
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> lifeCycle<span class="tsd-signature-symbol">(</span>events<span class="tsd-signature-symbol">: </span><a href="lifeevent.html" class="tsd-signature-type">LifeEvent</a><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">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#lifecycle">lifeCycle</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L78">lib/job/job.ts:78</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the life cycle object.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="lifeevent.html" class="tsd-signature-type">LifeEvent</a><span class="tsd-signature-symbol">></span></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#lifecycle">lifeCycle</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L82">lib/job/job.ts:82</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the life cycle object.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>events: <a href="lifeevent.html" class="tsd-signature-type">LifeEvent</a><span class="tsd-signature-symbol">[]</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-set-signature tsd-parent-kind-class tsd-is-inherited">
<a name="locallyavailable" class="tsd-anchor"></a>
<h3>locally<wbr>Available</h3>
<ul class="tsd-signatures tsd-kind-set-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> locallyAvailable<span class="tsd-signature-symbol">(</span>available<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">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#locallyavailable">locallyAvailable</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L70">lib/job/job.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set if the job is locally available.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>available: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
</div>
</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-accessor tsd-parent-kind-class tsd-is-overwrite">
<a name="name" class="tsd-anchor"></a>
<h3>name</h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-overwrite">
<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>filename<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>Overwrites <a href="job.html">Job</a>.<a href="job.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/fileJob.ts#L32">lib/job/fileJob.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the file _name.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overwrites <a href="job.html">Job</a>.<a href="job.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/fileJob.ts#L73">lib/job/fileJob.ts:73</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set a new file _name.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>filename: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
</div>
</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-get-signature tsd-parent-kind-class tsd-is-overwrite">
<a name="nameproper" class="tsd-anchor"></a>
<h3>name<wbr>Proper</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> nameProper<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>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overwrites <a href="job.html">Job</a>.<a href="job.html#nameproper">nameProper</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/fileJob.ts#L40">lib/job/fileJob.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the file _name proper.</p>
</div>
</div>
<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-accessor tsd-parent-kind-class tsd-is-inherited">
<a name="nest" class="tsd-anchor"></a>
<h3>nest</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> nest<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="nest.html" class="tsd-signature-type">Nest</a></li>
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> nest<span class="tsd-signature-symbol">(</span>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">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#nest">nest</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L140">lib/job/job.ts:140</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the nest.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="nest.html" class="tsd-signature-type">Nest</a></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#nest">nest</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L132">lib/job/job.ts:132</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set the nest.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>nest: <a href="nest.html" class="tsd-signature-type">Nest</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
</div>
</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-accessor tsd-parent-kind-class tsd-is-overwrite">
<a name="path" class="tsd-anchor"></a>
<h3>path</h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> path<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> 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">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overwrites <a href="job.html">Job</a>.<a href="job.html#path">path</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/fileJob.ts#L56">lib/job/fileJob.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the file _path.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overwrites <a href="job.html">Job</a>.<a href="job.html#path">path</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/fileJob.ts#L64">lib/job/fileJob.ts:64</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set a new file _path.</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">
<div class="lead">
</div>
</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-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="properties" class="tsd-anchor"></a>
<h3>properties</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> properties<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>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#properties">properties</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L290">lib/job/job.ts:290</a></li>
</ul>
</aside>
<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-set-signature tsd-parent-kind-class tsd-is-inherited">
<a name="propertyvalues" class="tsd-anchor"></a>
<h3>property<wbr>Values</h3>
<ul class="tsd-signatures tsd-kind-set-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> propertyValues<span class="tsd-signature-symbol">(</span>properties<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Object</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="job.html">Job</a>.<a href="job.html#propertyvalues">propertyValues</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L274">lib/job/job.ts:274</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>properties: <span class="tsd-signature-type">Object</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-overwrite">
<a name="size" class="tsd-anchor"></a>
<h3>size</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> size<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>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overwrites <a href="job.html">Job</a>.<a href="job.html#size">size</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/fileJob.ts#L171">lib/job/fileJob.ts:171</a></li>
</ul>
</aside>
<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-get-signature tsd-parent-kind-class tsd-is-overwrite">
<a name="sizebytes" class="tsd-anchor"></a>
<h3>size<wbr>Bytes</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> sizeBytes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overwrites <a href="job.html">Job</a>.<a href="job.html#sizebytes">sizeBytes</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/fileJob.ts#L175">lib/job/fileJob.ts:175</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<a name="tunnel" class="tsd-anchor"></a>
<h3>tunnel</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> 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>
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> tunnel<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="job.html">Job</a>.<a href="job.html#tunnel">tunnel</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L156">lib/job/job.ts:156</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the tunnel.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="tunnel.html" class="tsd-signature-type">Tunnel</a></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#tunnel">tunnel</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L148">lib/job/job.ts:148</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set the tunnel.</p>
</div>
</div>
<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>
<div class="tsd-comment tsd-typography">
<div class="lead">
</div>
</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-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="type" class="tsd-anchor"></a>
<h3>type</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> type<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="job.html">Job</a>.<a href="job.html#type">type</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L46">lib/job/job.ts:46</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</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 tsd-is-inherited tsd-is-protected">
<a name="createlifeevent" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> create<wbr>Life<wbr>Event</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">create<wbr>Life<wbr>Event<span class="tsd-signature-symbol">(</span>verb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, start<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, finish<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="job.html">Job</a>.<a href="job.html#createlifeevent">createLifeEvent</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L92">lib/job/job.ts:92</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create a new life event.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>verb: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>start: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>finish: <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-inherited">
<a name="email" class="tsd-anchor"></a>
<h3>email</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">email<span class="tsd-signature-symbol">(</span>emailOptions<span class="tsd-signature-symbol">: </span><a href="emailoptions.html" class="tsd-signature-type">EmailOptions</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="job.html">Job</a>.<a href="job.html#email">email</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L245">lib/job/job.ts:245</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sends an email.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>emailOptions: <a href="emailoptions.html" class="tsd-signature-type">EmailOptions</a></h5>
<div class="tsd-comment tsd-typography">
<p>Email options</p>
<h4 id="sending-pug-template-email-example">Sending pug template email example</h4>
<pre><code class="lang-js"><span class="hljs-comment">// my_tunnel.js</span>
tunnel.run(<span class="hljs-function"><span class="hljs-keyword">function</span> (<span class="hljs-params">job, nest</span>) </span>{
job.email({
<span class="hljs-attr">subject</span>: <span class="hljs-string">"Test email from pug template"</span>,
<span class="hljs-attr">to</span>: <span class="hljs-string">"john.smith@example.com"</span>,
<span class="hljs-attr">template</span>: __dirname + <span class="hljs-string">"./template_files/my_email.pug"</span>
});
});
</code></pre>
<pre><code class="lang-js"><span class="hljs-comment">// template_files/my_email.pug</span>
h1=<span class="hljs-string">"Example email!"</span>
p=<span class="hljs-string">"Got job ID "</span> + job.getId()
</code></pre>
<h4 id="sending-plain-text-email">Sending plain-text email</h4>
<pre><code class="lang-js">tunnel.run(<span class="hljs-function"><span class="hljs-keyword">function</span> (<span class="hljs-params">job, nest</span>) </span>{
job.email({
<span class="hljs-attr">subject</span>: <span class="hljs-string">"Test email with hard-coded plain-text"</span>,
<span class="hljs-attr">to</span>: <span class="hljs-string">"john.smith@example.com"</span>,
<span class="hljs-attr">text</span>: <span class="hljs-string">"My email body!"</span>
});
});
</code></pre>
<h4 id="sending-html-email">Sending html email</h4>
<pre><code class="lang-js">tunnel.run(<span class="hljs-function"><span class="hljs-keyword">function</span> (<span class="hljs-params">job, nest</span>) </span>{
job.email({
<span class="hljs-attr">subject</span>: <span class="hljs-string">"Test email with hard-coded html"</span>,
<span class="hljs-attr">to</span>: <span class="hljs-string">"john.smith@example.com"</span>,
<span class="hljs-attr">html</span>: <span class="hljs-string">"<h1>My email body!</h1>"</span>
});
});
</code></pre>
</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="fail" class="tsd-anchor"></a>
<h3>fail</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">fail<span class="tsd-signature-symbol">(</span>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">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#fail">fail</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L164">lib/job/job.ts:164</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Function to call to fail a job while in a tunnel.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<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-inherited">
<a name="getfile" class="tsd-anchor"></a>
<h3>get<wbr>File</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>File<span class="tsd-signature-symbol">(</span>index<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">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#getfile">getFile</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L415">lib/job/job.ts:415</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>index: <span class="tsd-signature-type">any</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 tsd-is-inherited">
<a name="getjson" class="tsd-anchor"></a>
<h3>getJSON</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">getJSON<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>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#getjson">getJSON</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L376">lib/job/job.ts:376</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the job object as JSON with circular references removed.</p>
</div>
</div>
<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 tsd-is-inherited">
<a name="getproperty" class="tsd-anchor"></a>
<h3>get<wbr>Property</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Property<span class="tsd-signature-symbol">(</span>key<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="jobproperty.html" class="tsd-signature-type">JobProperty</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#getproperty">getProperty</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L286">lib/job/job.ts:286</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the entire job property object.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="jobproperty.html" class="tsd-signature-type">JobProperty</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getpropertytype" class="tsd-anchor"></a>
<h3>get<wbr>Property<wbr>Type</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Property<wbr>Type<span class="tsd-signature-symbol">(</span>key<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">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#getpropertytype">getPropertyType</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L322">lib/job/job.ts:322</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the type of a property.</p>
<h4 id="example">Example</h4>
</div>
<pre><code class="lang-js">job.setPropertyValue(<span class="hljs-string">"My Job Number"</span>, <span class="hljs-number">123456</span>);
<span class="hljs-built_in">console</span>.log(job.getPropertyType(<span class="hljs-string">"My Job Number"</span>));
<span class="hljs-comment">// "number"</span>
</code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</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 tsd-is-inherited">
<a name="getpropertyvalue" class="tsd-anchor"></a>
<h3>get<wbr>Property<wbr>Value</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Property<wbr>Value<span class="tsd-signature-symbol">(</span>key<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">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#getpropertyvalue">getPropertyValue</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L299">lib/job/job.ts:299</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the value of a property if it has been previously set.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</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 tsd-is-overwrite">
<a name="isfile" class="tsd-anchor"></a>
<h3>is<wbr>File</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">is<wbr>File<span class="tsd-signature-symbol">(</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">
<p>Overwrites <a href="job.html">Job</a>.<a href="job.html#isfile">isFile</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/fileJob.ts#L114">lib/job/fileJob.ts:114</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check if job is a file.</p>
</div>
</div>
<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 tsd-is-overwrite">
<a name="isfolder" class="tsd-anchor"></a>
<h3>is<wbr>Folder</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">is<wbr>Folder<span class="tsd-signature-symbol">(</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">
<p>Overwrites <a href="job.html">Job</a>.<a href="job.html#isfolder">isFolder</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/fileJob.ts#L106">lib/job/fileJob.ts:106</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check if job is a folder.</p>
</div>
</div>
<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 tsd-is-inherited">
<a name="log" class="tsd-anchor"></a>
<h3>log</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">log<span class="tsd-signature-symbol">(</span>level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, message<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="job.html">Job</a>.<a href="job.html#log">log</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L432">lib/job/job.ts:432</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Add a message to the log with this job as the actor.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>level: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>0 = debug, 1 = info, 2, = warning, 3 = error</p>
</div>
</li>
<li>
<h5>message: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Log message</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-overwrite">
<a name="move" class="tsd-anchor"></a>
<h3>move</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">move<span class="tsd-signature-symbol">(</span>destinationNest<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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">
<p>Overwrites <a href="job.html">Job</a>.<a href="job.html#move">move</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/fileJob.ts#L133">lib/job/fileJob.ts:133</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Moves a file to a nest. This is an asynchronous method which provides a callback on completion.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>destinationNest: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>The nest object the job will be sent to.</p>
</div>
</li>
<li>
<h5>callback: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>The callback provides the updated instance of the job. Depending on the nest it was sent to, it may have been cast to a new job type. This is helpful in case you need the remote _path to the job once it has been uploaded to S3, for example.</p>
<h4 id="example">Example</h4>
<pre><code class="lang-js">tunnel.run(<span class="hljs-function">(<span class="hljs-params">job, nest</span>) =></span> {
<span class="hljs-built_in">console</span>.log(<span class="hljs-string">"Found job "</span> + job.getName());
job.move(my_s3_bucket, (s3_job) => {
<span class="hljs-comment">// Uploaded</span>
<span class="hljs-built_in">console</span>.log(<span class="hljs-string">"Uploaded to "</span> + s3_job.getPath());
});
});
</code></pre>
</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="pack" class="tsd-anchor"></a>
<h3>pack</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">pack<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">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#pack">pack</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L342">lib/job/job.ts:342</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Packs the job instance and file together in a zip.
Returns a PackJob in the parameter of the callback.</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">
<h4 id="example">Example</h4>
<pre><code class="lang-js">job.pack(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">packJob</span>)</span>{
packJob.move(packed_folder_nest);
});
</code></pre>
</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="remove" class="tsd-anchor"></a>
<h3>remove</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">remove<span class="tsd-signature-symbol">(</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/job/fileJob.ts#L167">lib/job/fileJob.ts:167</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Deletes the local file.</p>
</div>
</div>
<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 tsd-is-overwrite">
<a name="rename" class="tsd-anchor"></a>
<h3>rename</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">rename<span class="tsd-signature-symbol">(</span>newName<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>Overwrites <a href="job.html">Job</a>.<a href="job.html#rename">rename</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/fileJob.ts#L157">lib/job/fileJob.ts:157</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Rename the job file to a new _name.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>newName: <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-inherited">
<a name="setpropertyvalue" class="tsd-anchor"></a>
<h3>set<wbr>Property<wbr>Value</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">set<wbr>Property<wbr>Value<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<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">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#setpropertyvalue">setPropertyValue</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L266">lib/job/job.ts:266</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Attach job specific data to the job instance.</p>
<h4 id="example">Example</h4>
</div>
<pre><code class="lang-js">job.setPropertyValue(<span class="hljs-string">"My Job Number"</span>, <span class="hljs-number">123456</span>);
<span class="hljs-built_in">console</span>.log(job.getPropertyValue(<span class="hljs-string">"My Job Number"</span>));
<span class="hljs-comment">// 123456</span>
</code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>value: <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-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="job.html">Job</a>.<a href="job.html#tostring">toString</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L54">lib/job/job.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Class _name for logging.</p>
</div>
</div>
<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 tsd-is-inherited">
<a name="transfer" class="tsd-anchor"></a>
<h3>transfer</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">transfer<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="job.html">Job</a>.<a href="job.html#transfer">transfer</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L180">lib/job/job.ts:180</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Transfer a job to another tunnel directly.</p>
</div>
</div>
<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>
<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-inherited">
<a name="unpack" class="tsd-anchor"></a>
<h3>unpack</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">unpack<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">
<p>Inherited from <a href="job.html">Job</a>.<a href="job.html#unpack">unpack</a></p>
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L363">lib/job/job.ts:363</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Unpacks a packed job. Returns a the original unpacked job in the parameter of the callback.</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">
<h4 id="example">Example</h4>
<pre><code class="lang-js">packedJob.unpack(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">unpackedJob</span>)</span>{
<span class="hljs-built_in">console</span>.log(<span class="hljs-string">"Unpacked"</span>, unpackedJob.name);
unpackedJob.move(unpacked_folder);
packedJob.remove();
});
</code></pre>
</div>
</li>
</ul>
<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="filejob.html" class="tsd-kind-icon">File<wbr>Job</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="filejob.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="filejob.html#_file" class="tsd-kind-icon">_file</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="filejob.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="filejob.html#_lifecycle" class="tsd-kind-icon">_life<wbr>Cycle</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="filejob.html#_locallyavailable" class="tsd-kind-icon">_locally<wbr>Available</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="filejob.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="filejob.html#_nest" class="tsd-kind-icon">_nest</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="filejob.html#_properties" class="tsd-kind-icon">_properties</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="filejob.html#_tunnel" class="tsd-kind-icon">_tunnel</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="filejob.html#_type" class="tsd-kind-icon">_type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="filejob.html#e" class="tsd-kind-icon">e</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="filejob.html#basename" class="tsd-kind-icon">basename</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="filejob.html#contenttype" class="tsd-kind-icon">content<wbr>Type</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="filejob.html#dirname" class="tsd-kind-icon">dirname</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="filejob.html#extension" class="tsd-kind-icon">extension</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="filejob.html#file" class="tsd-kind-icon">file</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#files" class="tsd-kind-icon">files</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#islocallyavailable" class="tsd-kind-icon">is<wbr>Locally<wbr>Available</a>
</li>
<li class=" tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#lifecycle" class="tsd-kind-icon">life<wbr>Cycle</a>
</li>
<li class=" tsd-kind-set-signature tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#locallyavailable" class="tsd-kind-icon">locally<wbr>Available</a>
</li>
<li class=" tsd-kind-accessor tsd-parent-kind-class tsd-is-overwrite">
<a href="filejob.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite">
<a href="filejob.html#nameproper" class="tsd-kind-icon">name<wbr>Proper</a>
</li>
<li class=" tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#nest" class="tsd-kind-icon">nest</a>
</li>
<li class=" tsd-kind-accessor tsd-parent-kind-class tsd-is-overwrite">
<a href="filejob.html#path" class="tsd-kind-icon">path</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#properties" class="tsd-kind-icon">properties</a>
</li>
<li class=" tsd-kind-set-signature tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#propertyvalues" class="tsd-kind-icon">property<wbr>Values</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite">
<a href="filejob.html#size" class="tsd-kind-icon">size</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite">
<a href="filejob.html#sizebytes" class="tsd-kind-icon">size<wbr>Bytes</a>
</li>
<li class=" tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#tunnel" class="tsd-kind-icon">tunnel</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="filejob.html#createlifeevent" class="tsd-kind-icon">create<wbr>Life<wbr>Event</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#email" class="tsd-kind-icon">email</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#fail" class="tsd-kind-icon">fail</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#getfile" class="tsd-kind-icon">get<wbr>File</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#getjson" class="tsd-kind-icon">getJSON</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#getproperty" class="tsd-kind-icon">get<wbr>Property</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#getpropertytype" class="tsd-kind-icon">get<wbr>Property<wbr>Type</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#getpropertyvalue" class="tsd-kind-icon">get<wbr>Property<wbr>Value</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="filejob.html#isfile" class="tsd-kind-icon">is<wbr>File</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="filejob.html#isfolder" class="tsd-kind-icon">is<wbr>Folder</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#log" class="tsd-kind-icon">log</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="filejob.html#move" class="tsd-kind-icon">move</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#pack" class="tsd-kind-icon">pack</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="filejob.html#remove" class="tsd-kind-icon">remove</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="filejob.html#rename" class="tsd-kind-icon">rename</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#setpropertyvalue" class="tsd-kind-icon">set<wbr>Property<wbr>Value</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#tostring" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#transfer" class="tsd-kind-icon">transfer</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="filejob.html#unpack" class="tsd-kind-icon">unpack</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>