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

45 lines
777 B
Markdown
Raw Normal View History

2020-01-17 01:36:42 -07:00
# decompress-tarbz2 [![Build Status](https://travis-ci.org/kevva/decompress-tarbz2.svg?branch=master)](https://travis-ci.org/kevva/decompress-tarbz2)
> tar.bz2 decompress plugin
## Install
```
$ npm install decompress-tarbz2
```
## Usage
```js
const decompress = require('decompress');
const decompressTarbz = require('decompress-tarbz2');
decompress('unicorn.tar.gz', 'dist', {
plugins: [
decompressTarbz()
]
}).then(() => {
console.log('Files decompressed');
});
```
## API
### decompressTarbz()(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 to decompress.
## License
MIT © [Kevin Mårtensson](https://github.com/kevva)