ShogunPanda/chalkbars

View on GitHub
docs/chalkbars.module_configuration.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>configuration - 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">configuration</h1>
    

    




<section>

<header>
    
</header>

<article>
    <div class="container-overview">
    
        
            <div class="description"><p>Chalkbars configuration.</p></div>
        

        


<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="lib_configuration.js.html">lib/configuration.js</a>, <a href="lib_configuration.js.html#line8">line 8</a>
    </li></ul></dd>
    

    

    

    
</dl>


        
    
    </div>

    

    

    

     

    

    
        <h3 class="subsection-title">Members</h3>

        
            
<h4 class="name" id=".closingBracket"><span class="type-signature">(static) </span>closingBracket<span class="type-signature"> :string</span></h4>




<div class="description">
    <p>The default template for the closing bracket in the <code>B</code> and <code>E</code> templates.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>{{#C bracket}}]{{/C}}</li>
        </ul></dd>
    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="lib_configuration.js.html">lib/configuration.js</a>, <a href="lib_configuration.js.html#line75">line 75</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".openingBracket"><span class="type-signature">(static) </span>openingBracket<span class="type-signature"> :string</span></h4>




<div class="description">
    <p>The default template for the opening bracket in the <code>B</code> and <code>E</code> templates.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>{{#C bracket}}[{{/C}}</li>
        </ul></dd>
    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="lib_configuration.js.html">lib/configuration.js</a>, <a href="lib_configuration.js.html#line68">line 68</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".shortcuts"><span class="type-signature">(static) </span>shortcuts<span class="type-signature"> :object</span></h4>




<div class="description">
    <p>The list of shortcuts available in the <code>B</code> and <code>E</code> templates.</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="lib_configuration.js.html">lib/configuration.js</a>, <a href="lib_configuration.js.html#line81">line 81</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".silent"><span class="type-signature">(static) </span>silent<span class="type-signature"> :boolean</span></h4>




<div class="description">
    <p>Whether to ignore exceptions when compiling a Handlebars template fails. If set to <code>false</code> a compilation failure will raise an exception.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">boolean</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>true</li>
        </ul></dd>
    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="lib_configuration.js.html">lib/configuration.js</a>, <a href="lib_configuration.js.html#line61">line 61</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".styles"><span class="type-signature">(static) </span>styles<span class="type-signature"> :object</span></h4>




<div class="description">
    <p>The list of style recognized by chalkbars.
It can contain any chalk style, or the following special syntaxes:</p>
<ul>
<li><em>i#</em><strong>ABC</strong> (where ABC is a 3 digit number): The ANSI color code. Example: <strong>031</strong> is red foreground, <strong>042</strong> is green background.</li>
<li><em>x#</em><strong>ABC</strong> (where A, B, C are a number from 0 to 5): The 256 ANSI color code.
For the meaning of the values, see <a href="https://github.com/jbnicolai/ansi-256-colors">https://github.com/jbnicolai/ansi-256-colors</a></li>
<li><em>X#</em><strong>AABBCC</strong> (where AA, BB, CC ranges from 00 to FF): The RGB HEX color code.</li>
</ul>
</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="lib_configuration.js.html">lib/configuration.js</a>, <a href="lib_configuration.js.html#line25">line 25</a>
    </li></ul></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>