Simple processing of Readables

Consume a node Readable stream in chunks using an async process function. This is especially useful for implementing stream based parsers, or consuming objectMode streams.

Usage

var streamprocess = require('streamprocess');

var r = fs.createReadStream(…);

streamprocess(r, function(buf, cb) {
  // do your thing
  …

  // signal that you are done
  setImmediate(cb);
});

Installation

npm install streamprocess

Methods

There is just one method, returned directly from the module import.

streamprocess(readable, processFn, [doneCb])

Consume readable by retrieving buffers one at a time, passing them to processFn(buf, cb).

A doneCb(err) will be called after the stream has ended or encountered an error.

License

(BSD 2-Clause License)

Copyright (c) 2013-2015, Gil Pedersen <gpdev@gpost.dk>
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.