balena-cli/doc/file/lib/connection/connection.coffee.html
2014-12-08 09:17:21 -04:00

199 lines
4.2 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset='UTF-8'>
<title>CoffeeScript API Documentation</title>
<script src='../../../javascript/application.js'></script>
<script src='../../../javascript/search.js'></script>
<link rel='stylesheet' href='../../../stylesheets/application.css' type='text/css'>
</head>
<body>
<div id='base' data-path='../../../'></div>
<div id='header'>
<div id='menu'>
<a href='../../../alphabetical_index.html' title='Index'>
Index
</a>
&raquo;
<span class='title'>lib</span>
&raquo;
<span class='title'>connection</span>
&raquo;
<span class='title'>connection.coffee</span>
</div>
</div>
<div id='content'>
<h1>
File:
connection.coffee
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>lib&#47;connection</td>
</tr>
</table>
<h2>Variables Summary</h2>
<dl class='constants'>
<dt id='CONNECTION_PARAMETERS-variable'>
CONNECTION_PARAMETERS
=
</dt>
<dd>
<pre><code class='coffeescript'>[&#39;network&#39;, &#39;wifiSsid&#39;, &#39;wifiKey&#39;]</code></pre>
</dd>
<dt id='exports.isOnline-variable'>
exports.isOnline
=
</dt>
<dd>
<pre><code class='coffeescript'>isOnline</code></pre>
<div class='docstring'>
<p>A wrapper around isOnline in order
to be able to stub it with Sinon</p>
</div>
<div class='tags'>
</div>
</dd>
</dl>
<h2>Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#validateEthernetConnectionParameters-'>
~
(void)
<b>validateEthernetConnectionParameters</b><span>(parameters = {})</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#validateWifiConnectionParameters-'>
~
(void)
<b>validateWifiConnectionParameters</b><span>(parameters = {})</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#parseConnectionParameters-'>
~
(void)
<b>parseConnectionParameters</b><span>(parameters = {}, callback)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
</ul>
<h2>Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='validateEthernetConnectionParameters-'>
~
(void)
<b>validateEthernetConnectionParameters</b><span>(parameters = {})</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='validateWifiConnectionParameters-'>
~
(void)
<b>validateWifiConnectionParameters</b><span>(parameters = {})</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='parseConnectionParameters-'>
~
(void)
<b>parseConnectionParameters</b><span>(parameters = {}, callback)</span>
<br>
</p>
</div>
</div>
</div>
<div id='footer'>
December 08, 14 09:16:28 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.0.9
&#10034;
Press H to see the keyboard shortcuts
&#10034;
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
&#10034;
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
Control the navigation frame:
</p>
<ul>
<li>
<span>L</span>
Toggle list view
</li>
<li>
<span>C</span>
Show class list
</li>
<li>
<span>I</span>
Show mixin list
</li>
<li>
<span>F</span>
Show file list
</li>
<li>
<span>M</span>
Show method list
</li>
<li>
<span>E</span>
Show extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
</div>
</body>
</html>