antfarm
Version:
File automation framework for ants.
699 lines • 43.2 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>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>
</ul>
<h1> Antfarm 🐜</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<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>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class"><a href="classes/antfarm.html" class="tsd-kind-icon">Antfarm</a></li>
<li class="tsd-kind-class"><a href="classes/autofoldernest.html" class="tsd-kind-icon">Auto<wbr>Folder<wbr>Nest</a></li>
<li class="tsd-kind-class"><a href="classes/emailoptions.html" class="tsd-kind-icon">Email<wbr>Options</a></li>
<li class="tsd-kind-class"><a href="classes/emailer.html" class="tsd-kind-icon">Emailer</a></li>
<li class="tsd-kind-class"><a href="classes/environment.html" class="tsd-kind-icon">Environment</a></li>
<li class="tsd-kind-class"><a href="classes/file.html" class="tsd-kind-icon">File</a></li>
<li class="tsd-kind-class"><a href="classes/filejob.html" class="tsd-kind-icon">File<wbr>Job</a></li>
<li class="tsd-kind-class"><a href="classes/folderjob.html" class="tsd-kind-icon">Folder<wbr>Job</a></li>
<li class="tsd-kind-class"><a href="classes/foldernest.html" class="tsd-kind-icon">Folder<wbr>Nest</a></li>
<li class="tsd-kind-class"><a href="classes/ftpfilejob.html" class="tsd-kind-icon">Ftp<wbr>File<wbr>Job</a></li>
<li class="tsd-kind-class"><a href="classes/ftpnest.html" class="tsd-kind-icon">Ftp<wbr>Nest</a></li>
<li class="tsd-kind-class"><a href="classes/interfacemanager.html" class="tsd-kind-icon">Interface<wbr>Manager</a></li>
<li class="tsd-kind-class"><a href="classes/job.html" class="tsd-kind-icon">Job</a></li>
<li class="tsd-kind-class"><a href="classes/jobproperty.html" class="tsd-kind-icon">Job<wbr>Property</a></li>
<li class="tsd-kind-class"><a href="classes/lifeevent.html" class="tsd-kind-icon">Life<wbr>Event</a></li>
<li class="tsd-kind-class"><a href="classes/logger.html" class="tsd-kind-icon">Logger</a></li>
<li class="tsd-kind-class"><a href="classes/nest.html" class="tsd-kind-icon">Nest</a></li>
<li class="tsd-kind-class"><a href="classes/packedjob.html" class="tsd-kind-icon">Packed<wbr>Job</a></li>
<li class="tsd-kind-class"><a href="classes/s3filejob.html" class="tsd-kind-icon">S3<wbr>File<wbr>Job</a></li>
<li class="tsd-kind-class"><a href="classes/s3nest.html" class="tsd-kind-icon">S3<wbr>Nest</a></li>
<li class="tsd-kind-class"><a href="classes/server.html" class="tsd-kind-icon">Server</a></li>
<li class="tsd-kind-class"><a href="classes/step.html" class="tsd-kind-icon">Step</a></li>
<li class="tsd-kind-class"><a href="classes/tunnel.html" class="tsd-kind-icon">Tunnel</a></li>
<li class="tsd-kind-class"><a href="classes/webhookinterface.html" class="tsd-kind-icon">Webhook<wbr>Interface</a></li>
<li class="tsd-kind-class"><a href="classes/webhookjob.html" class="tsd-kind-icon">Webhook<wbr>Job</a></li>
<li class="tsd-kind-class"><a href="classes/webhooknest.html" class="tsd-kind-icon">Webhook<wbr>Nest</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface"><a href="interfaces/antfarmoptions.html" class="tsd-kind-icon">Antfarm<wbr>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/emailcredentials.html" class="tsd-kind-icon">Email<wbr>Credentials</a></li>
<li class="tsd-kind-interface"><a href="interfaces/fieldoptions.html" class="tsd-kind-icon">Field<wbr>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/interfacemetadata.html" class="tsd-kind-icon">Interface<wbr>Metadata</a></li>
<li class="tsd-kind-interface"><a href="interfaces/interfaceproperty.html" class="tsd-kind-icon">Interface<wbr>Property</a></li>
<li class="tsd-kind-interface"><a href="interfaces/logqueryoptions.html" class="tsd-kind-icon">Log<wbr>Query<wbr>Options</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-not-exported">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#aws" class="tsd-kind-icon">AWS</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#easyftp" class="tsd-kind-icon">Easy<wbr>Ftp</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#jszip" class="tsd-kind-icon">JSZip</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#reflect" class="tsd-kind-icon">Reflect</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#_" class="tsd-kind-icon">_</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#async" class="tsd-kind-icon">async</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#clone" class="tsd-kind-icon">clone</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#cors" class="tsd-kind-icon">cors</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#fileextension" class="tsd-kind-icon">file<wbr>Extension</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#filesize" class="tsd-kind-icon">filesize</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#fs" class="tsd-kind-icon">fs</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#http" class="tsd-kind-icon">http</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#mime" class="tsd-kind-icon">mime</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#mkdirp" class="tsd-kind-icon">mkdirp</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#mm" class="tsd-kind-icon">mm</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#multer" class="tsd-kind-icon">multer</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#node_path" class="tsd-kind-icon">node_<wbr>path</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#node_watch" class="tsd-kind-icon">node_<wbr>watch</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#nodemailer" class="tsd-kind-icon">nodemailer</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#path" class="tsd-kind-icon">path</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#path_mod" class="tsd-kind-icon">path_<wbr>mod</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#pug" class="tsd-kind-icon">pug</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#shortid" class="tsd-kind-icon">shortid</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#tmp" class="tsd-kind-icon">tmp</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#url" class="tsd-kind-icon">url</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#winston" class="tsd-kind-icon">winston</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="aws" class="tsd-anchor"></a>
<h3>AWS</h3>
<div class="tsd-signature tsd-kind-icon">AWS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("aws-sdk")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/s3Nest.ts#L6">lib/nest/s3Nest.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="easyftp" class="tsd-anchor"></a>
<h3>Easy<wbr>Ftp</h3>
<div class="tsd-signature tsd-kind-icon">Easy<wbr>Ftp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("easy-ftp")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/ftpNest.ts#L5">lib/nest/ftpNest.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="jszip" class="tsd-anchor"></a>
<h3>JSZip</h3>
<div class="tsd-signature tsd-kind-icon">JSZip<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("jszip")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/packedJob.ts#L10">lib/job/packedJob.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="reflect" class="tsd-anchor"></a>
<h3>Reflect</h3>
<div class="tsd-signature tsd-kind-icon">Reflect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("reflect-metadata")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/packedJob.ts#L12">lib/job/packedJob.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="_" class="tsd-anchor"></a>
<h3>_</h3>
<div class="tsd-signature tsd-kind-icon">_<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("lodash")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/logger.ts#L5">lib/environment/logger.ts:5</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L13">lib/job/job.ts:13</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/webhookJob.ts#L10">lib/job/webhookJob.ts:10</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/webhookInterface.ts#L12">lib/ui/webhookInterface.ts:12</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L10">lib/ui/interfaceManager.ts:10</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/folderNest.ts#L12">lib/nest/folderNest.ts:12</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/s3Nest.ts#L7">lib/nest/s3Nest.ts:7</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/packedJob.ts#L11">lib/job/packedJob.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="async" class="tsd-anchor"></a>
<h3>async</h3>
<div class="tsd-signature tsd-kind-icon">async<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("async")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/server.ts#L12">lib/environment/server.ts:12</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/ftpNest.ts#L8">lib/nest/ftpNest.ts:8</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L8">lib/tunnel/tunnel.ts:8</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/s3Nest.ts#L8">lib/nest/s3Nest.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="clone" class="tsd-anchor"></a>
<h3>clone</h3>
<div class="tsd-signature tsd-kind-icon">clone<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("clone")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/webhookInterface.ts#L13">lib/ui/webhookInterface.ts:13</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L11">lib/ui/interfaceManager.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="cors" class="tsd-anchor"></a>
<h3>cors</h3>
<div class="tsd-signature tsd-kind-icon">cors<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("cors")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/server.ts#L8">lib/environment/server.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="fileextension" class="tsd-anchor"></a>
<h3>file<wbr>Extension</h3>
<div class="tsd-signature tsd-kind-icon">file<wbr>Extension<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("file-extension")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/file.ts#L4">lib/job/file.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="filesize" class="tsd-anchor"></a>
<h3>filesize</h3>
<div class="tsd-signature tsd-kind-icon">filesize<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("filesize")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/file.ts#L7">lib/job/file.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="fs" class="tsd-anchor"></a>
<h3>fs</h3>
<div class="tsd-signature tsd-kind-icon">fs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("fs")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/logger.ts#L3">lib/environment/logger.ts:3</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/file.ts#L6">lib/job/file.ts:6</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/webhookJob.ts#L6">lib/job/webhookJob.ts:6</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/folderJob.ts#L6">lib/job/folderJob.ts:6</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/environment.ts#L9">lib/environment/environment.ts:9</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/folderNest.ts#L8">lib/nest/folderNest.ts:8</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/ftpNest.ts#L7">lib/nest/ftpNest.ts:7</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/autoFolderNest.ts#L4">lib/nest/autoFolderNest.ts:4</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/s3Nest.ts#L9">lib/nest/s3Nest.ts:9</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/packedJob.ts#L8">lib/job/packedJob.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="http" class="tsd-anchor"></a>
<h3>http</h3>
<div class="tsd-signature tsd-kind-icon">http<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("http")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/webhookNest.ts#L8">lib/nest/webhookNest.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="mime" class="tsd-anchor"></a>
<h3>mime</h3>
<div class="tsd-signature tsd-kind-icon">mime<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("mime-types")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/file.ts#L3">lib/job/file.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="mkdirp" class="tsd-anchor"></a>
<h3>mkdirp</h3>
<div class="tsd-signature tsd-kind-icon">mkdirp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("mkdirp")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/folderNest.ts#L11">lib/nest/folderNest.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="mm" class="tsd-anchor"></a>
<h3>mm</h3>
<div class="tsd-signature tsd-kind-icon">mm<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("micromatch")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/tunnel/tunnel.ts#L9">lib/tunnel/tunnel.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="multer" class="tsd-anchor"></a>
<h3>multer</h3>
<div class="tsd-signature tsd-kind-icon">multer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("multer")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/server.ts#L9">lib/environment/server.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="node_path" class="tsd-anchor"></a>
<h3>node_<wbr>path</h3>
<div class="tsd-signature tsd-kind-icon">node_<wbr>path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("path")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/file.ts#L5">lib/job/file.ts:5</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/folderJob.ts#L5">lib/job/folderJob.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="node_watch" class="tsd-anchor"></a>
<h3>node_<wbr>watch</h3>
<div class="tsd-signature tsd-kind-icon">node_<wbr>watch<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("node-watch")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/folderNest.ts#L7">lib/nest/folderNest.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="nodemailer" class="tsd-anchor"></a>
<h3>nodemailer</h3>
<div class="tsd-signature tsd-kind-icon">nodemailer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("nodemailer")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/emailer.ts#L7">lib/environment/emailer.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="path" class="tsd-anchor"></a>
<h3>path</h3>
<div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("path")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/webhookJob.ts#L9">lib/job/webhookJob.ts:9</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/server.ts#L10">lib/environment/server.ts:10</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/packedJob.ts#L9">lib/job/packedJob.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="path_mod" class="tsd-anchor"></a>
<h3>path_<wbr>mod</h3>
<div class="tsd-signature tsd-kind-icon">path_<wbr>mod<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("path")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/folderNest.ts#L9">lib/nest/folderNest.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="pug" class="tsd-anchor"></a>
<h3>pug</h3>
<div class="tsd-signature tsd-kind-icon">pug<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("pug")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/emailer.ts#L8">lib/environment/emailer.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="shortid" class="tsd-anchor"></a>
<h3>shortid</h3>
<div class="tsd-signature tsd-kind-icon">shortid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("shortid")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/job.ts#L12">lib/job/job.ts:12</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/nest.ts#L5">lib/nest/nest.ts:5</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/webhookInterface.ts#L11">lib/ui/webhookInterface.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="tmp" class="tsd-anchor"></a>
<h3>tmp</h3>
<div class="tsd-signature tsd-kind-icon">tmp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("tmp")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/webhookJob.ts#L7">lib/job/webhookJob.ts:7</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/server.ts#L11">lib/environment/server.ts:11</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/folderNest.ts#L10">lib/nest/folderNest.ts:10</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/ftpFileJob.ts#L5">lib/job/ftpFileJob.ts:5</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/ftpNest.ts#L6">lib/nest/ftpNest.ts:6</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/nest/autoFolderNest.ts#L5">lib/nest/autoFolderNest.ts:5</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/s3FileJob.ts#L5">lib/job/s3FileJob.ts:5</a></li>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/packedJob.ts#L7">lib/job/packedJob.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="url" class="tsd-anchor"></a>
<h3>url</h3>
<div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("url")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/job/webhookJob.ts#L8">lib/job/webhookJob.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="winston" class="tsd-anchor"></a>
<h3>winston</h3>
<div class="tsd-signature tsd-kind-icon">winston<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("winston")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/logger.ts#L4">lib/environment/logger.ts:4</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals current ">
<a href="globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="classes/antfarm.html" class="tsd-kind-icon">Antfarm</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/autofoldernest.html" class="tsd-kind-icon">Auto<wbr>Folder<wbr>Nest</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/emailoptions.html" class="tsd-kind-icon">Email<wbr>Options</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/emailer.html" class="tsd-kind-icon">Emailer</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/environment.html" class="tsd-kind-icon">Environment</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/file.html" class="tsd-kind-icon">File</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/filejob.html" class="tsd-kind-icon">File<wbr>Job</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/folderjob.html" class="tsd-kind-icon">Folder<wbr>Job</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/foldernest.html" class="tsd-kind-icon">Folder<wbr>Nest</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/ftpfilejob.html" class="tsd-kind-icon">Ftp<wbr>File<wbr>Job</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/ftpnest.html" class="tsd-kind-icon">Ftp<wbr>Nest</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/interfacemanager.html" class="tsd-kind-icon">Interface<wbr>Manager</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/job.html" class="tsd-kind-icon">Job</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/jobproperty.html" class="tsd-kind-icon">Job<wbr>Property</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/lifeevent.html" class="tsd-kind-icon">Life<wbr>Event</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/logger.html" class="tsd-kind-icon">Logger</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/nest.html" class="tsd-kind-icon">Nest</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/packedjob.html" class="tsd-kind-icon">Packed<wbr>Job</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/s3filejob.html" class="tsd-kind-icon">S3<wbr>File<wbr>Job</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/s3nest.html" class="tsd-kind-icon">S3<wbr>Nest</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/server.html" class="tsd-kind-icon">Server</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/step.html" class="tsd-kind-icon">Step</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/tunnel.html" class="tsd-kind-icon">Tunnel</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/webhookinterface.html" class="tsd-kind-icon">Webhook<wbr>Interface</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/webhookjob.html" class="tsd-kind-icon">Webhook<wbr>Job</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/webhooknest.html" class="tsd-kind-icon">Webhook<wbr>Nest</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/antfarmoptions.html" class="tsd-kind-icon">Antfarm<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/emailcredentials.html" class="tsd-kind-icon">Email<wbr>Credentials</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/fieldoptions.html" class="tsd-kind-icon">Field<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/interfacemetadata.html" class="tsd-kind-icon">Interface<wbr>Metadata</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/interfaceproperty.html" class="tsd-kind-icon">Interface<wbr>Property</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/logqueryoptions.html" class="tsd-kind-icon">Log<wbr>Query<wbr>Options</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#aws" class="tsd-kind-icon">AWS</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#easyftp" class="tsd-kind-icon">Easy<wbr>Ftp</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#jszip" class="tsd-kind-icon">JSZip</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#reflect" class="tsd-kind-icon">Reflect</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#_" class="tsd-kind-icon">_</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#async" class="tsd-kind-icon">async</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#clone" class="tsd-kind-icon">clone</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#cors" class="tsd-kind-icon">cors</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#fileextension" class="tsd-kind-icon">file<wbr>Extension</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#filesize" class="tsd-kind-icon">filesize</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#fs" class="tsd-kind-icon">fs</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#http" class="tsd-kind-icon">http</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#mime" class="tsd-kind-icon">mime</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#mkdirp" class="tsd-kind-icon">mkdirp</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#mm" class="tsd-kind-icon">mm</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#multer" class="tsd-kind-icon">multer</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#node_path" class="tsd-kind-icon">node_<wbr>path</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#node_watch" class="tsd-kind-icon">node_<wbr>watch</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#nodemailer" class="tsd-kind-icon">nodemailer</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#path" class="tsd-kind-icon">path</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#path_mod" class="tsd-kind-icon">path_<wbr>mod</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#pug" class="tsd-kind-icon">pug</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#shortid" class="tsd-kind-icon">shortid</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#tmp" class="tsd-kind-icon">tmp</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#url" class="tsd-kind-icon">url</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#winston" class="tsd-kind-icon">winston</a>
</li>
</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>