docs/index.html
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Stream Mock</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">Stream Mock</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="globals.html">Globals</a>
</li>
</ul>
<h1> Stream Mock</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<h1 id="stream-mock">Stream Mock</h1>
<p><a href="https://travis-ci.org/b4nst/stream-mock"><img src="https://img.shields.io/travis/b4nst/stream-mock.svg?logo=travis-ci" alt="Travis (.org)"></a>
<a href="https://www.npmjs.com/package/stream-mock"><img src="https://img.shields.io/npm/v/stream-mock.svg?logo=npm" alt="npm"></a>
<a href="https://github.com/b4nst/stream-mock/network/alerts"><img src="https://img.shields.io/snyk/vulnerabilities/github/b4nst/stream-mock.svg?logo=snyk" alt="Snyk Vulnerabilities for GitHub Repo"></a>
<a href="https://codeclimate.com/github/b4nst/stream-mock"><img src="https://img.shields.io/codeclimate/coverage/b4nst/stream-mock.svg?logo=code-climate" alt="Code Climate coverage"></a>
<a href="https://codeclimate.com/github/b4nst/stream-mock"><img src="https://img.shields.io/codeclimate/maintainability/b4nst/stream-mock.svg?logo=code-climate" alt="Code Climate maintainability"></a>
<a href="https://greenkeeper.io/"><img src="https://img.shields.io/badge/-enabled-green.svg?logo=greenkeeper&color=grey" alt="Greenkeeper badge"></a>
<img src="https://img.shields.io/node/v/stream-mock.svg?label=&logo=node.js&color=grey" alt="node">
<img src="https://img.shields.io/npm/types/stream-mock.svg" alt="npm type definitions">
<img src="https://img.shields.io/github/license/b4nst/stream-mock.svg" alt="GitHub"></p>
<p>Mock nodejs streams.</p>
<h2 id="features">Features</h2>
<ul>
<li>Create a
<a href="https://nodejs.org/api/stream.html#stream_readable_streams">readable stream</a>
from any iterable.</li>
<li>Create a
<a href="https://nodejs.org/api/stream.html#stream_writable_streams">writable stream</a>
that puts its data at your disposal.</li>
<li>Create a
<a href="https://nodejs.org/api/stream.html#stream_duplex_and_transform_streams">duplex stream</a>
that combines a readable and writable stream together.</li>
<li>Can operate both in
<a href="https://nodejs.org/api/stream.html#stream_object_mode">object</a> and normal
( <a href="https://nodejs.org/api/buffer.html#buffer_buf_length">Buffer</a> ) mode.</li>
</ul>
<h2 id="quick-start">Quick start</h2>
<pre><code class="language-shell">yarn add stream-mock</code></pre>
<p>Or, if you are more a <code>npm</code> person</p>
<pre><code class="language-shell">npm i stream-mock</code></pre>
<h3 id="basic-usage">Basic usage</h3>
<p>You are building an awesome brand new
<a href="https://nodejs.org/api/stream.html#stream_duplex_and_transform_streams">Transform stream</a>
that rounds all your values.</p>
<pre><code class="language-javascript"><span class="hljs-keyword">import</span> { Transform } <span class="hljs-keyword">from</span> <span class="hljs-string">'stream'</span>;
<span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Rounder</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">Transform</span> </span>{
_transform(chunk, encoding, callback) {
<span class="hljs-keyword">this</span>.push(<span class="hljs-built_in">Math</span>.round(chunk));
callback();
}
}</code></pre>
<p>Now you need / want to test it.</p>
<pre><code class="language-javascript"><span class="hljs-keyword">import</span> {ObjectReadableMock, ObjectWritableMock, DuplexMock } <span class="hljs-keyword">from</span> <span class="hljs-string">'stream-mock'</span>;
<span class="hljs-keyword">import</span> chai <span class="hljs-keyword">from</span> <span class="hljs-string">'chai'</span>;
<span class="hljs-keyword">import</span> Rounder <span class="hljs-keyword">from</span> <span class="hljs-string">'the/seven/bloody/hells'</span>;
chai.should();
describe(<span class="hljs-string">'Test me if you can'</span>, (done) => {
it(<span class="hljs-string">'Round me like one of your french girls'</span>, {
<span class="hljs-comment">// Given</span>
<span class="hljs-keyword">const</span> input = [<span class="hljs-number">1.2</span>, <span class="hljs-number">2.6</span>, <span class="hljs-number">3.7</span>];
<span class="hljs-keyword">const</span> transform = <span class="hljs-keyword">new</span> Rounder({<span class="hljs-attr">objectMode</span>: <span class="hljs-literal">true</span>});
<span class="hljs-keyword">const</span> reader = <span class="hljs-keyword">new</span> ObjectReadableMock(input);
<span class="hljs-keyword">const</span> writer = <span class="hljs-keyword">new</span> ObjectWritableMock();
<span class="hljs-comment">// When</span>
reader.pipe(transform).pipe(writer);
<span class="hljs-comment">// Then</span>
writer.on(<span class="hljs-string">'finish'</span>, ()=>{
writer.data.should.deep.equal(input.map(<span class="hljs-built_in">Math</span>.round));
})
});
});</code></pre>
<p><img src="https://media.giphy.com/media/12NUbkX6p4xOO4/giphy.gif" alt="magic"></p>
<h3 id="api-documentation">API documentation</h3>
<p>Full API doc is hosted <a href="https://bastienar.github.io/stream-mock/">here</a></p>
<hr>
<h2 id="license">License</h2>
<p>MIT</p>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_test_.html">"test"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/constant.html">constant</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/duplex.html">duplex</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/helpers.html">helpers</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/readable.html">readable</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/types.html">types</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/writable.html">writable</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>