# gunzip-stream

> Gunzip a stream if needed

Latest version **1.0.1** (published 2018-01-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install gunzip-stream
pnpm add gunzip-stream
yarn add gunzip-stream
bun add gunzip-stream
```

## 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 | 1.0.1 |
| Published | 2018-01-21 |
| First published | 2018-01-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 6 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Jérôme Desboeufs |
| Maintainers | jdesboeufs |

## Links

- npm: https://www.npmjs.com/package/gunzip-stream
- Repository: https://github.com/jdesboeufs/gunzip-stream
- Homepage: https://github.com/jdesboeufs/gunzip-stream#readme
- Issues: https://github.com/jdesboeufs/gunzip-stream/issues
- npm.io page: https://npm.io/package/gunzip-stream

## Dependencies (1)

- [is-gzip](https://npm.io/package/is-gzip.md) ^2.0.0

## Recent versions

- 1.0.1 (latest) — 2018-01-21
- 1.0.0 — 2018-01-21

## README

# gunzip-stream [![npm version](https://img.shields.io/npm/v/gunzip-stream.svg)](https://www.npmjs.com/package/gunzip-stream) [![Build Status](https://travis-ci.org/jdesboeufs/gunzip-stream.svg?branch=master)](https://travis-ci.org/jdesboeufs/gunzip-stream)

> Gunzip a stream if needed

`Transform` stream which acts as `zlib.Gunzip` if input is gzipped. Fallback otherwise to a simple `PassThrough` stream.

## Install

```
$ npm install gunzip-stream
```


## Usage

```js
const fs = require('http');
const {createGunzip} = require('gunzip-stream');

fs.createReadStream('/path/to/file.gz.or.not')
  .pipe(createGunzip())
  .pipe(process.stdout)
```

## License

MIT

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