antfarm
Version:
File automation framework for ants.
659 lines • 36.9 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Antfarm | 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="antfarm.html">Antfarm</a>
</li>
</ul>
<h1>Class Antfarm</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Expose <code>Antfarm</code>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Antfarm</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="antfarm.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="antfarm.html#e" class="tsd-kind-icon">e</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="antfarm.html#createautofoldernest" class="tsd-kind-icon">create<wbr>Auto<wbr>Folder<wbr>Nest</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="antfarm.html#createfoldernest" class="tsd-kind-icon">create<wbr>Folder<wbr>Nest</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="antfarm.html#createftpnest" class="tsd-kind-icon">create<wbr>Ftp<wbr>Nest</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="antfarm.html#creates3nest" class="tsd-kind-icon">create<wbr>S3Nest</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="antfarm.html#createtunnel" class="tsd-kind-icon">create<wbr>Tunnel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="antfarm.html#createwebhooknest" class="tsd-kind-icon">create<wbr>Webhook<wbr>Nest</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="antfarm.html#loaddir" class="tsd-kind-icon">load<wbr>Dir</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="antfarm.html#log" class="tsd-kind-icon">log</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="antfarm.html#version" class="tsd-kind-icon">version</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Antfarm<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/antfarmoptions.html" class="tsd-signature-type">AntfarmOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="antfarm.html" class="tsd-signature-type">Antfarm</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/antfarm.ts#L19">lib/antfarm.ts:19</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Antfarm constructor</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/antfarmoptions.html" class="tsd-signature-type">AntfarmOptions</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Antfarm options</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="antfarm.html" class="tsd-signature-type">Antfarm</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="e" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> e</h3>
<div class="tsd-signature tsd-kind-icon">e<span class="tsd-signature-symbol">:</span> <a href="environment.html" class="tsd-signature-type">Environment</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/antfarm.ts#L19">lib/antfarm.ts:19</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="createautofoldernest" class="tsd-anchor"></a>
<h3>create<wbr>Auto<wbr>Folder<wbr>Nest</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">create<wbr>Auto<wbr>Folder<wbr>Nest<span class="tsd-signature-symbol">(</span>hierarchy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><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-symbol">: </span><a href="autofoldernest.html" class="tsd-signature-type">AutoFolderNest</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/antfarm.ts#L73">lib/antfarm.ts:73</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Factory method which returns an AutoFolderNest. If the auto managed directory does not exist, it is created.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>hierarchy: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>Path of the folder as a string or an array of strings as _path segments.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="autofoldernest.html" class="tsd-signature-type">AutoFolderNest</a></h4>
<h4 id="example">Example</h4>
<pre><code class="lang-js">af.createAutoFolderNest(<span class="hljs-string">"outfolder"</span>)
<span class="hljs-comment">// /Users/dominick/My Automanaged Directory/outfolder</span>
</code></pre>
<h4 id="example">Example</h4>
<pre><code class="lang-js">af.createAutoFolderNest([<span class="hljs-string">"proofing"</span>, <span class="hljs-string">"others"</span>])
<span class="hljs-comment">// /Users/dominick/My Automanaged Directory/proofing/others</span>
</code></pre>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="createfoldernest" class="tsd-anchor"></a>
<h3>create<wbr>Folder<wbr>Nest</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">create<wbr>Folder<wbr>Nest<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, allowCreate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="foldernest.html" class="tsd-signature-type">FolderNest</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/antfarm.ts#L53">lib/antfarm.ts:53</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Factory method which returns a FolderNest.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> path: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Path of the folder.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> allowCreate: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
<div class="tsd-comment tsd-typography">
<p>Optional boolean flag to allow creation of folder if it does not exist.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="foldernest.html" class="tsd-signature-type">FolderNest</a></h4>
<h4 id="example">Example</h4>
<pre><code class="lang-js"><span class="hljs-keyword">var</span> out_folder = af.createFolderNest(<span class="hljs-string">"/Users/dominick/Desktop/My Folder/"</span>);
</code></pre>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="createftpnest" class="tsd-anchor"></a>
<h3>create<wbr>Ftp<wbr>Nest</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">create<wbr>Ftp<wbr>Nest<span class="tsd-signature-symbol">(</span>host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, port<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, username<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, checkEvery<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ftpnest.html" class="tsd-signature-type">FtpNest</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/antfarm.ts#L91">lib/antfarm.ts:91</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Factory method which returns an FtpNest.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>host: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Hostname or IP address of the FTP server.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> port: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 21</span></h5>
<div class="tsd-comment tsd-typography">
<p>Port number of the FTP server.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> username: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
<div class="tsd-comment tsd-typography">
<p>FTP account username.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> password: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
<div class="tsd-comment tsd-typography">
<p>FTP account password.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> checkEvery: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 10</span></h5>
<div class="tsd-comment tsd-typography">
<p>Frequency of re-checking FTP in minutes.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="ftpnest.html" class="tsd-signature-type">FtpNest</a></h4>
<h4 id="example">Example</h4>
<pre><code class="lang-js"><span class="hljs-comment">// Check FTP directory every 2 minutes</span>
<span class="hljs-keyword">var</span> my_ftp = af.createFtpNest(<span class="hljs-string">"ftp.example.com"</span>, <span class="hljs-number">21</span>, <span class="hljs-string">""</span>, <span class="hljs-string">""</span>, <span class="hljs-number">2</span>);
</code></pre>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="creates3nest" class="tsd-anchor"></a>
<h3>create<wbr>S3Nest</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">create<wbr>S3Nest<span class="tsd-signature-symbol">(</span>bucket<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, keyPrefix<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, checkEvery<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, allowCreation<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="s3nest.html" class="tsd-signature-type">S3Nest</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/antfarm.ts#L106">lib/antfarm.ts:106</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Factory method to create and return an S3 nest.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bucket: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> keyPrefix: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> checkEvery: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 5</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> allowCreation: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="s3nest.html" class="tsd-signature-type">S3Nest</a></h4>
<pre><code class="lang-js"><span class="hljs-keyword">var</span> bucket = af.createS3Nest(<span class="hljs-string">"my-bucket-_name"</span>, <span class="hljs-string">""</span>, <span class="hljs-number">1</span>, <span class="hljs-literal">true</span>);
</code></pre>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="createtunnel" class="tsd-anchor"></a>
<h3>create<wbr>Tunnel</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">create<wbr>Tunnel<span class="tsd-signature-symbol">(</span>name<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><a href="tunnel.html" class="tsd-signature-type">Tunnel</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/antfarm.ts#L39">lib/antfarm.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Factory method which returns a Tunnel.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="tunnel.html" class="tsd-signature-type">Tunnel</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="createwebhooknest" class="tsd-anchor"></a>
<h3>create<wbr>Webhook<wbr>Nest</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">create<wbr>Webhook<wbr>Nest<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-type">string</span><span class="tsd-signature-symbol">[]</span>, httpMethod<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, handleRequest<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><a href="webhooknest.html" class="tsd-signature-type">WebhookNest</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/antfarm.ts#L134">lib/antfarm.ts:134</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Factory method which returns a WebhookNest.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>path: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>The _path which is generated in the webhook's route. You can supply a string or array of strings.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> httpMethod: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "all"</span></h5>
<div class="tsd-comment tsd-typography">
<p>HTTP method for this webhook. Choose "all" for any HTTP method.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> handleRequest: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>Optional callback function to handle the request, for sending a custom response.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="webhooknest.html" class="tsd-signature-type">WebhookNest</a></h4>
<h4 id="example">Example</h4>
<pre><code class="lang-js"><span class="hljs-keyword">var</span> webhook = af.createWebhookNest([<span class="hljs-string">"proof"</span>, <span class="hljs-string">"create"</span>], <span class="hljs-string">"post"</span>);
</code></pre>
<h4 id="example-returning-custom-response">Example returning custom response</h4>
<pre><code class="lang-js"><span class="hljs-keyword">var</span> webhook = af.createWebhookNest([<span class="hljs-string">"proof"</span>, <span class="hljs-string">"create"</span>], <span class="hljs-string">"post"</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">req, res, job, nest</span>)</span>{
res.setHeader(<span class="hljs-string">"Content-Type"</span>, <span class="hljs-string">"application/json; charset=utf-8"</span>);
res.end(<span class="hljs-built_in">JSON</span>.stringify({
<span class="hljs-attr">job_name</span>: job.getName(),
<span class="hljs-attr">job_id</span>: job.getId(),
<span class="hljs-attr">message</span>: <span class="hljs-string">"Proof created!"</span>
}));
});
</code></pre>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="loaddir" class="tsd-anchor"></a>
<h3>load<wbr>Dir</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">load<wbr>Dir<span class="tsd-signature-symbol">(</span>directory<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/antfarm.ts#L146">lib/antfarm.ts:146</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Load an entire directory of workflow modules.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>directory: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Path to the workflow modules.</p>
<h4 id="example">Example</h4>
<pre><code class="lang-js">af.loadDir(<span class="hljs-string">"./workflows"</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">
<a name="log" class="tsd-anchor"></a>
<h3>log</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">log<span class="tsd-signature-symbol">(</span>type<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>, actor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, instances<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/antfarm.ts#L178">lib/antfarm.ts:178</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Log messages into the antfarm logger.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>type: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The log level. 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>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> actor: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>Instance which triggers the action being logged.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> instances: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = []</span></h5>
<div class="tsd-comment tsd-typography">
<p>Array of of other involved instances.</p>
<h4 id="example">Example</h4>
<pre><code class="lang-js">job.e.log(<span class="hljs-number">1</span>, <span class="hljs-string">`Transferred to Tunnel "<span class="hljs-subst">${tunnel.getName()}</span>".`</span>, job, [oldTunnel]);
</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="version" class="tsd-anchor"></a>
<h3>version</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">version<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/antfarm.ts#L30">lib/antfarm.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</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="antfarm.html" class="tsd-kind-icon">Antfarm</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="antfarm.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="antfarm.html#e" class="tsd-kind-icon">e</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="antfarm.html#createautofoldernest" class="tsd-kind-icon">create<wbr>Auto<wbr>Folder<wbr>Nest</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="antfarm.html#createfoldernest" class="tsd-kind-icon">create<wbr>Folder<wbr>Nest</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="antfarm.html#createftpnest" class="tsd-kind-icon">create<wbr>Ftp<wbr>Nest</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="antfarm.html#creates3nest" class="tsd-kind-icon">create<wbr>S3Nest</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="antfarm.html#createtunnel" class="tsd-kind-icon">create<wbr>Tunnel</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="antfarm.html#createwebhooknest" class="tsd-kind-icon">create<wbr>Webhook<wbr>Nest</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="antfarm.html#loaddir" class="tsd-kind-icon">load<wbr>Dir</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="antfarm.html#log" class="tsd-kind-icon">log</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="antfarm.html#version" class="tsd-kind-icon">version</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>