# decompress-unzip

> decompress zip plugin

Latest version **4.0.1** (published 2016-05-20) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.1 |
| Published | 2016-05-20 |
| First published | 2014-06-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 26 |
| Author | Kevin Mårtensson |
| Maintainers | kevva, shinnn |
| Keywords | decompress, decompressplugin, extract, zip |

## Links

- npm: https://www.npmjs.com/package/decompress-unzip
- Repository: https://github.com/kevva/decompress-unzip
- Homepage: https://github.com/kevva/decompress-unzip#readme
- Issues: https://github.com/kevva/decompress-unzip/issues
- npm.io page: https://npm.io/package/decompress-unzip

## Dependencies (4)

- [pify](https://npm.io/package/pify.md) ^2.3.0
- [yauzl](https://npm.io/package/yauzl.md) ^2.4.2
- [file-type](https://npm.io/package/file-type.md) ^3.8.0
- [get-stream](https://npm.io/package/get-stream.md) ^2.2.0

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

- 4.0.1 (latest) — 2016-05-20
- 4.0.0 — 2016-05-20
- 3.4.0 — 2015-10-16
- 3.3.0 — 2015-07-04
- 3.2.2 — 2015-04-03
- 3.2.1 — 2015-04-02
- 3.2.0 — 2015-04-01
- 3.1.0 — 2015-03-24
- 3.0.0 — 2015-03-09
- 2.1.2 — 2015-02-15
- 2.1.1 — 2015-02-13
- 2.0.1 — 2014-09-16
- 2.0.0 — 2014-09-13
- 1.0.0 — 2014-08-19
- 0.1.2 — 2014-06-13
- … 2 more at https://npm.io/package/decompress-unzip/versions

## README

# decompress-unzip [![Build Status](https://travis-ci.org/kevva/decompress-unzip.svg?branch=master)](https://travis-ci.org/kevva/decompress-unzip)

> zip decompress plugin


## Install

```
$ npm install --save decompress-unzip
```


## Usage

```js
const decompress = require('decompress');
const decompressUnzip = require('decompress-unzip');

decompress('unicorn.zip', 'dist', {
	plugins: [
		decompressUnzip()
	]
}).then(() => {
	console.log('Files decompressed');
});
```


## API

### decompressUnzip()(buf)

#### buf

Type: `Buffer`

Buffer to decompress.


## License

MIT © [Kevin Mårtensson](https://github.com/kevva)

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