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