https://github.com/derhuerst/decompress-archive

Extract/decompress archives. Node only.
https://github.com/derhuerst/decompress-archive

gz gzip tar tar-gz unzip zip

Last synced: about 1 month ago
JSON representation

Extract/decompress archives. Node only.

• Host: GitHub
• URL: https://github.com/derhuerst/decompress-archive
• Owner: derhuerst
• License: isc
• Created: 2017-09-05T13:14:44.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-09-05T13:39:08.000Z (over 7 years ago)
• Last Synced: 2024-10-03T23:55:08.991Z (3 months ago)
• Topics: gz, gzip, tar, tar-gz, unzip, zip
• Language: JavaScript
• Homepage: https://github.com/derhuerst/decompress-archive
• Size: 6.84 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

README

        
# decompress-archive

**Extract/decompress archives.** Uses native CLI tools such as `unzip` and `tar` and therefore only works in Node.js.

Similar to [decompress](https://github.com/kevva/decompress#decompress-) and [compressjs](https://github.com/cscott/compressjs#compressjs). `decompress-archive` however

- should be faster because it uses native `unzip` etc,

- is more lightweight, but *does not* work in the browser,

- has no command line interface.

[![npm version](https://img.shields.io/npm/v/decompress-archive.svg)](https://www.npmjs.com/package/decompress-archive)

![ISC-licensed](https://img.shields.io/github/license/derhuerst/decompress-archive.svg)

[![chat on gitter](https://badges.gitter.im/derhuerst.svg)](https://gitter.im/derhuerst)

## Installing

```shell

npm install decompress-archive

```

## Usage

```js

const decompress = require('decompress-archive')

decompress('path/to/archive.zip', 'path/to/dest', (err) => {

	if (err) console.error(err)

})

```

## API

```js

decompress(archive, dest, [flatten], cb)

```

## Contributing

If you have a question or have difficulties using `decompress-archive`, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, refer to [the issues page](https://github.com/derhuerst/decompress-archive/issues).