diff options
author | Minteck <nekostarfan@gmail.com> | 2021-08-24 14:41:48 +0200 |
---|---|---|
committer | Minteck <nekostarfan@gmail.com> | 2021-08-24 14:41:48 +0200 |
commit | d25e11bee6ca5ca523884da132d18e1400e077b9 (patch) | |
tree | 8af39fde19f7ed640a60fb397c7edd647dff1c4c /node_modules/decompress-targz/readme.md | |
download | kartik-iridium-d25e11bee6ca5ca523884da132d18e1400e077b9.tar.gz kartik-iridium-d25e11bee6ca5ca523884da132d18e1400e077b9.tar.bz2 kartik-iridium-d25e11bee6ca5ca523884da132d18e1400e077b9.zip |
Initial commit
Diffstat (limited to 'node_modules/decompress-targz/readme.md')
-rw-r--r-- | node_modules/decompress-targz/readme.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/node_modules/decompress-targz/readme.md b/node_modules/decompress-targz/readme.md new file mode 100644 index 0000000..a05c8f9 --- /dev/null +++ b/node_modules/decompress-targz/readme.md @@ -0,0 +1,44 @@ +# decompress-targz [![Build Status](https://travis-ci.org/kevva/decompress-targz.svg?branch=master)](https://travis-ci.org/kevva/decompress-targz) + +> tar.gz decompress plugin + + +## Install + +``` +$ npm install decompress-targz +``` + + +## Usage + +```js +const decompress = require('decompress'); +const decompressTargz = require('decompress-targz'); + +decompress('unicorn.tar.gz', 'dist', { + plugins: [ + decompressTargz() + ] +}).then(() => { + console.log('Files decompressed'); +}); +``` + + +## API + +### decompressTargz()(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) |