antfarm
Version:
File automation framework for ants.
655 lines • 36.2 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Server | 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="server.html">Server</a>
</li>
</ul>
<h1>Class Server</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>Webhook and logging server.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Server</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="server.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="server.html#e" class="tsd-kind-icon">e</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="server.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="server.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="server.html#server-1" class="tsd-kind-icon">server</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="server.html#upload" class="tsd-kind-icon">upload</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="server.html#addwebhook" class="tsd-kind-icon">add<wbr>Webhook</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="server.html#addwebhookinterface" class="tsd-kind-icon">add<wbr>Webhook<wbr>Interface</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="server.html#createlogserver" class="tsd-kind-icon">create<wbr>Log<wbr>Server</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="server.html#createserver" class="tsd-kind-icon">create<wbr>Server</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="server.html#handlehookinterfacerequest" class="tsd-kind-icon">handle<wbr>Hook<wbr>Interface<wbr>Request</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="server.html#handlehookrequest" class="tsd-kind-icon">handle<wbr>Hook<wbr>Request</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="server.html#sendhookresponse" class="tsd-kind-icon">send<wbr>Hook<wbr>Response</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="server.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private-protected">
<h3>Object literals</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-object-literal tsd-parent-kind-class tsd-is-protected"><a href="server.html#config" class="tsd-kind-icon">config</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>Server<span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="environment.html" class="tsd-signature-type">Environment</a><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/server.ts#L29">lib/environment/server.ts:29</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>e: <a href="environment.html" class="tsd-signature-type">Environment</a></h5>
</li>
</ul>
<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 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/environment/server.ts#L20">lib/environment/server.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="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/server.ts#L22">lib/environment/server.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/server.ts#L21">lib/environment/server.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="server-1" 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> <span class="tsd-signature-type">express.Application</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/server.ts#L19">lib/environment/server.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="upload" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> upload</h3>
<div class="tsd-signature tsd-kind-icon">upload<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/server.ts#L23">lib/environment/server.ts:23</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="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/server.ts#L110">lib/environment/server.ts:110</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Adds a webhook to the 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/server.ts#L195">lib/environment/server.ts:195</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">
<a name="createlogserver" class="tsd-anchor"></a>
<h3>create<wbr>Log<wbr>Server</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">create<wbr>Log<wbr>Server<span class="tsd-signature-symbol">(</span>logger<span class="tsd-signature-symbol">: </span><a href="logger.html" class="tsd-signature-type">Logger</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/server.ts#L80">lib/environment/server.ts:80</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>logger: <a href="logger.html" class="tsd-signature-type">Logger</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class 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/server.ts#L54">lib/environment/server.ts:54</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 tsd-is-protected">
<a name="handlehookinterfacerequest" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> handle<wbr>Hook<wbr>Interface<wbr>Request</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">handle<wbr>Hook<wbr>Interface<wbr>Request<span class="tsd-signature-symbol">(</span>im<span class="tsd-signature-symbol">: </span><a href="interfacemanager.html" class="tsd-signature-type">InterfaceManager</a>, req<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, customHandler<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/server.ts#L227">lib/environment/server.ts:227</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Handles request and response of the web hook interface.</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>
</li>
<li>
<h5>req: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>res: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> customHandler: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Custom request handler.</p>
</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-method tsd-parent-kind-class tsd-is-protected">
<a name="handlehookrequest" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> handle<wbr>Hook<wbr>Request</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">handle<wbr>Hook<wbr>Request<span class="tsd-signature-symbol">(</span>nest<span class="tsd-signature-symbol">: </span><a href="webhooknest.html" class="tsd-signature-type">WebhookNest</a>, req<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, customHandler<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/server.ts#L148">lib/environment/server.ts:148</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Handles request and response of the web hook, creates a new job, as well as calling the nest's arrive.</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>
</li>
<li>
<h5>req: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>res: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> customHandler: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>Custom request handler.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="sendhookresponse" class="tsd-anchor"></a>
<h3>send<wbr>Hook<wbr>Response</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">send<wbr>Hook<wbr>Response<span class="tsd-signature-symbol">(</span>holdResponse<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, job<span class="tsd-signature-symbol">: </span><a href="webhookjob.html" class="tsd-signature-type">WebhookJob</a>, nest<span class="tsd-signature-symbol">: </span><a href="webhooknest.html" class="tsd-signature-type">WebhookNest</a>, req<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, customHandler<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/server.ts#L169">lib/environment/server.ts:169</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sends the actual hook response.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>holdResponse: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>Flag to bypass sending now for held responses.</p>
</div>
</li>
<li>
<h5>job: <a href="webhookjob.html" class="tsd-signature-type">WebhookJob</a></h5>
<div class="tsd-comment tsd-typography">
<p>Webhook job</p>
</div>
</li>
<li>
<h5>nest: <a href="webhooknest.html" class="tsd-signature-type">WebhookNest</a></h5>
<div class="tsd-comment tsd-typography">
<p>Webhook nest</p>
</div>
</li>
<li>
<h5>req: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>res: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> customHandler: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> message: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<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/server.ts#L102">lib/environment/server.ts:102</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Log _name</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private-protected">
<h2>Object literals</h2>
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-class tsd-is-protected">
<a name="config" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> config</h3>
<div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/server.ts#L25">lib/environment/server.ts:25</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="config.hooks_prefix" class="tsd-anchor"></a>
<h3>hooks_<wbr>prefix</h3>
<div class="tsd-signature tsd-kind-icon">hooks_<wbr>prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "/hooks"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/server.ts#L26">lib/environment/server.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="config.hooks_ui_prefix" class="tsd-anchor"></a>
<h3>hooks_<wbr>ui_<wbr>prefix</h3>
<div class="tsd-signature tsd-kind-icon">hooks_<wbr>ui_<wbr>prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "/hooks-ui"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/server.ts#L27">lib/environment/server.ts:27</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="config.log_prefix" class="tsd-anchor"></a>
<h3>log_<wbr>prefix</h3>
<div class="tsd-signature tsd-kind-icon">log_<wbr>prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "/log"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/environment/server.ts#L28">lib/environment/server.ts:28</a></li>
</ul>
</aside>
</section>
</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="server.html" class="tsd-kind-icon">Server</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="server.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="server.html#e" class="tsd-kind-icon">e</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="server.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="server.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="server.html#server-1" class="tsd-kind-icon">server</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="server.html#upload" class="tsd-kind-icon">upload</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="server.html#addwebhook" class="tsd-kind-icon">add<wbr>Webhook</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="server.html#addwebhookinterface" class="tsd-kind-icon">add<wbr>Webhook<wbr>Interface</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="server.html#createlogserver" class="tsd-kind-icon">create<wbr>Log<wbr>Server</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="server.html#createserver" class="tsd-kind-icon">create<wbr>Server</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="server.html#handlehookinterfacerequest" class="tsd-kind-icon">handle<wbr>Hook<wbr>Interface<wbr>Request</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="server.html#handlehookrequest" class="tsd-kind-icon">handle<wbr>Hook<wbr>Request</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="server.html#sendhookresponse" class="tsd-kind-icon">send<wbr>Hook<wbr>Response</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="server.html#tostring" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-object-literal tsd-parent-kind-class tsd-is-protected">
<a href="server.html#config" class="tsd-kind-icon">config</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>