# decompress-gz

> decompress gz plugin

Latest version **0.0.1** (published 2017-07-01) · MIT license · 0 weekly downloads

## Install

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

## 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.0.1 |
| Published | 2017-07-01 |
| First published | 2017-07-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Carlos Carmona |
| Maintainers | carloscarmona |
| Keywords | decompress, decompressplugin, extract, gz, gunzip |

## Links

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

## Dependencies (1)

- [file-type](https://npm.io/package/file-type.md) ^5.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

- 0.0.1 (latest) — 2017-07-01

## README

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

> gz decompress plugin


## Install

```
$ npm install --save decompress-gz
```


## Usage

```js
const decompress = require('decompress');
const decompressGz = require('decompress-gz');

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


## API

### decompressGz()(input)

Returns both a Promise for a Buffer.

#### input

Type: `Buffer`

Buffer to decompress.


## License

MIT © [Carlos Carmona](https://github.com/ccarmona)

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