docs/module-chalkbars.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>chalkbars - 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="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</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>Modules</h3><ul><li><a href="chalkbars.module_configuration.html">configuration</a></li><li><a href="module-chalkbars.html">chalkbars</a><ul class='methods'><li data-type='method'><a href="module-chalkbars.html#.error">error</a></li><li data-type='method'><a href="module-chalkbars.html#.format">format</a></li><li data-type='method'><a href="module-chalkbars.html#.formatNoColor">formatNoColor</a></li><li data-type='method'><a href="module-chalkbars.html#.log">log</a></li><li data-type='method'><a href="module-chalkbars.html#.plainFormat">plainFormat</a></li><li data-type='method'><a href="module-chalkbars.html#.style">style</a></li></ul></li></ul>
</nav>
<div id="main">
<h1 class="page-title">chalkbars</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Chalkbars module.</p></div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line47">line 47</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id=".chalk"><span class="type-signature">(static) </span>chalk<span class="type-signature"> :object</span></h4>
<div class="description">
<p>The console library used by chalkbars.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line58">line 58</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".handlebars"><span class="type-signature">(static) </span>handlebars<span class="type-signature"> :object</span></h4>
<div class="description">
<p>The templating library used by chalkbars.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line65">line 65</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".error"><span class="type-signature">(static) </span>error<span class="signature">(…template, context)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Compiles a Handlebars templates and then outputs it to the console as error.
{@see format}</p>
</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>template</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<repeatable><br>
</td>
<td class="description last"><p>The template to compile. You can specify more than one string, they will be concatenated.</p></td>
</tr>
<tr>
<td class="name"><code>context</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The context for the Handlebars template.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line118">line 118</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".format"><span class="type-signature">(static) </span>format<span class="signature">(…template, context)</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
<p>Compiles a Handlebars templates and then applies chalk colors.</p>
</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>template</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<repeatable><br>
</td>
<td class="description last"><p>The template to compile. You can specify more than one string, they will be concatenated.</p></td>
</tr>
<tr>
<td class="name"><code>context</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The context for the Handlebars template.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line19">line 19</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The compiled template with color styles applied.</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id=".formatNoColor"><span class="type-signature">(static) </span>formatNoColor<span class="signature">(…template, context)</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
<p>Compiles a Handlebars templates and then it strips out all ANSI color sequences.
{@see format}</p>
</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>template</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<repeatable><br>
</td>
<td class="description last"><p>The template to compile. You can specify more than one string, they will be concatenated.</p></td>
</tr>
<tr>
<td class="name"><code>context</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The context for the Handlebars template.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line81">line 81</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The compiled template with color styles removed.</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id=".log"><span class="type-signature">(static) </span>log<span class="signature">(…template, context)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Compiles a Handlebars templates and then outputs it to the console.
{@see format}</p>
</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>template</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<repeatable><br>
</td>
<td class="description last"><p>The template to compile. You can specify more than one string, they will be concatenated.</p></td>
</tr>
<tr>
<td class="name"><code>context</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The context for the Handlebars template.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line106">line 106</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".plainFormat"><span class="type-signature">(static) </span>plainFormat<span class="signature">(…template, context)</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
<p>Compiles a Handlebars templates and then it strips out all ANSI escape sequences.
{@see format}</p>
</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>template</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<repeatable><br>
</td>
<td class="description last"><p>The template to compile. You can specify more than one string, they will be concatenated.</p></td>
</tr>
<tr>
<td class="name"><code>context</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The context for the Handlebars template.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line94">line 94</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The compiled template with ANSI escape sequences removed.</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id=".style"><span class="type-signature">(static) </span>style<span class="signature">(name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string|undefined}</span></h4>
<div class="description">
<p>Get or sets a chalkbars style.</p>
</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>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The name of the style. It <strong>must not</strong> overwrite a existing chalk style.</p></td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">null</span>
|
<span class="param-type">undefined</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><ul>
<li>When omitted, it returns the current value of the style.</li>
<li>When <code>null</code>, it returns the current value of the style and then deletes the style.</li>
<li>When a string, it sets the new value of the style and then returns the value itself.</li>
</ul></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_functions.js.html">lib/functions.js</a>, <a href="lib_functions.js.html#line60">line 60</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The value of the style or <code>undefined</code>.</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Aug 18 2016 15:08:28 GMT+0200 (CEST) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>