1.5 KiB
1.5 KiB
minipass-collect
A Minipass stream that collects all the data into a single chunk
Note that this buffers ALL data written to it, so it’s only good for situations where you are sure the entire stream fits in memory.
Note: this is primarily useful for the
Collect.PassThrough
class, since Minipass streams already
have a .collect()
method which returns a promise that
resolves to the array of chunks, and a .concat()
method
that returns the data concatenated into a single Buffer or String.
USAGE
const Collect = require('minipass-collect')
const collector = new Collect()
.on('data', allTheData => {
collectorconsole.log('all the data!', allTheData)
})
.pipe(collector)
someSourceOfData
// note that you can also simply do:
.pipe(new Minipass()).concat().then(data => ...)
someSourceOfData// or even, if someSourceOfData is a Minipass:
.concat().then(data => ...)
someSourceOfData// but you might prefer to have it stream-shaped rather than
// Promise-shaped in some scenarios.
If you want to collect the data, but also act as a
passthrough stream, then use Collect.PassThrough
instead
(for example to memoize streaming responses), and listen on the
collect
event.
const Collect = require('minipass-collect')
const collector = new Collect.PassThrough()
.on('collect', allTheData => {
collectorconsole.log('all the data!', allTheData)
})
.pipe(collector).pipe(someOtherStream) someSourceOfData
All minipass options are supported.