length-stream
v0.1.1 stream streams2 length filter through pipe
length-stream
Simple pass-through stream (RW) which accumulates the length of the stream.
Installation
npm install length-stream
Usage
If you provide a lengthListener when you construct the stream, it will be called with the resultant length of the stream just prior to end being emitted.
lengthStream(lengthListener)
- constructs a new stream instance, lengthListener will be called prior to theend
event being emittedlengthListener
function signature isfn(resultantLength)
var lengthStream = require('length-stream');
var resultLength;
function lengthListener(length) {
resultLength = length;
}
var lstream = lengthStream(lengthListener); // create instance, lengthListener will get length
readstream
.pipe(lstream) // length calculated as it passes through
.pipe(...)
Goals
- Easy to use pass-through stream which calculates the length of the string
- Builds on pass-stream to have all the normal pass-through functionality for a spec compliant stream
Why
I find that when I am accumulating stream data, that I often need the resultant length, so rather than write the code over and over again to do that, this simple stream can be piped through and it will provide the resultant length when the stream ends by calling
Get involved
If you have input or ideas or would like to get involved, you may:
- contact me via twitter @jeffbski - http://twitter.com/jeffbski
- open an issue on github to begin a discussion - https://github.com/jeffbski/length-stream/issues
- fork the repo and send a pull request (ideally with tests) - https://github.com/jeffbski/length-stream
License
npm i length-stream
Source Code
github.com/jeffbski/length-s...Metadata
- Unknown
- >=0.8
- Jeff Barczewski
- released 4/12/2013