website/node_modules/decompress-targz/readme.md

In JohnCoene/chirp: 'Twitter' Networks Analyser

decompress-targz

tar.gz decompress plugin

Install

$ npm install decompress-targz

Usage

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.

input

Type: Buffer Stream

Buffer or stream to decompress.

License

MIT © Kevin Mårtensson

JohnCoene/chirp documentation built on May 25, 2021, 6:33 p.m.