Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codedredd/h3-compression
Adds compression to h3 requests (brotli, gzip, deflate)
https://github.com/codedredd/h3-compression
brotli compression deflate gzip h3 nuxt3
Last synced: 11 days ago
JSON representation
Adds compression to h3 requests (brotli, gzip, deflate)
- Host: GitHub
- URL: https://github.com/codedredd/h3-compression
- Owner: CodeDredd
- License: mit
- Created: 2023-08-29T14:00:37.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-05T14:26:31.000Z (6 months ago)
- Last Synced: 2024-10-13T12:45:19.949Z (about 1 month ago)
- Topics: brotli, compression, deflate, gzip, h3, nuxt3
- Language: TypeScript
- Homepage:
- Size: 151 KB
- Stars: 68
- Watchers: 1
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# H3-compression
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![bundle][bundle-src]][bundle-href]
[![JSDocs][jsdocs-src]][jsdocs-href]
[![License][license-src]][license-href]
> Handles compression for H3
## Features
✔️ **Zlib Compression:** You can use zlib compression (brotli, gzip and deflate)
✔️ **Stream Compression:** You can use native stream compressions (gzip, deflate)
✔️ **Compression Detection:** It uses the best compression which is accepted
## Install
```bash
# Using npm
npm install h3-compression
# Using yarn
yarn add h3-compression
# Using pnpm
pnpm add h3-compression
```
## Usage
```ts
import { createServer } from 'node:http'
import { createApp, eventHandler, toNodeListener } from 'h3'
import { useCompressionStream } from 'h3-compression'
const app = createApp({ onBeforeResponse: useCompressionStream }) // or { onBeforeResponse: useCompression }
app.use(
'/',
eventHandler(() => 'Hello world!'),
)
createServer(toNodeListener(app)).listen(process.env.PORT || 3000)
```
Example using listhen for an elegant listener:
```ts
import { createApp, eventHandler, toNodeListener } from 'h3'
import { listen } from 'listhen'
import { useCompressionStream } from 'h3-compression'
const app = createApp({ onBeforeResponse: useCompressionStream }) // or { onBeforeResponse: useCompression }
app.use(
'/',
eventHandler(() => 'Hello world!'),
)
listen(toNodeListener(app))
```
## Nuxt 3
If you want to use it in nuxt 3 you can define a nitro plugin.
`server/plugins/compression.ts`
````ts
import { useCompression } from 'h3-compression'
export default defineNitroPlugin((nitro) => {
nitro.hooks.hook('render:response', async (response, { event }) => {
if (!response.headers?.['content-type']?.startsWith('text/html'))
return
await useCompression(event, response)
})
})
````
> [!NOTE]
> `useCompressionStream` doesn't work right now in nitro. So you just can use `useCompression`
## Utilities
H3-compression has a concept of composable utilities that accept `event` (from `eventHandler((event) => {})`) as their first argument and `response` as their second.
#### Zlib Compression
- `useGZipCompression(event, response)`
- `useDeflateCompression(event, response)`
- `useBrotliCompression(event, response)`
- `useCompression(event, response)`
#### Stream Compression
- `useGZipCompressionStream(event, response)`
- `useDeflateCompressionStream(event, response)`
- `useCompressionStream(event, response)`
## Sponsors
## Releated Projects
- [H3](https://github.com/unjs/h3)
## License
[MIT](./LICENSE) License © 2023-PRESENT [Gregor Becker](https://github.com/CodeDredd)
[npm-version-src]: https://img.shields.io/npm/v/h3-compression?style=flat&colorA=080f12&colorB=1fa669
[npm-version-href]: https://npmjs.com/package/h3-compression
[npm-downloads-src]: https://img.shields.io/npm/dm/h3-compression?style=flat&colorA=080f12&colorB=1fa669
[npm-downloads-href]: https://npmjs.com/package/h3-compression
[bundle-src]: https://img.shields.io/bundlephobia/minzip/h3-compression?style=flat&colorA=080f12&colorB=1fa669&label=minzip
[bundle-href]: https://bundlephobia.com/result?p=h3-compression
[license-src]: https://img.shields.io/github/license/CodeDredd/h3-compression.svg?style=flat&colorA=080f12&colorB=1fa669
[license-href]: https://github.com/CodeDredd/h3-compression/blob/main/LICENSE
[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
[jsdocs-href]: https://www.jsdocs.io/package/h3-compression
