UNPKG

1.64 kBMarkdownView Raw
1# unzip
2
3Streaming cross-platform unzip tool written in node.js.
4
5Unzip uses the zlib inflation built into the core of node.js so there are no compiled dependencies. Unzip is also an
6example use case of [node-pullstream](https://github.com/nearinfinity/node-pullstream).
7
8## Installation
9
10```bash
11$ npm install unzip
12```
13
14## Quick Example
15
16```javascript
17var readStream = fs.createReadStream('path/to/archive.zip');
18var writeStream = fstream.Writer('output/path');
19
20fs.createReadStream(readStream).pipe(unzip.Parse()).pipe(writeStream);
21```
22
23## License
24
25(The MIT License)
26
27Copyright (c) 2012 Near Infinity Corporation
28
29Permission is hereby granted, free of charge, to any person obtaining
30a copy of this software and associated documentation files (the
31"Software"), to deal in the Software without restriction, including
32without limitation the rights to use, copy, modify, merge, publish,
33distribute, sublicense, and/or sell copies of the Software, and to
34permit persons to whom the Software is furnished to do so, subject to
35the following conditions:
36
37The above copyright notice and this permission notice shall be
38included in all copies or substantial portions of the Software.
39
40THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
41EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
42MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
43NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
44LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
45OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
46WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\No newline at end of file