beenull/tor-router
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
tor-router/docs/global.html
Zachary Boyd eb95142b6a update docs
2018-09-25 12:53:29 -04:00

2105 lines
32 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Global - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ControlServer.html">ControlServer</a><ul class='methods'><li data-type='method'><a href="ControlServer.html#.instance_info">instance_info</a></li><li data-type='method'><a href="ControlServer.html#close">close</a></li><li data-type='method'><a href="ControlServer.html#createDNSServer">createDNSServer</a></li><li data-type='method'><a href="ControlServer.html#createHTTPServer">createHTTPServer</a></li><li data-type='method'><a href="ControlServer.html#createSOCKSServer">createSOCKSServer</a></li><li data-type='method'><a href="ControlServer.html#createTorPool">createTorPool</a></li><li data-type='method'><a href="ControlServer.html#listen">listen</a></li><li data-type='method'><a href="ControlServer.html#listenTcp">listenTcp</a></li><li data-type='method'><a href="ControlServer.html#listenWs">listenWs</a></li></ul></li><li><a href="DNSServer.html">DNSServer</a><ul class='methods'><li data-type='method'><a href="DNSServer.html#listen">listen</a></li></ul></li><li><a href="HTTPServer.html">HTTPServer</a><ul class='methods'><li data-type='method'><a href="HTTPServer.html#listen">listen</a></li></ul></li><li><a href="SOCKSServer.html">SOCKSServer</a><ul class='methods'><li data-type='method'><a href="SOCKSServer.html#listen">listen</a></li></ul></li><li><a href="TorPool.html">TorPool</a><ul class='methods'><li data-type='method'><a href="TorPool.html#add">add</a></li><li data-type='method'><a href="TorPool.html#add_instance_to_group">add_instance_to_group</a></li><li data-type='method'><a href="TorPool.html#add_instance_to_group_at">add_instance_to_group_at</a></li><li data-type='method'><a href="TorPool.html#add_instance_to_group_by_name">add_instance_to_group_by_name</a></li><li data-type='method'><a href="TorPool.html#create">create</a></li><li data-type='method'><a href="TorPool.html#create_instance">create_instance</a></li><li data-type='method'><a href="TorPool.html#exit">exit</a></li><li data-type='method'><a href="TorPool.html#get_config_at">get_config_at</a></li><li data-type='method'><a href="TorPool.html#get_config_by_name">get_config_by_name</a></li><li data-type='method'><a href="TorPool.html#instance_at">instance_at</a></li><li data-type='method'><a href="TorPool.html#instance_by_name">instance_by_name</a></li><li data-type='method'><a href="TorPool.html#instances_by_group">instances_by_group</a></li><li data-type='method'><a href="TorPool.html#new_identites">new_identites</a></li><li data-type='method'><a href="TorPool.html#new_identites_by_group">new_identites_by_group</a></li><li data-type='method'><a href="TorPool.html#new_identity_at">new_identity_at</a></li><li data-type='method'><a href="TorPool.html#new_identity_by_name">new_identity_by_name</a></li><li data-type='method'><a href="TorPool.html#next">next</a></li><li data-type='method'><a href="TorPool.html#next_by_group">next_by_group</a></li><li data-type='method'><a href="TorPool.html#remove">remove</a></li><li data-type='method'><a href="TorPool.html#remove_at">remove_at</a></li><li data-type='method'><a href="TorPool.html#remove_by_name">remove_by_name</a></li><li data-type='method'><a href="TorPool.html#remove_instance_from_group">remove_instance_from_group</a></li><li data-type='method'><a href="TorPool.html#remove_instance_from_group_at">remove_instance_from_group_at</a></li><li data-type='method'><a href="TorPool.html#remove_instance_from_group_by_name">remove_instance_from_group_by_name</a></li><li data-type='method'><a href="TorPool.html#set_config_all">set_config_all</a></li><li data-type='method'><a href="TorPool.html#set_config_at">set_config_at</a></li><li data-type='method'><a href="TorPool.html#set_config_by_group">set_config_by_group</a></li><li data-type='method'><a href="TorPool.html#set_config_by_name">set_config_by_name</a></li><li data-type='method'><a href="TorPool.html#signal_all">signal_all</a></li><li data-type='method'><a href="TorPool.html#signal_at">signal_at</a></li><li data-type='method'><a href="TorPool.html#signal_by_group">signal_by_group</a></li><li data-type='method'><a href="TorPool.html#signal_by_name">signal_by_name</a></li></ul></li><li><a href="TorProcess.html">TorProcess</a><ul class='methods'><li data-type='method'><a href="TorProcess.html#create">create</a></li><li data-type='method'><a href="TorProcess.html#exit">exit</a></li><li data-type='method'><a href="TorProcess.html#get_config">get_config</a></li><li data-type='method'><a href="TorProcess.html#new_identity">new_identity</a></li><li data-type='method'><a href="TorProcess.html#set_config">set_config</a></li><li data-type='method'><a href="TorProcess.html#signal">signal</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-tor-router.html">tor-router</a></li><li><a href="module-tor-router_ControlServer.html">tor-router/ControlServer</a></li><li><a href="module-tor-router_default_config.html">tor-router/default_config</a></li><li><a href="module-tor-router_default_ports.html">tor-router/default_ports</a></li><li><a href="module-tor-router_DNSServer.html">tor-router/DNSServer</a></li><li><a href="module-tor-router_HTTPServer.html">tor-router/HTTPServer</a></li><li><a href="module-tor-router_launch.html">tor-router/launch</a></li><li><a href="module-tor-router_nconf_load_env.html">tor-router/nconf_load_env</a></li><li><a href="module-tor-router_SOCKSServer.html">tor-router/SOCKSServer</a></li><li><a href="module-tor-router_TorPool.html">tor-router/TorPool</a></li><li><a href="module-tor-router_TorProcess.html">tor-router/TorProcess</a></li><li><a href="module-tor-router_winston_silent_logger.html">tor-router/winston_silent_logger</a></li></ul><h3>Events</h3><ul><li><a href="DNSServer.html#event:instance-connection">instance-connection</a></li><li><a href="HTTPServer.html#event:instance-connection">instance-connection</a></li><li><a href="SOCKSServer.html#event:instance-connection">instance-connection</a></li><li><a href="TorPool.html#event:instance_created">instance_created</a></li><li><a href="TorProcess.html#event:control_listen">control_listen</a></li><li><a href="TorProcess.html#event:controller_ready">controller_ready</a></li><li><a href="TorProcess.html#event:dns_listen">dns_listen</a></li><li><a href="TorProcess.html#event:error">error</a></li><li><a href="TorProcess.html#event:process_exit">process_exit</a></li><li><a href="TorProcess.html#event:ready">ready</a></li><li><a href="TorProcess.html#event:socks_listen">socks_listen</a></li></ul><h3>Global</h3><ul><li><a href="global.html#assembleHost">assembleHost</a></li><li><a href="global.html#cleanUp">cleanUp</a></li><li><a href="global.html#env_whitelist">env_whitelist</a></li><li><a href="global.html#logger">logger</a></li><li><a href="global.html#main">main</a></li><li><a href="global.html#nconf">nconf</a></li><li><a href="global.html#REALM">REALM</a></li><li><a href="global.html#setup_nconf_env">setup_nconf_env</a></li><li><a href="global.html#TOR_ROUTER_PROXY_AGENT">TOR_ROUTER_PROXY_AGENT</a></li></ul>
</nav>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2>
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="env_whitelist"><span class="type-signature">(constant) </span>env_whitelist<span class="type-signature"> :<a href="Array.html">Array</a>.&lt;string></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="nconf_load_env.js.html">nconf_load_env.js</a>, <a href="nconf_load_env.js.html#line6">line 6</a>
</li></ul></dd>
</dl>
<div class="description">
An array of all valid environment variables
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Array.html">Array</a>.&lt;string></span>
</li>
</ul>
<h4 class="name" id="logger"><span class="type-signature"></span>logger<span class="type-signature"> :Logger</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="launch.js.html">launch.js</a>, <a href="launch.js.html#line254">line 254</a>
</li></ul></dd>
</dl>
<div class="description">
Instnace of `winston.Logger`
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Logger</span>
</li>
</ul>
<h4 class="name" id="nconf"><span class="type-signature"></span>nconf<span class="type-signature"> :Provider</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="launch.js.html">launch.js</a>, <a href="launch.js.html#line158">line 158</a>
</li></ul></dd>
</dl>
<div class="description">
Instance of `nconf.Provider`
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Provider</span>
</li>
</ul>
<h4 class="name" id="REALM"><span class="type-signature">(constant) </span>REALM<span class="type-signature"> :string</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="HTTPServer.js.html">HTTPServer.js</a>, <a href="HTTPServer.js.html#line22">line 22</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>Name of instance to route to</li>
</ul></dd>
</dl>
<div class="description">
What will show up when an unauthenticated user attempts to connect when an invalid username
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<h4 class="name" id="TOR_ROUTER_PROXY_AGENT"><span class="type-signature">(constant) </span>TOR_ROUTER_PROXY_AGENT<span class="type-signature"> :string</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="HTTPServer.js.html">HTTPServer.js</a>, <a href="HTTPServer.js.html#line14">line 14</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>tor-router</li>
</ul></dd>
</dl>
<div class="description">
Value of the "Proxy-Agent" header that will be sent with each http-connect (https) request
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="assembleHost"><span class="type-signature"></span>assembleHost<span class="signature">(host)</span><span class="type-signature"> &rarr; {string}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="launch.js.html">launch.js</a>, <a href="launch.js.html#line40">line 40</a>
</li></ul></dd>
</dl>
<div class="description">
Takes an object with a hostname and port returns a formatted string
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>host</code></td>
<td class="type">
<span class="param-type">Host</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
- Formatted host (e.g. "0.0.0.0:1234")
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="cleanUp"><span class="type-signature"></span>cleanUp<span class="signature">(error)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="launch.js.html">launch.js</a>, <a href="launch.js.html#line118">line 118</a>
</li></ul></dd>
</dl>
<div class="description">
Kills all tor processes and exits, logging an error if one occurs.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>error</code></td>
<td class="type">
<span class="param-type">Error</span>
</td>
<td class="description last">Error or exit code</td>
</tr>
</tbody>
</table>
<h4 class="name" id="main"><span class="type-signature">(async) </span>main<span class="signature">(nconf, logger<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="launch.js.html">launch.js</a>, <a href="launch.js.html#line51">line 51</a>
</li></ul></dd>
</dl>
<div class="description">
Main function for the application
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nconf</code></td>
<td class="type">
<span class="param-type">Provider</span>
</td>
<td class="attributes">
</td>
<td class="description last">Instance of `nconf.Provider` used for configuration.</td>
</tr>
<tr>
<td class="name"><code>logger</code></td>
<td class="type">
<span class="param-type">Logger</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">Winston logger to be used for logging. If not provided will disable logging.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="setup_nconf_env"><span class="type-signature"></span>setup_nconf_env<span class="signature">(nconf)</span><span class="type-signature"> &rarr; {Provider}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="nconf_load_env.js.html">nconf_load_env.js</a>, <a href="nconf_load_env.js.html#line43">line 43</a>
</li></ul></dd>
</dl>
<div class="description">
Sets up nconf with the `env` store.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nconf</code></td>
<td class="type">
<span class="param-type">Provider</span>
</td>
<td class="description last">Instance of `nconf.Provider`.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
- Same instance of `nconf.Provider`.
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Provider</span>
</dd>
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<h4 class="name" id="InstanceConnectionSource">InstanceConnectionSource</h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SOCKSServer.js.html">SOCKSServer.js</a>, <a href="SOCKSServer.js.html#line13">line 13</a>
</li></ul></dd>
</dl>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>hostname</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Hostname where the connection was made from.</td>
</tr>
<tr>
<td class="name"><code>port</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Port where the connection was made from.</td>
</tr>
<tr>
<td class="name"><code>by_name</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Indicates whether the connection was made using a username (made to a specific instance or group of instances).</td>
</tr>
<tr>
<td class="name"><code>proto</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The protocol of the connection "socks", "http", "http-connect" or "dns"</td>
</tr>
</tbody>
</table>
<div class="description">
Details on the source of a connection the proxy server.
</div>
<h4 class="name" id="InstanceDefinition">InstanceDefinition</h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="TorProcess.js.html">TorProcess.js</a>, <a href="TorProcess.js.html#line24">line 24</a>
</li></ul></dd>
</dl>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>Name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">Name of the instance.</td>
</tr>
<tr>
<td class="name"><code>Group</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;string></span>
|
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>[]</code>
</td>
<td class="description last">Groups the instance belongs to.</td>
</tr>
<tr>
<td class="name"><code>Config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>{}</code>
</td>
<td class="description last">Configuration that will be passed to Tor. See <a href="https://bit.ly/2QrmI3o">Tor Documentation</a> for all possible options.</td>
</tr>
<tr>
<td class="name"><code>Weight</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">Weight of the instance for "weighted" load balancing.</td>
</tr>
</tbody>
</table>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h4 class="name" id="InstanceGroup">InstanceGroup</h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line211">line 211</a>
</li></ul></dd>
</dl>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>add</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">Adds an instance to the group.</td>
</tr>
<tr>
<td class="name"><code>remove</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">Removes an instance from the group.</td>
</tr>
<tr>
<td class="name"><code>add_by_name</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">Adds an instance to the group by the <a href="TorProcess.html#instance_name">TorProcess#instance_name</a> property on the instance.</td>
</tr>
<tr>
<td class="name"><code>remove_by_name</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">Removes an instance from the group by the <a href="TorProcess.html#instance_name">TorProcess#instance_name</a> property on the instance.</td>
</tr>
<tr>
<td class="name"><code>remove_at</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">Removes an instance from the group by the index of the instance in the group.</td>
</tr>
<tr>
<td class="name"><code>length</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The size of the group of instances</td>
</tr>
<tr>
<td class="name"><code>rotate</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">Rotates the array of instances</td>
</tr>
</tbody>
</table>
<div class="description">
Represents a group of instances. Group is a Proxy with an array as its object. The array is generated by calling TorPool#instances_in_group.
When called with an index (e.g. `Group[0]`) will return the instance at that index.
Helper functions are available as properties.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Array.html">Array</a>.&lt;<a href="TorProcess.html">TorProcess</a>></span>
</li>
</ul>
<h4 class="name" id="InstanceGroupCollection">InstanceGroupCollection</h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line226">line 226</a>
</li></ul></dd>
</dl>
<div class="description">
Represents a collection of groups as an associative array. GroupCollection is a Proxy with a Set as its object. The Set is <a href="TorPool.html#group_names">TorPool#group_names</a>.
If a non-existant group is referenced (e.g. `Groups["doesn't exist"]`) it will be created. So `Groups["doesn't exist"].add(my_instance)` will create the group and add the instance to it.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Array.html">Array</a>.&lt;<a href="global.html#InstanceGroup">InstanceGroup</a>></span>
</li>
</ul>
<h4 class="name" id="ProxyByNameConfig">ProxyByNameConfig</h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SOCKSServer.js.html">SOCKSServer.js</a>, <a href="SOCKSServer.js.html#line5">line 5</a>
</li></ul></dd>
</dl>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>deny_unidentified_users</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last">Deny unauthenticated (e.g. no username - socks://my-server:9050) users access to the proxy server.</td>
</tr>
<tr>
<td class="name"><code>mode</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">Either "group" for routing to a group of instances or "individual" for routing to individual instances.</td>
</tr>
</tbody>
</table>
<div class="description">
Configuration for the "proxy by name" feature (connecting to specific instances or groups of instances using the username field when connecting).
</div>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Sep 25 2018 12:53:23 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink