docs/api/manual/index.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<base data-ice="baseUrl" href="../">
<title data-ice="title">Manual</title>
<link type="text/css" rel="stylesheet" href="css/style.css">
<link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css">
<script src="script/prettify/prettify.js"></script>
<script src="script/manual.js"></script>
</head>
<body class="layout-container manual-root manual-index" data-ice="rootContainer">
<header>
<a href="./">Home</a>
<a href="identifiers.html">Reference</a>
<a href="source.html">Source</a>
<a data-ice="repoURL" href="https://github.com/MitocGroup/recink.git" class="repo-url-github">Repository</a>
<div class="search-box">
<span>
<img src="./image/search.png">
<span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span>
</span>
<ul class="search-result"></ul>
</div>
</header>
<nav class="navigation" data-ice="nav"><div class="manual-toc-root">
<div data-ice="manual" data-toc-name="reference">
<ul class="manual-toc">
<li data-ice="manualNav" class="indent-h1 manual-color manual-color-reference" data-section-count="■■■■■" data-link="identifiers.html"><a href="identifiers.html" data-ice="link">Reference</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="identifiers.html"><a href="identifiers.html#class" data-ice="link">Class</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="identifiers.html"><a href="identifiers.html#function" data-ice="link">Function</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="identifiers.html"><a href="identifiers.html#variable" data-ice="link">Variable</a></li>
</ul>
</div>
</div>
</nav>
<div class="content" data-ice="content"><div class="github-markdown">
<div class="manual-user-index" data-ice="manualUserIndex"><h1 id="recink-rethink-continuous-integration-for-javascript-applications">REciNK - Rethink Continuous Integration for JavaScript Applications</h1>
<p><a href="https://npmjs.org/package/recink"><img src="https://badge.fury.io/js/recink.svg?maxAge=0" alt="NPM Version"></a>
<a href="https://travis-ci.org/MitocGroup/recink"><img src="https://travis-ci.org/MitocGroup/recink.svg?branch=master&maxAge=0" alt="Build Status"></a>
<a href="https://codeclimate.com/github/MitocGroup/recink"><img src="https://codeclimate.com/github/MitocGroup/recink/badges/coverage.svg?maxAge=0" alt="Code Climate"></a>
<a href="https://mitocgroup.github.io/recink/api/"><img src="https://mitocgroup.github.io/recink/api/badge.svg?maxAge=0" alt="API Docs"></a></p>
<p>REciNK was born from our need to automate the execution of JavaScript tests.
We quickly realized that we need to RETHINK (aka <code>REciNK</code>) entire Continuous
Integration process for JavaScript applications. Similar to <code>.travis.yml</code>, we
empower developers to simply drop the <code>.recink.yml</code> config file into GitHub
repository and follow below Getting Started guide to use it as part of their
Continuous Integration pipeline (maybe even extend to Continuous Deployment).</p>
<h1 id="features">Features</h1>
<ul>
<li><a href="https://github.com/MitocGroup/recink#installation">Install</a>.
<a href="https://github.com/MitocGroup/recink/blob/master/docs/guide.md#configuring-github-project">Configure</a>.
<a href="https://github.com/MitocGroup/recink#usage">Use</a>.</li>
<li>Multi-module support for
<a href="https://github.com/MitocGroup/recink/blob/master/bin/templates/.recink.yml#L50">consolidated coverage</a>.</li>
<li>Built-in support for <a href="https://travis-ci.org">Travis</a>,
<a href="https://www.npmjs.com">NPM</a>, <a href="http://chaijs.com">Chai</a>,
<a href="http://mochajs.org">Mocha</a>, <a href="https://istanbul.js.org">Istanbul</a>,
<a href="https://devexpress.github.io/testcafe">TestCafe</a>.</li>
<li>Amazon S3 powered
<a href="https://github.com/MitocGroup/recink/blob/master/bin/templates/.recink.yml#L10">caching</a>.</li>
<li><a href="https://github.com/MitocGroup/recink#components">Extendable</a>.
<a href="https://github.com/MitocGroup/recink#debugging">Debuggable</a>.
<a href="https://github.com/MitocGroup/recink#documentation">Documented</a>.</li>
</ul>
<h1 id="prerequisites">Prerequisites</h1>
<ul>
<li>[x] Git >= v1.x</li>
<li>[x] Node.js >= v6.x</li>
<li>[x] NPM >= v3.x</li>
</ul>
<blockquote>
<p>Use <a href="https://github.com/creationix/nvm#installation">nvm</a> to install and
manage different versions of Node.js; Ideally, use v8+ for faster performance</p>
</blockquote>
<h1 id="installation">Installation</h1>
<p><code>npm install -g recink</code></p>
<h1 id="getting-started">Getting Started</h1>
<p>@See <a href="https://github.com/MitocGroup/recink/blob/master/docs/guide.md#configuring-github-project">User Guide</a></p>
<h1 id="usage">Usage</h1>
<pre><code class="lang-shell"><code class="source-code prettyprint">recink run [name] [path] # Run a generic component
recink run unit [path] # Run unit tests
recink run e2e [path] # Run end to end tests
recink configure recink [path] # Configure REciNK
recink configure travis [path] # Configure Travis
recink travis encrypt [path] # Encrypt Travis environment variables
recink travis lint [path] # Lint Travis configuration
recink component generate [path] # Generate REciNK boilerplate component
recink component add [name...] # Add an REciNK component to the registry
recink component remove [name...] # Remove an REciNK component from the registry
recink component list # List REciNK components from the registry
recink help <command> # Display help for a specific command</code>
</code></pre>
<h1 id="debugging">Debugging</h1>
<p>To enable debug mode for both <code>unit</code> and <code>e2e</code> runtimes use <code>DEBUG=* recink run unit|e2e</code>.</p>
<p><a href="https://devexpress.github.io/testcafe">TestCafe</a> offers amazing debugging capabilities
<a href="http://devexpress.github.io/testcafe/documentation/test-api/debugging.html">documented here</a>.</p>
<p>We are using <a href="https://github.com/GoogleChrome/puppeteer">Puppeteer</a>
as default browser, which provides native debugging capabilities
<a href="https://github.com/GoogleChrome/puppeteer#debugging-tips">documented here</a>.</p>
<blockquote>
<p>Use <code>-v</code> flag to enable verbose mode on any <code>recink</code> command.</p>
</blockquote>
<h1 id="supported-ci-platforms">Supported CI Platforms</h1>
<ul>
<li>[x] <a href="https://travis-ci.org">Travis</a></li>
<li>[x] <a href="https://travis-ci.com">Travis Pro</a></li>
</ul>
<h1 id="documentation">Documentation</h1>
<ul>
<li>[x] <a href="https://github.com/MitocGroup/recink/blob/master/docs/guide.md">Quick Start Guide</a></li>
<li>[x] <a href="https://github.com/MitocGroup/recink/blob/master/docs/component-guide.md">Crafting Components</a></li>
<li>[x] <a href="https://mitocgroup.github.io/recink/api/identifiers.html">API Docs</a></li>
<li>[x] <a href="https://mitocgroup.github.io/recink/module-diagram.html">Module Diagram</a></li>
<li>[x] <a href="https://github.com/MitocGroup/recink/blob/master/docs/faq.md">FAQ</a></li>
</ul>
<h1 id="components">Components</h1>
<ul>
<li>:house: <a href="https://github.com/MitocGroup/recink/blob/master/components/codeclimate/README.md">CodeClimate</a></li>
<li>:house: <a href="https://github.com/MitocGroup/recink/blob/master/components/snyk/README.md">Snyk.io</a></li>
<li>:house: <a href="https://github.com/MitocGroup/recink/blob/master/components/pagespeed/README.md">PageSpeed</a></li>
<li>:house: <a href="https://github.com/MitocGroup/recink/blob/master/components/comment/README.md">Comment</a></li>
<li>:house: <a href="https://github.com/MitocGroup/recink/blob/master/components/terraform/README.md">Terraform</a></li>
</ul>
<blockquote>
<p>Explore in-house built components <a href="https://github.com/MitocGroup/recink/tree/master/components">here</a></p>
</blockquote>
<h1 id="projects-using-recink-">Projects Using "REciNK"</h1>
<ul>
<li><a href="https://github.com/MitocGroup/deep-framework/blob/master/.recink.yml">Deep Framework</a></li>
</ul>
<blockquote>
<p>To add you project to this list please open a PR ;)</p>
</blockquote>
<h1 id="roadmap">Roadmap</h1>
<ul>
<li>[x] Implement smart cache invalidation</li>
<li>[x] Add support for external components</li>
<li>[x] Add support for fully automated <code>Travis</code> configuration </li>
<li>[x] Add support for End-to-End tests</li>
<li>[x] Add component development guide</li>
<li>[x] Add unit tests for critical functionality</li>
<li>[x] Decouple e2e component</li>
<li>[ ] Decouple unit component</li>
<li>[ ] Decouple coverage component</li>
<li>[ ] Add support for different CI platforms</li>
<li>[ ] Craft a cool logo for the project :alien:</li>
<li>[ ] Add unit tests to cover at least 80% of codebase</li>
</ul>
<h1 id="sponsors">Sponsors</h1>
<p>This repository is being sponsored by:</p>
<ul>
<li><a href="https://www.mitocgroup.com">Mitoc Group</a></li>
<li><a href="https://www.adtechmedia.io">AdTechMedia</a></li>
</ul>
<h1 id="license">License</h1>
<p>REciNK is released under the <a href="https://github.com/MitocGroup/recink/blob/master/LICENSE.md">MIT license</a>.</p>
</div>
<p class="manual-badge" data-ice="manualBadge"><img src="./manual-badge.svg"></p>
<div class="manual-cards">
<div class="manual-card-wrap" data-ice="cards">
<h1 data-ice="label" class="manual-color manual-color-reference" data-section-count="■■■■■"><span data-ice="label-inner">References</span></h1>
<div class="manual-card">
<div data-ice="card"><h1>References</h1>
<div data-ice="classSummary"><h2 id="class">Class Summary</h2><table class="summary" data-ice="summary">
<thead><tr><td data-ice="title" colspan="3">Static Public Class Summary</td></tr></thead>
<tbody>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/abstract-component.js~AbstractComponent.html">AbstractComponent</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Abstract component</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/config/abstract-config.js~AbstractConfig.html">AbstractConfig</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Abstract configuration manager</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/cache/abstract-driver.js~AbstractDriver.html">AbstractDriver</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Abstract cache driver</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/coverage/abstract-driver.js~AbstractDriver.html">AbstractDriver</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Abstract coverage storage driver</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/preprocess/abstract-transformer.js~AbstractTransformer.html">AbstractTransformer</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Transformer interface</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/helper/aws-credentials.js~AwsCredentials.html">AwsCredentials</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>AWS security credentials</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/npm/cache.js~Cache.html">Cache</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>File system cache implementation</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/cache-component.js~CacheComponent.html">CacheComponent</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Cache component</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/config-based-component.js~ConfigBasedComponent.html">ConfigBasedComponent</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Abstract configuration aware component</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/container.js~Container.html">Container</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Configuration container</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/helper/container-transformer.js~ContainerTransformer.html">ContainerTransformer</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Apply transformations to an configuration container</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/coverage-component.js~CoverageComponent.html">CoverageComponent</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Coverage component</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/dependency-based-component.js~DependencyBasedComponent.html">DependencyBasedComponent</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Abstract dependency aware component</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/emit-component.js~EmitComponent.html">EmitComponent</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Emit component</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/emit/emit-module.js~EmitModule.html">EmitModule</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Class representing emited test module</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/emitter.js~Emitter.html">Emitter</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Extended Emitter implementation</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/helper/env.js~Env.html">Env</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Environment helpers</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/preprocess/eval-transformer.js~EvalTransformer.html">EvalTransformer</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Transformer implementation of 'eval'</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/cache/factory.js~Factory.html">Factory</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Cache factory</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/coverage/factory.js~Factory.html">Factory</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Coverage storage factory</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/config/factory.js~Factory.html">Factory</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Configuration factory</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/factory.js~Factory.html">Factory</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Component factory</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/preprocess/factory.js~Factory.html">Factory</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Transformer factory</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/logger.js~Logger.html">Logger</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Logger abstraction</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/helper/module-compile.js~ModuleCompile.html">ModuleCompile</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Overwrites original Module to apply compilers</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/npm-component.js~NpmComponent.html">NpmComponent</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>NPM component</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/npm/npm-module.js~NpmModule.html">NpmModule</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Abstraction over an NPM module</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/preprocess-component.js~PreprocessComponent.html">PreprocessComponent</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Preprocess component</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/recink.js~Recink.html">Recink</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Recink entry point</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/cache/s3-driver.js~S3Driver.html">S3Driver</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>AWS S3 cache driver</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/coverage/s3-driver.js~S3Driver.html">S3Driver</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>AWS S3 coverage storage driver</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/cache/s3-unpacked-driver.js~S3UnpackedDriver.html">S3UnpackedDriver</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>AWS S3 (unpacked) cache driver</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/helper/sequential-promise.js~SequentialPromise.html">SequentialPromise</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Implements Promise.all() but sequential execution</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/helper/spinner.js~Spinner.html">Spinner</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Terminal spinner implementation</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/test-component.js~TestComponent.html">TestComponent</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Test component</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/helper/transformer.js~Transformer.html">Transformer</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Apply transformer over a value</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/test/unit-runner.js~UnitRunner.html">UnitRunner</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Unit test runner</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/cache/void-driver.js~VoidDriver.html">VoidDriver</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Void cache driver</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/component/coverage/volatile-driver.js~VolatileDriver.html">VolatileDriver</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Volatile coverage storage driver</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/config/yaml-config.js~YamlConfig.html">YamlConfig</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>YAML configuration manager</p>
</div>
</div>
</td>
<td>
</td>
</tr>
</tbody>
</table>
</div>
<div data-ice="functionSummary"><h2 id="function">Function Summary</h2><table class="summary" data-ice="summary">
<thead><tr><td data-ice="title" colspan="3">Static Public Function Summary</td></tr></thead>
<tbody>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="function/index.html#static-function-fillString">fillString</a></span></span><span data-ice="signature">(str: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>, length: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></span>, symbol: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Fill string with symbols</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="function/index.html#static-function-findFilesByPattern">findFilesByPattern</a></span></span><span data-ice="signature">(dir: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>, include: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp">RegExp</a></span>, exclude: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp">RegExp</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Find files by RegExp pattern except dirs</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="function/index.html#static-function-patterntransformer">patterntransformer</a></span></span><span data-ice="signature">(value: <span>*</span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
</p>
</div>
<div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="function/index.html#static-function-trimBoth">trimBoth</a></span></span><span data-ice="signature">(string: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>, symbol: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Remove all prefixes or suffixes from the given string</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="function/index.html#static-function-versionCompare">versionCompare</a></span></span><span data-ice="signature">(v1: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>, v2: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Compare two software version
v1 == v2 => 0
v1 < v2 => -1
v1 > v2 => 1</p>
</div>
</div>
</td>
<td>
</td>
</tr>
</tbody>
</table>
</div>
<div data-ice="variableSummary"><h2 id="variable">Variable Summary</h2><table class="summary" data-ice="summary">
<thead><tr><td data-ice="title" colspan="3">Static Public Variable Summary</td></tr></thead>
<tbody>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-events">events</a></span></span><span data-ice="signature">: {}</span>
</p>
</div>
<div>
<div data-ice="description"><p>Cache component events</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-events">events</a></span></span><span data-ice="signature">: {}</span>
</p>
</div>
<div>
<div data-ice="description"><p>Coverage component events</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-events">events</a></span></span><span data-ice="signature">: {}</span>
</p>
</div>
<div>
<div data-ice="description"><p>Emit component events</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-events">events</a></span></span><span data-ice="signature">: {}</span>
</p>
</div>
<div>
<div data-ice="description"><p>NPM component events</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-events">events</a></span></span><span data-ice="signature">: {}</span>
</p>
</div>
<div>
<div data-ice="description"><p>Test component events</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-events">events</a></span></span><span data-ice="signature">: {}</span>
</p>
</div>
<div>
<div data-ice="description"><p>REciNK main events</p>
</div>
</div>
</td>
<td>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<a data-ice="link" href="identifiers.html"></a>
</div>
</div>
</div>
</div>
</div>
<footer class="footer">
Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(0.5.2)</span><img src="./image/esdoc-logo-mini-black.png"></a>
</footer>
<script src="script/search_index.js"></script>
<script src="script/search.js"></script>
<script src="script/pretty-print.js"></script>
<script src="script/inherited-summary.js"></script>
<script src="script/test-summary.js"></script>
<script src="script/inner-link.js"></script>
<script src="script/patch-for-local.js"></script>
</body>
</html>