@xhmikosr/decompress-unzip/readme.md

decompress zip plugin

# decompress-unzip [![npm version](https://img.shields.io/npm/v/@xhmikosr/decompress-unzip?logo=npm&logoColor=fff)](https://www.npmjs.com/package/@xhmikosr/decompress-unzip) [![CI Status](https://img.shields.io/github/actions/workflow/status/XhmikosR/decompress-unzip/ci.yml?branch=master&label=CI&logo=github)](https://github.com/XhmikosR/decompress-unzip/actions/workflows/ci.yml?query=branch%3Amaster)

> zip decompress plugin


## Install

```sh
npm install @xhmikosr/decompress-unzip
```


## Usage

```js
import decompress from '@xhmikosr/decompress';
import decompressUnzip from '@xhmikosr/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)