UNPKG

1.06 kBMarkdownView Raw
1# pumpify
2
3Combine an array of streams into a single duplex stream using [pump](https://github.com/mafintosh/pump) and [duplexify](https://github.com/mafintosh/duplexify).
4If one of the streams closes/errors all streams in the pipeline will be destroyed.
5
6```
7npm install pumpify
8```
9
10## Usage
11
12Pass the streams you want to pipe together to pumpify `pipeline = pumpify(s1, s2, s3, ...)`.
13`pipeline` is a duplex stream that writes to the first streams and reads from the last one.
14Streams are piped together using [pump](https://github.com/mafintosh/pump) so if one of them closes
15all streams will be destroyed.
16
17``` js
18var pumpify = require('pumpify')
19var tar = require('tar-fs')
20var zlib = require('zlib')
21var fs = require('fs')
22
23var untar = pumpify(zlib.createGunzip(), tar.extract('output-folder'))
24
25fs.createReadStream('some-gzipped-tarball.tgz').pipe(untar)
26```
27
28If you are pumping object streams together use `pipeline = pumpify.obj(s1, s2, ...)`.
29Call `pipeline.destroy()` to destroy the pipeline (including the streams passed to pumpify).
30
31## License
32
33MIT
\No newline at end of file