ghaction-upx/node_modules/decompress-tar/readme.md

45 lines
753 B
Markdown
Raw Normal View History

2020-01-17 01:36:42 -07:00
# decompress-tar [![Build Status](https://travis-ci.org/kevva/decompress-tar.svg?branch=master)](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)