Nulo/tar-stream
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update README.md

Browse source 
Mention the need to drain entry streams or else the main stream gets backpressure
This commit is contained in:
Stephen Whitmore 2016-06-15 11:42:33 -07:00 committed by GitHub
parent f50e71b53a
commit 4210140046
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -75,6 +75,8 @@ extract.on('finish', function() {
pack.pipe(extract)
```
The tar archive is streamed sequentially, meaning you **must** drain each entry's stream as you get them or else the main extract stream will receive backpressure and stop reading.
## Headers
The header object using in `entry` should contain the following properties.