ubdate
This commit is contained in:
44
node_modules/decompress-tar/readme.md
generated
vendored
Normal file
44
node_modules/decompress-tar/readme.md
generated
vendored
Normal file
@@ -0,0 +1,44 @@
|
||||
# decompress-tar [](https://travis-ci.org/kevva/decompress-tar)
|
||||
|
||||
> tar decompress plugin
|
||||
|
||||
|
||||
## Install
|
||||
|
||||
```
|
||||
$ npm install decompress-tar
|
||||
```
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
const decompress = require('decompress');
|
||||
const decompressTar = require('decompress-tar');
|
||||
|
||||
decompress('unicorn.tar', 'dist', {
|
||||
plugins: [
|
||||
decompressTar()
|
||||
]
|
||||
}).then(() => {
|
||||
console.log('Files decompressed');
|
||||
});
|
||||
```
|
||||
|
||||
|
||||
## API
|
||||
|
||||
### decompressTar()(input)
|
||||
|
||||
Returns both a Promise for a Buffer and a [Duplex stream](https://nodejs.org/api/stream.html#stream_class_stream_duplex).
|
||||
|
||||
#### input
|
||||
|
||||
Type: `Buffer` `Stream`
|
||||
|
||||
Buffer or stream to decompress.
|
||||
|
||||
|
||||
## License
|
||||
|
||||
MIT © [Kevin Mårtensson](https://github.com/kevva)
|
||||
Reference in New Issue
Block a user