# lws-compress

> Response compression middleware for lws

Latest version **3.1.0** (published 2021-08-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install lws-compress
pnpm add lws-compress
yarn add lws-compress
bun add lws-compress
```

## 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 | 3.1.0 |
| Published | 2021-08-14 |
| First published | 2017-03-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=12.17 |
| Dependencies | 1 |
| Unpacked size | 3.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Lloyd Brookes |
| Maintainers | 75lb |
| Keywords | lws, lws-middleware |

## Links

- npm: https://www.npmjs.com/package/lws-compress
- Repository: https://github.com/lwsjs/compress
- Homepage: https://github.com/lwsjs/compress#readme
- Issues: https://github.com/lwsjs/compress/issues
- npm.io page: https://npm.io/package/lws-compress

## Dependencies (1)

- [koa-compress](https://npm.io/package/koa-compress.md) ^5.0.1

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 3.1.0 (latest) — 2021-08-14
- 3.0.0 — 2021-02-16
- 2.0.0 — 2020-02-09
- 1.0.2 — 2019-06-09
- 1.0.1 — 2019-06-03
- 1.0.0 — 2019-05-27
- 0.2.1 — 2017-06-25
- 0.2.0 — 2017-06-18
- 0.1.0 — 2017-03-19

## README

[![view on npm](https://badgen.net/npm/v/lws-compress)](https://www.npmjs.org/package/lws-compress)
[![npm module downloads](https://badgen.net/npm/dt/lws-compress)](https://www.npmjs.org/package/lws-compress)
[![Gihub repo dependents](https://badgen.net/github/dependents-repo/lwsjs/compress)](https://github.com/lwsjs/compress/network/dependents?dependent_type=REPOSITORY)
[![Gihub package dependents](https://badgen.net/github/dependents-pkg/lwsjs/compress)](https://github.com/lwsjs/compress/network/dependents?dependent_type=PACKAGE)
[![Node.js CI](https://github.com/lwsjs/compress/actions/workflows/node.js.yml/badge.svg)](https://github.com/lwsjs/compress/actions/workflows/node.js.yml)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)

# lws-compress

Response compression middleware for lws. For usage instructions, see [here](https://github.com/lwsjs/local-web-server/wiki/How-to-use-response-compression).

Adds the following options to lws.

```
--compress, -z                 Serve gzip-compressed resources, where applicable.
--compress.threshold number    Minimum response size in bytes to apply compression. Defaults to 1024.
```

* * *

&copy; 2016-21 Lloyd Brookes \<75pound@gmail.com\>.

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