antfarm
Version:
File automation framework for ants.
648 lines • 36.1 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Environment | 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="environment.html">Environment</a>
</li>
</ul>
<h1>Class Environment</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>The environment class controls all aspects of the antfarm environment, like options, logging,
and constructing globally referenced objects.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Environment</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="environment.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="environment.html#_emailer" class="tsd-kind-icon">_emailer</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="environment.html#_options" class="tsd-kind-icon">_options</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="environment.html#_server" class="tsd-kind-icon">_server</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="environment.html#hookinterfaceroutes" class="tsd-kind-icon">hook<wbr>Interface<wbr>Routes</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="environment.html#hookroutes" class="tsd-kind-icon">hook<wbr>Routes</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="environment.html#logger" class="tsd-kind-icon">logger</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="environment.html#automanagedfolderdirectory" class="tsd-kind-icon">auto<wbr>Managed<wbr>Folder<wbr>Directory</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="environment.html#emailer" class="tsd-kind-icon">emailer</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="environment.html#options" class="tsd-kind-icon">options</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="environment.html#server" class="tsd-kind-icon">server</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="environment.html#addwebhook" class="tsd-kind-icon">add<wbr>Webhook</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="environment.html#addwebhookinterface" class="tsd-kind-icon">add<wbr>Webhook<wbr>Interface</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="environment.html#createemailer" class="tsd-kind-icon">create<wbr>Emailer</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="environment.html#createserver" class="tsd-kind-icon">create<wbr>Server</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="environment.html#log" class="tsd-kind-icon">log</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="environment.html#tostring" class="tsd-kind-icon">to<wbr>String</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>Environment<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="environment.html" class="tsd-signature-type">Environment</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/environment/environment.ts#L22">lib/environment/environment.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>options: <a href="../interfaces/antfarmoptions.html" class="tsd-signature-type">AntfarmOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="environment.html" class="tsd-signature-type">Environment</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="_emailer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _emailer</h3>
<div class="tsd-signature tsd-kind-icon">_emailer<span class="tsd-signature-symbol">:</span> <a href="emailer.html" class="tsd-signature-type">Emailer</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/environment.ts#L20">lib/environment/environment.ts:20</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="_options" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _options</h3>
<div class="tsd-signature tsd-kind-icon">_options<span class="tsd-signature-symbol">:</span> <a href="../interfaces/antfarmoptions.html" class="tsd-signature-type">AntfarmOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/environment.ts#L17">lib/environment/environment.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="_server" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _server</h3>
<div class="tsd-signature tsd-kind-icon">_server<span class="tsd-signature-symbol">:</span> <a href="server.html" class="tsd-signature-type">Server</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/environment.ts#L19">lib/environment/environment.ts:19</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="hookinterfaceroutes" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> hook<wbr>Interface<wbr>Routes</h3>
<div class="tsd-signature tsd-kind-icon">hook<wbr>Interface<wbr>Routes<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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/environment.ts#L22">lib/environment/environment.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="hookroutes" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> hook<wbr>Routes</h3>
<div class="tsd-signature tsd-kind-icon">hook<wbr>Routes<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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/environment.ts#L21">lib/environment/environment.ts:21</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="logger" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> logger</h3>
<div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <a href="logger.html" class="tsd-signature-type">Logger</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/environment.ts#L18">lib/environment/environment.ts:18</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="automanagedfolderdirectory" class="tsd-anchor"></a>
<h3>auto<wbr>Managed<wbr>Folder<wbr>Directory</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> autoManagedFolderDirectory<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/environment/environment.ts#L82">lib/environment/environment.ts:82</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Return the auto managed folder directory, if set.</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="emailer" class="tsd-anchor"></a>
<h3>emailer</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> emailer<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="emailer.html" class="tsd-signature-type">Emailer</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/environment/environment.ts#L74">lib/environment/environment.ts:74</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="emailer.html" class="tsd-signature-type">Emailer</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
<a name="options" class="tsd-anchor"></a>
<h3>options</h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> options<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/antfarmoptions.html" class="tsd-signature-type">AntfarmOptions</a></li>
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> options<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><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/environment/environment.ts#L60">lib/environment/environment.ts:60</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the Antfarm options.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/antfarmoptions.html" class="tsd-signature-type">AntfarmOptions</a></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/environment.ts#L33">lib/environment/environment.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sets the options and creates other environmental objects if necessary.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>options: <a href="../interfaces/antfarmoptions.html" class="tsd-signature-type">AntfarmOptions</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">
<a name="server" class="tsd-anchor"></a>
<h3>server</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> server<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="server.html" class="tsd-signature-type">Server</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/environment/environment.ts#L97">lib/environment/environment.ts:97</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the server instance.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="server.html" class="tsd-signature-type">Server</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="addwebhook" class="tsd-anchor"></a>
<h3>add<wbr>Webhook</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">add<wbr>Webhook<span class="tsd-signature-symbol">(</span>nest<span class="tsd-signature-symbol">: </span><a href="webhooknest.html" class="tsd-signature-type">WebhookNest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/environment.ts#L105">lib/environment/environment.ts:105</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Adds a webhook to the webhook server.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>nest: <a href="webhooknest.html" class="tsd-signature-type">WebhookNest</a></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="addwebhookinterface" class="tsd-anchor"></a>
<h3>add<wbr>Webhook<wbr>Interface</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">add<wbr>Webhook<wbr>Interface<span class="tsd-signature-symbol">(</span>im<span class="tsd-signature-symbol">: </span><a href="interfacemanager.html" class="tsd-signature-type">InterfaceManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/environment.ts#L114">lib/environment/environment.ts:114</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Adds a webhook interface to the webhook server.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>im: <a href="interfacemanager.html" class="tsd-signature-type">InterfaceManager</a></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="createemailer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> create<wbr>Emailer</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">create<wbr>Emailer<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/environment/environment.ts#L67">lib/environment/environment.ts:67</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates an Emailer object to send emails.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="createserver" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> create<wbr>Server</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">create<wbr>Server<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/environment/environment.ts#L89">lib/environment/environment.ts:89</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates the server.</p>
</div>
</div>
<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/environment/environment.ts#L134">lib/environment/environment.ts:134</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Adds a log entry to the Logger instance.</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="tostring" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/environment.ts#L119">lib/environment/environment.ts:119</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="environment.html" class="tsd-kind-icon">Environment</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="environment.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="environment.html#_emailer" class="tsd-kind-icon">_emailer</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="environment.html#_options" class="tsd-kind-icon">_options</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="environment.html#_server" class="tsd-kind-icon">_server</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="environment.html#hookinterfaceroutes" class="tsd-kind-icon">hook<wbr>Interface<wbr>Routes</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="environment.html#hookroutes" class="tsd-kind-icon">hook<wbr>Routes</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="environment.html#logger" class="tsd-kind-icon">logger</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="environment.html#automanagedfolderdirectory" class="tsd-kind-icon">auto<wbr>Managed<wbr>Folder<wbr>Directory</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="environment.html#emailer" class="tsd-kind-icon">emailer</a>
</li>
<li class=" tsd-kind-accessor tsd-parent-kind-class">
<a href="environment.html#options" class="tsd-kind-icon">options</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="environment.html#server" class="tsd-kind-icon">server</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="environment.html#addwebhook" class="tsd-kind-icon">add<wbr>Webhook</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="environment.html#addwebhookinterface" class="tsd-kind-icon">add<wbr>Webhook<wbr>Interface</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="environment.html#createemailer" class="tsd-kind-icon">create<wbr>Emailer</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="environment.html#createserver" class="tsd-kind-icon">create<wbr>Server</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="environment.html#log" class="tsd-kind-icon">log</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="environment.html#tostring" class="tsd-kind-icon">to<wbr>String</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>