https://github.com/deno-libs/http_compression
🗜️ Deno HTTP compression middleware
https://github.com/deno-libs/http_compression
compress compression deflate deno deno-server gzip http
Last synced: about 1 month ago
JSON representation
🗜️ Deno HTTP compression middleware
- Host: GitHub
- URL: https://github.com/deno-libs/http_compression
- Owner: deno-libs
- License: mit
- Created: 2021-03-22T14:11:25.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-23T21:31:43.000Z (about 2 years ago)
- Last Synced: 2024-08-04T00:06:24.041Z (10 months ago)
- Topics: compress, compression, deflate, deno, deno-server, gzip, http
- Language: TypeScript
- Homepage: https://deno.land/x/http_compression
- Size: 43 KB
- Stars: 38
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# http_compression
[![nest badge][nest-badge]](https://nest.land/package/compression)
[![GitHub Workflow Status][gh-actions-img]][github-actions]
[![Codecov][cov-badge]][cov] [![][docs-badge]][docs]
[![][code-quality-img]][code-quality]
Deno HTTP compression middleware.
## Features
- `gzip`, `deflate` and `brotli` support
- Detects supported encodings with `Accept-Encoding` header
- Respects encodings order (depending on `Accept-Encoding` value)
- Creates a `Content-Encoding` header with applied compression
- Send `409 Not Acceptable` if encoding is not supported
## Example
```ts
import { compression } from 'https://deno.land/x/http_compression/mod.ts'
import { Server } from 'https://deno.land/http/server.ts'
const s = new Server({
handler: async (req) => {
return await compression({
path: 'README.md',
compression: ['br', 'gzip', 'deflate'],
})(req)
},
addr: ':3000',
})
s.listenAndServe()
```
Now try to send a `HEAD` request with `curl`:
```sh
$ curl localhost:3000 --head -H "Accept-Encoding: br, gzip, deflate" --compressed
HTTP/1.1 200 OK
content-length: 550
content-encoding: br, gzip, deflate
```
[docs-badge]: https://img.shields.io/github/v/release/deno-libs/http_compression?label=Docs&logo=deno&style=for-the-badge&color=black
[docs]: https://doc.deno.land/https/deno.land/x/http_compression/mod.ts
[gh-actions-img]: http://img.shields.io/github/actions/workflow/status/deno-libs/http_compression/main.yml?branch=master&style=for-the-badge&logo=github&label=&color=black
[github-actions]: https://github.com/deno-libs/http_compression/actions
[cov]: https://coveralls.io/github/deno-libs/http_compression
[cov-badge]: https://img.shields.io/coveralls/github/deno-libs/http_compression?style=for-the-badge&color=black
[nest-badge]: https://img.shields.io/badge/publushed%20on-nest.land-black?style=for-the-badge
[code-quality-img]: https://img.shields.io/codefactor/grade/github/deno-libs/http_compression?style=for-the-badge&color=black
[code-quality]: https://www.codefactor.io/repository/github/deno-libs/http_compression