# zlib

> Simple, synchronous deflate/inflate for buffers

Latest version **1.0.5** (published 2011-08-08) · 0 weekly downloads

## Install

```sh
npm install zlib
pnpm add zlib
yarn add zlib
bun add zlib
```

## 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.5 |
| Published | 2011-08-08 |
| First published | 2011-03-11 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.2.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 63 |
| Author | Konstantin Käfer |
| Maintainers | kkaefer, tmcw, yhahn, willwhite, springmeyer |

## Links

- npm: https://www.npmjs.com/package/zlib
- Repository: https://github.com/kkaefer/node-zlib
- npm.io page: https://npm.io/package/zlib

## Recent versions

- 1.0.5 (latest) — 2011-08-08
- 1.0.4 — 2011-06-22
- 1.0.3 — 2011-03-29
- 1.0.2 — 2011-03-11
- 1.0.1 — 2011-03-11
- 1.0.0 — 2011-03-11

## README

# NAME

node-zlib - Simple, synchronous deflate/inflate for node.js buffers.



# USAGE

Install with `npm install zlib`.

    var Buffer = require('buffer').Buffer;
    var zlib = require('zlib');
    
    var input = new Buffer('lorem ipsum dolor sit amet');
    var compressed = zlib.deflate(input);
    var output = zlib.inflate(compressed);

Note that `node-zlib` is only intended for small (< 128 KB) data that you already have buffered. It is not meant for input/output streams.

# BUILDING

Make sure you have `zlib` installed. Mac OS X ships with it by default.

To obtain and build the bindings:

    git clone git://github.com/kkaefer/node-zlib.git
    cd node-zlib
    ./configure
    make

You can also use [`npm`](https://github.com/isaacs/npm) to download and install them:

    npm install zlib



# TESTS

[expresso](https://github.com/visionmedia/expresso) is required to run unit tests.

    npm install expresso
    make test



# CONTRIBUTORS

* [Konstantin Käfer](https://github.com/kkaefer)



# LICENSE

`node-zlib` is [BSD licensed](https://github.com/kkaefer/node-zlib/raw/master/LICENSE).

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