diff options
Diffstat (limited to 'node_modules/decompress-tarbz2/readme.md')
-rw-r--r-- | node_modules/decompress-tarbz2/readme.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/node_modules/decompress-tarbz2/readme.md b/node_modules/decompress-tarbz2/readme.md new file mode 100644 index 0000000..6fa0727 --- /dev/null +++ b/node_modules/decompress-tarbz2/readme.md @@ -0,0 +1,44 @@ +# 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) |