# decompress-archive

> Extract/decompress archives. Node only.

Latest version **0.3.0** (published 2017-09-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install decompress-archive
pnpm add decompress-archive
yarn add decompress-archive
bun add decompress-archive
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2017-09-05 |
| First published | 2017-09-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jannis R |
| Maintainers | derhuerst |
| Keywords | zip, unzip, tar, gz, gzip, tar.gz |

## Links

- npm: https://www.npmjs.com/package/decompress-archive
- Repository: https://github.com/derhuerst/decompress-archive
- Issues: https://github.com/derhuerst/decompress-archive/issues
- npm.io page: https://npm.io/package/decompress-archive

## Dependencies (1)

- [any-shell-escape](https://npm.io/package/any-shell-escape.md) ^0.1.1

## Alternatives

- [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads
- [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads
- [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads
- [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads
- [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads

## Recent versions

- 0.3.0 (latest) — 2017-09-05
- 0.2.0 — 2017-09-05
- 0.1.1 — 2017-09-05
- 0.1.0 — 2017-09-05

## 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).

---
_Source: https://npm.io/package/decompress-archive · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._