https://github.com/75lb/stream-via

Process each chunk of a stream via the supplied function
https://github.com/75lb/stream-via

Last synced: 9 months ago
JSON representation

Process each chunk of a stream via the supplied function

• Host: GitHub
• URL: https://github.com/75lb/stream-via
• Owner: 75lb
• License: mit
• Created: 2015-07-03T22:16:07.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2017-06-17T23:17:24.000Z (about 9 years ago)
• Last Synced: 2025-02-02T08:31:51.394Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 24.4 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![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



## stream-via

* [stream-via](#module_stream-via)

    * [via(throughFunction, [options])](#exp_module_stream-via--via) ⇒ [Duplex](https://nodejs.org/api/stream.html#stream_class_stream_duplex) ⏏

        * [.async(throughFunction, [options])](#module_stream-via--via.async) ⇒ [Duplex](https://nodejs.org/api/stream.html#stream_class_stream_duplex)

        * [~throughFunction](#module_stream-via--via..throughFunction) : function



### via(throughFunction, [options]) ⇒ [Duplex](https://nodejs.org/api/stream.html#stream_class_stream_duplex) ⏏

**Kind**: Exported function  

**Params**

- throughFunction [throughFunction](#module_stream-via--via..throughFunction) - a function to process each chunk

- [options] object - passed to the returned stream constructor



#### via.async(throughFunction, [options]) ⇒ [Duplex](https://nodejs.org/api/stream.html#stream_class_stream_duplex)

**Kind**: static method of [via](#exp_module_stream-via--via)  

**Params**

- throughFunction [throughFunction](#module_stream-via--via..throughFunction) - a function to process each chunk

- [options] object - passed to the returned stream constructor



#### via~throughFunction : function

**Kind**: inner typedef of [via](#exp_module_stream-via--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](https://github.com/jsdoc2md/jsdoc-to-markdown).