https://github.com/mafintosh/stream-each

Iterate all the data in a stream
https://github.com/mafintosh/stream-each

Last synced: 5 days ago
JSON representation

Iterate all the data in a stream

• Host: GitHub
• URL: https://github.com/mafintosh/stream-each
• Owner: mafintosh
• License: mit
• Created: 2015-10-18T20:40:24.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-07-30T17:59:00.000Z (over 6 years ago)
• Last Synced: 2024-04-26T08:47:37.118Z (6 months ago)
• Language: JavaScript
• Size: 10.7 KB
• Stars: 37
• Watchers: 4
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-nodejs - stream-each - Iterate all the data in a stream. (Repository / Streams)
• awesome-nodejs-streams - mafintosh/stream-each - Iterate all the data in a stream (Modules)

README

        
# stream-each

Iterate all the data in a stream

```

npm install stream-each

```

[![build status](http://img.shields.io/travis/mafintosh/stream-each.svg?style=flat)](http://travis-ci.org/mafintosh/stream-each)

## Usage

``` js

var each = require('stream-each')

each(stream, function (data, next) {

  console.log('data from stream', data)

  // when ready to consume next chunk

  next()

}, function (err) {

  console.log('no more data')

})

```

## API

#### `each(stream, iterator, cb)`

Iterate the data in the stream by calling the iterator function with `(data, next)`

where data is a data chunk and next is a callback. Call next when you are ready to

consume the next chunk. Optionally you can call next with an error to destroy the stream

When the stream ends/errors the callback is called if provided

## License

MIT

## Related

`stream-each` is part of the [mississippi stream utility collection](https://github.com/maxogden/mississippi) which includes more useful stream modules similar to this one.