docs/Cli.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Cli</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: Cli</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>Cli<span class="signature">(settings)</span><span class="type-signature"></span></h2>
<div class="class-description">Cli Helper Class</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="Cli"><span class="type-signature"></span>new Cli<span class="signature">(settings)</span><span class="type-signature"></span></h4>
<div class="description">
Create a Cli object
</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>settings</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The settings for this Cli object</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cli.js.html">cli.js</a>, <a href="cli.js.html#line24">line 24</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id=".DEFAULT_SETTINGS"><span class="type-signature">(static) </span>DEFAULT_SETTINGS<span class="type-signature"></span></h4>
<div class="description">
Return the default settings from JSON file
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cli.js.html">cli.js</a>, <a href="cli.js.html#line210">line 210</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="getHelpSections"><span class="type-signature"></span>getHelpSections<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Return the JSON structure for the usage message
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cli.js.html">cli.js</a>, <a href="cli.js.html#line151">line 151</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getOptions"><span class="type-signature"></span>getOptions<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Get parsed CLI options
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cli.js.html">cli.js</a>, <a href="cli.js.html#line143">line 143</a>
</li></ul></dd>
</dl>
<h4 class="name" id="mergeSettings"><span class="type-signature"></span>mergeSettings<span class="signature">(settings)</span><span class="type-signature"></span></h4>
<div class="description">
Merge settings from constructor with defaults
</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>settings</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The settings for this Cli object</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cli.js.html">cli.js</a>, <a href="cli.js.html#line88">line 88</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setOptions"><span class="type-signature"></span>setOptions<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Set the options from the process argument list (process.argv)
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cli.js.html">cli.js</a>, <a href="cli.js.html#line135">line 135</a>
</li></ul></dd>
</dl>
<h4 class="name" id="showHelp"><span class="type-signature"></span>showHelp<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Show the help menu & exit
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cli.js.html">cli.js</a>, <a href="cli.js.html#line184">line 184</a>
</li></ul></dd>
</dl>
<h4 class="name" id="showVersion"><span class="type-signature"></span>showVersion<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Show the name and current version
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cli.js.html">cli.js</a>, <a href="cli.js.html#line199">line 199</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Cli.html">Cli</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Wed Jul 24 2019 11:21:15 GMT-0600 (MDT)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>