Neoclassical Piano Montage

    stream-via

    1.0.4 • Public • Published

    view on npm npm module downloads Build Status Dependency Status js-standard-style

    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.

    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]) ⇒ Duplex

    Kind: Exported function
    Params

    • 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 in via.async, call it like so: done(err, returnValue).

    © 2015-17 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.

    Install

    npm i stream-via

    DownloadsWeekly Downloads

    174,184

    Version

    1.0.4

    License

    MIT

    Last publish

    Collaborators

    • 75lb