npm version npm downloads bundle JSDocs License
Handles compression for H3
✔️ 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
# Using npm npm install h3-compression # Using yarn yarn add h3-compression # Using pnpm pnpm add h3-compression
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:
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))
If you want to use it in nuxt 3 you can define a nitro plugin.
server/plugins/compression.ts
import { useCompression } from 'h3-compression' export default defineNitroPlugin((nitro) => { nitro.hooks.hook('render:response', async (response, { event }) => { // Skip internal nuxt routes (e.g. error page) if (getRequestURL(event).pathname.startsWith('/__nuxt')) return 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
H3-compression has a concept of composable utilities that accept event (from eventHandler((event) => {})) as their first argument and response as their second.
useGZipCompression(event, response)useDeflateCompression(event, response)useBrotliCompression(event, response)useCompression(event, response)
useGZipCompressionStream(event, response)useDeflateCompressionStream(event, response)useCompressionStream(event, response)
MIT License © 2023-PRESENT Gregor Becker