bigint-crypto-utils/node_modules/stream-via/jsdoc2md/README.hbs

38 lines
1.2 KiB
Handlebars

[![view on npm](http://img.shields.io/npm/v/stream-via.svg)](https://www.npmjs.org/package/stream-via)
[![npm module downloads](http://img.shields.io/npm/dt/stream-via.svg)](https://www.npmjs.org/package/stream-via)
[![Build Status](https://travis-ci.org/75lb/stream-via.svg?branch=master)](https://travis-ci.org/75lb/stream-via)
[![Dependency Status](https://david-dm.org/75lb/stream-via.svg)](https://david-dm.org/75lb/stream-via)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)
# stream-via
Process each chunk of a stream via the supplied function. Useful for meddling inside a stream pipeline. Works in both string/Buffer and object modes.
## Synopsis
Replace all instances of the `a` character with `4`.
```js
const via = require('stream-via')
const fs = require('fs')
process.stdin
.pipe(via(function (chunk) {
return chunk.toString().replace(/a/g, '4')
}))
.pipe(process.stdout)
```
Output:
```
$ echo 'twat' | node example/simple.js
tw4t
```
# API
{{#module name="stream-via"}}{{>docs}}{{/module}}
* * *
&copy; 2015-17 Lloyd Brookes \<75pound@gmail.com\>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).