Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cowboy/node-stream-eachline
Like readline or split, but behaves more like ruby's .each_with_index method when streams lack trailing newlines.
https://github.com/cowboy/node-stream-eachline
Last synced: 30 days ago
JSON representation
Like readline or split, but behaves more like ruby's .each_with_index method when streams lack trailing newlines.
- Host: GitHub
- URL: https://github.com/cowboy/node-stream-eachline
- Owner: cowboy
- License: mit
- Created: 2014-05-28T20:32:55.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-05-28T21:35:55.000Z (over 10 years ago)
- Last Synced: 2024-10-14T14:18:16.271Z (2 months ago)
- Language: JavaScript
- Size: 119 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# stream-eachline [](http://travis-ci.org/cowboy/node-stream-eachline)
Like readline or split, but behaves more like ruby's `.each_with_index` method when streams lack trailing newlines.
## Getting Started
Install the module with: `npm install stream-eachline`
```javascript
var eachline = require('stream-eachline').eachline;
// Modify each line in process.stdin input stream (while streaming)
// and when done log an array of modified lines.
eachline(process.stdin, function(line, index) {
return '[' + index + '] ' + line.toUpperCase();
}, function(lines) {
console.log('Array of modified lines:', lines);
});
// The following examples all do the same thing:
eachline(process.stdin, function(line, index) {
return line;
}, function(lines) {
doSomethingWithLines(lines);
});
// You may omit lineFunction if you don't need to modify the streamed lines.
eachline(process.stdin, doSomethingWithLines);
// You may omit instream if you want to process process.stdin's lines.
eachline(doSomethingWithLines);
```
## Documentation
`eachline([instream], [lineFunction], doneFunction)`
## Why this library?
```bash
# I couldn't get readline to give me the last line of a stream if there
# was no trailing newline.
$ echo -en 'foo\nbar\nbaz\n' | node examples/readline-broken.js
[ '[0] ', '[1] ', '[2] ' ]
$ echo -en 'foo\nbar\nbaz' | node examples/readline-broken.js
[ '[0] ', '[1] ' ]
# This is the behavior I expected, based on my experience with ruby's
# STDIN.each_with_index method.
$ echo -en 'foo\nbar\nbaz\n' | ruby examples/each-with-index.rb
["[0] ", "[1] ", "[2] "]
$ echo -en 'foo\nbar\nbaz' | ruby examples/each-with-index.rb
["[0] ", "[1] ", "[2] "]
# This lib behaves more like ruby's STDIN.each_with_index method.
$ echo -en 'foo\nbar\nbaz\n' | node examples/eachline-yay.js
[ '[0] ', '[1] ', '[2] ' ]
$ echo -en 'foo\nbar\nbaz' | node examples/eachline-yay.js
[ '[0] ', '[1] ', '[2] ' ]
```
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
## Release History
_(Nothing yet)_
## License
Copyright (c) 2014 "Cowboy" Ben Alman
Licensed under the MIT license.