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 thea
character with 4
.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
stream-via
* [via(throughFunction, [options])](#exp_module_stream-via--via) ⇒ [<code>Duplex</code>](https://nodejs.org/api/stream.html#stream_class_stream_duplex) ⏏
* [.async(throughFunction, [options])](#module_stream-via--via.async) ⇒ [<code>Duplex</code>](https://nodejs.org/api/stream.html#stream_class_stream_duplex)
* [~throughFunction](#module_stream-via--via..throughFunction) : <code>function</code>
via(throughFunction, options) ⇒ Duplex
⏏
Kind: Exported functionParams
- throughFunction
throughFunction
- a function to process each chunk - options
object
- passed to the returned stream constructor
via.async(throughFunction, options) ⇒ Duplex
Kind: static method of via
Params
- throughFunction
throughFunction
- a function to process each chunk - options
object
- passed to the returned stream constructor
via~throughFunction : function
Kind: inner typedef of via
Params
- chunk
buffer
|string
- enc
string
- done
function
- only used invia.async
, call it like so:done(err, returnValue)
.
© 2015-17 Lloyd Brookes \<75pound@gmail.com\>. Documented by jsdoc-to-markdown.