Stream collect
Collects a readable streams data as a string buffer or, for object streams, an array.
npm install stream-collect
collect( stream, [encoding], [cb] )
Collect the contents of a stream. The collected data will either be a Buffer
, String
or Array
depending on whether encoding
has been supplied, or it is an object stream.
Returns a Promise
that will resolve with the collected data.
stream
the stream to collectencoding
the encoding to return data incb
a callback that will be called with the collected data.
var collect = require('stream-collect');
var file = fs.createReadableStream( 'myfile' );
collect(file)
.then( function(theWholeFile) {
} );
collect( file, function(theWholeFile) {
} )
collect( file, 'base64' )
.then( function(theWholeFileInBase64) {
} );
collect.PassThrough()
A PassThrough stream that has been augmented with a collect event. This will be emitted in the end
event with the collected contents of the stream.
var collect = require('stream-collect');
var file = fs.createReadableStream( 'myfile' );
file.pipe( new collect.PassThrough() )
.on( 'collect', function(data) {
} );
collect.addToStream(stream)
Augment any stream with the collect event used on collect.PassThrough
.
Returns the augmented stream.