Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

progress-extract

yibn2008113ISC1.0.2

extract compress file with progress bar

progress-extract

readme

progress-extract

extract compress file with progress bar, support CLI and node API

Screenshot

progress-extract

CLI

Install

Install as a global module

$ npm install progress-extract -g

Usage

Use extract command to extract file

$ extract -h

  Usage: extract <file>

  extract file with progress bar


  Options:

    -V, --version          output the version number
    -d, --directory <dir>  target dir to extract
    -h, --help             output usage information

  Examples:

    $ extract example.tar.gz

Node API

Usage

const extract = require('progress-extract')

let file = '/path/to/example.tar.gz'
let target = process.cwd()
extract(file, target)
  .then(() => {
    console.log('extract succeed')
  }, err => {
    console.log('extract failed')
  })

API

extract(source, [destination])
  • source: source file (support .zip, .tgz, .tar.gz)
  • destination: path where you extract to

Return Promise

License

MIT

changelog

1.0.2 / 2017-07-28

  • chore: bump to 1.0.2
  • fix: fix tty fd

1.0.1 / 2017-07-28

  • chore: bump to 1.0.1
  • fix: add renderThrottle

1.0.0 / 2017-07-27

  • init