ti-appium
Version:
An Appium wrapper to test Titanium applications
1,319 lines (297 loc) • 15 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Output_Helper</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-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: Output_Helper</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>Output_Helper<span class="signature">()</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="Output_Helper"><span class="type-signature"></span>new Output_Helper<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Helper for outputting information to the CLI in a uniform manner
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_output.js.html">src/output.js</a>, <a href="src_output.js.html#line11">line 11</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".banner"><span class="type-signature">(static) </span>banner<span class="signature">(message)</span><span class="type-signature"></span></h4>
<div class="description">
Creates a banner and a green info tag around a message.
</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>message</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">String to be enclosed by the banner</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_output.js.html">src/output.js</a>, <a href="src_output.js.html#line105">line 105</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".debug"><span class="type-signature">(static) </span>debug<span class="signature">(message)</span><span class="type-signature"></span></h4>
<div class="description">
Outputs a message when the debug flag is used.
</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>message</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">String to be output</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_output.js.html">src/output.js</a>, <a href="src_output.js.html#line116">line 116</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".error"><span class="type-signature">(static) </span>error<span class="signature">(message)</span><span class="type-signature"></span></h4>
<div class="description">
Outputs all of a string in red.
</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>message</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">String to be output</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_output.js.html">src/output.js</a>, <a href="src_output.js.html#line94">line 94</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".finish"><span class="type-signature">(static) </span>finish<span class="signature">(done, value)</span><span class="type-signature"></span></h4>
<div class="description">
Writes a green done to the console and resolves the promise if passed.
</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>done</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">Promise callback passed from the function</td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">An object to be returned with resolve</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_output.js.html">src/output.js</a>, <a href="src_output.js.html#line39">line 39</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".info"><span class="type-signature">(static) </span>info<span class="signature">(message)</span><span class="type-signature"></span></h4>
<div class="description">
Writes a message with a green info tag (note no new line is passed by
default).
</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>message</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">A string to be output after the info tag</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_output.js.html">src/output.js</a>, <a href="src_output.js.html#line71">line 71</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".skip"><span class="type-signature">(static) </span>skip<span class="signature">(done, value)</span><span class="type-signature"></span></h4>
<div class="description">
Writes a yellow skip to the console and resolves the promise if passed.
</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>done</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">Promise callback passed from the function</td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">An object to be returned with resolve</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_output.js.html">src/output.js</a>, <a href="src_output.js.html#line55">line 55</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".step"><span class="type-signature">(static) </span>step<span class="signature">(message)</span><span class="type-signature"></span></h4>
<div class="description">
Writes a message with a green info tag (note no new line is passed by
default).
</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>message</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">A string to be output after the info tag</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_output.js.html">src/output.js</a>, <a href="src_output.js.html#line23">line 23</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".warn"><span class="type-signature">(static) </span>warn<span class="signature">(message)</span><span class="type-signature"></span></h4>
<div class="description">
Writes a message with a yellow warning tag (note no new line is passed by
default).
</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>message</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">A string to be output after the warning tag</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_output.js.html">src/output.js</a>, <a href="src_output.js.html#line83">line 83</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="WebDriverCommands.html">WebDriverCommands</a></li></ul><h3>Classes</h3><ul><li><a href="Appc_Helper.html">Appc_Helper</a></li><li><a href="Appium_Helper.html">Appium_Helper</a></li><li><a href="Device_Helper.html">Device_Helper</a></li><li><a href="Mocha_Helper.html">Mocha_Helper</a></li><li><a href="Output_Helper.html">Output_Helper</a></li><li><a href="Webdriver_Helper.html">Webdriver_Helper</a></li></ul><h3>Global</h3><ul><li><a href="global.html#appcRun">appcRun</a></li><li><a href="global.html#appcSetup">appcSetup</a></li><li><a href="global.html#banner">banner</a></li><li><a href="global.html#buildApp">buildApp</a></li><li><a href="global.html#createAppPath">createAppPath</a></li><li><a href="global.html#debug">debug</a></li><li><a href="global.html#error">error</a></li><li><a href="global.html#finish">finish</a></li><li><a href="global.html#getCert">getCert</a></li><li><a href="global.html#getProfile">getProfile</a></li><li><a href="global.html#getSimState">getSimState</a></li><li><a href="global.html#info">info</a></li><li><a href="global.html#killEmulator">killEmulator</a></li><li><a href="global.html#killSimulator">killSimulator</a></li><li><a href="global.html#parseSDK">parseSDK</a></li><li><a href="global.html#skip">skip</a></li><li><a href="global.html#startAppium">startAppium</a></li><li><a href="global.html#startClient">startClient</a></li><li><a href="global.html#step">step</a></li><li><a href="global.html#stopAppium">stopAppium</a></li><li><a href="global.html#stopClient">stopClient</a></li><li><a href="global.html#test">test</a></li><li><a href="global.html#warn">warn</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Fri Aug 28 2020 10:09:07 GMT+0100 (British Summer Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>