1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
# decompress [](https://travis-ci.org/kevva/decompress)
> Extracting archives made easy
*See [decompress-cli](https://github.com/kevva/decompress-cli) for the command-line version.*
## Install
```
$ npm install decompress
```
## Usage
```js
const decompress = require('decompress');
decompress('unicorn.zip', 'dist').then(files => {
console.log('done!');
});
```
## API
### decompress(input, [output], [options])
Returns a Promise for an array of files in the following format:
```js
{
data: Buffer,
mode: Number,
mtime: String,
path: String,
type: String
}
```
#### input
Type: `string` `Buffer`
File to decompress.
#### output
Type: `string`
Output directory.
#### options
##### filter
Type: `Function`
Filter out files before extracting. E.g:
```js
decompress('unicorn.zip', 'dist', {
filter: file => path.extname(file.path) !== '.exe'
}).then(files => {
console.log('done!');
});
```
*Note that in the current implementation, **`filter` is only applied after fully reading all files from the archive in memory**. Do not rely on this option to limit the amount of memory used by `decompress` to the size of the files included by `filter`. `decompress` will read the entire compressed file into memory regardless.*
##### map
Type: `Function`
Map files before extracting: E.g:
```js
decompress('unicorn.zip', 'dist', {
map: file => {
file.path = `unicorn-${file.path}`;
return file;
}
}).then(files => {
console.log('done!');
});
```
##### plugins
Type: `Array`<br>
Default: `[decompressTar(), decompressTarbz2(), decompressTargz(), decompressUnzip()]`
Array of [plugins](https://www.npmjs.com/browse/keyword/decompressplugin) to use.
##### strip
Type: `number`<br>
Default: `0`
Remove leading directory components from extracted files.
## License
MIT © [Kevin Mårtensson](https://github.com/kevva)
|
