{"id":16675076,"url":"https://github.com/codedredd/h3-compression","last_synced_at":"2025-04-09T17:25:00.585Z","repository":{"id":191609540,"uuid":"684616954","full_name":"CodeDredd/h3-compression","owner":"CodeDredd","description":"Adds compression to h3 requests (brotli, gzip, deflate)","archived":false,"fork":false,"pushed_at":"2024-05-05T14:26:31.000Z","size":155,"stargazers_count":68,"open_issues_count":6,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-13T12:45:19.949Z","etag":null,"topics":["brotli","compression","deflate","gzip","h3","nuxt3"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CodeDredd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["CodeDredd"]}},"created_at":"2023-08-29T14:00:37.000Z","updated_at":"2024-10-04T18:34:46.000Z","dependencies_parsed_at":"2024-05-05T13:44:09.011Z","dependency_job_id":"042eb569-ed7e-420e-8a53-fbc8e104b423","html_url":"https://github.com/CodeDredd/h3-compression","commit_stats":null,"previous_names":["codedredd/h3-compress"],"tags_count":4,"template":false,"template_full_name":"antfu/starter-ts","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeDredd%2Fh3-compression","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeDredd%2Fh3-compression/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeDredd%2Fh3-compression/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeDredd%2Fh3-compression/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CodeDredd","download_url":"https://codeload.github.com/CodeDredd/h3-compression/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248075755,"owners_count":21043644,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["brotli","compression","deflate","gzip","h3","nuxt3"],"created_at":"2024-10-12T12:45:24.447Z","updated_at":"2025-04-09T17:25:00.561Z","avatar_url":"https://github.com/CodeDredd.png","language":"TypeScript","funding_links":["https://github.com/sponsors/CodeDredd"],"categories":[],"sub_categories":[],"readme":"# H3-compression\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n[![bundle][bundle-src]][bundle-href]\n[![JSDocs][jsdocs-src]][jsdocs-href]\n[![License][license-src]][license-href]\n\n\u003e Handles compression for H3\n\n## Features\n\n✔️ \u0026nbsp;**Zlib Compression:** You can use zlib compression (brotli, gzip and deflate)\n\n✔️ \u0026nbsp;**Stream Compression:** You can use native stream compressions (gzip, deflate)\n\n✔️ \u0026nbsp;**Compression Detection:** It uses the best compression which is accepted\n\n\n\n## Install\n\n```bash\n# Using npm\nnpm install h3-compression\n\n# Using yarn\nyarn add h3-compression\n\n# Using pnpm\npnpm add h3-compression\n```\n\n## Usage\n\n```ts\nimport { createServer } from 'node:http'\nimport { createApp, eventHandler, toNodeListener } from 'h3'\nimport { useCompressionStream } from 'h3-compression'\n\nconst app = createApp({ onBeforeResponse: useCompressionStream }) // or { onBeforeResponse: useCompression }\napp.use(\n  '/',\n  eventHandler(() =\u003e 'Hello world!'),\n)\n\ncreateServer(toNodeListener(app)).listen(process.env.PORT || 3000)\n```\n\nExample using \u003ca href=\"https://github.com/unjs/listhen\"\u003elisthen\u003c/a\u003e for an elegant listener:\n\n```ts\nimport { createApp, eventHandler, toNodeListener } from 'h3'\nimport { listen } from 'listhen'\nimport { useCompressionStream } from 'h3-compression'\n\nconst app = createApp({ onBeforeResponse: useCompressionStream }) // or { onBeforeResponse: useCompression }\napp.use(\n  '/',\n  eventHandler(() =\u003e 'Hello world!'),\n)\n\nlisten(toNodeListener(app))\n```\n\n## Nuxt 3\n\nIf you want to use it in nuxt 3 you can define a nitro plugin.\n\n`server/plugins/compression.ts`\n````ts\nimport { useCompression } from 'h3-compression'\n\nexport default defineNitroPlugin((nitro) =\u003e {\n  nitro.hooks.hook('render:response', async (response, { event }) =\u003e {\n    if (!response.headers?.['content-type']?.startsWith('text/html'))\n      return\n\n    await useCompression(event, response)\n  })\n})\n````\n\u003e [!NOTE]  \n\u003e `useCompressionStream` doesn't work right now in nitro. So you just can use `useCompression`\n\n## Utilities\n\nH3-compression has a concept of composable utilities that accept `event` (from `eventHandler((event) =\u003e {})`) as their first argument and `response` as their second.\n\n#### Zlib Compression\n\n- `useGZipCompression(event, response)`\n- `useDeflateCompression(event, response)`\n- `useBrotliCompression(event, response)`\n- `useCompression(event, response)`\n\n#### Stream Compression\n\n- `useGZipCompressionStream(event, response)`\n- `useDeflateCompressionStream(event, response)`\n- `useCompressionStream(event, response)`\n\n## Sponsors\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://pinia-orm.codedredd.de/sponsorkit/sponsors.png\"\u003e\n    \u003cimg src='https://pinia-orm.codedredd.de/sponsorkit/sponsors.svg'/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Releated Projects\n\n- [H3](https://github.com/unjs/h3)\n\n## License\n\n[MIT](./LICENSE) License © 2023-PRESENT [Gregor Becker](https://github.com/CodeDredd)\n\n\n\u003c!-- Badges --\u003e\n\n[npm-version-src]: https://img.shields.io/npm/v/h3-compression?style=flat\u0026colorA=080f12\u0026colorB=1fa669\n[npm-version-href]: https://npmjs.com/package/h3-compression\n[npm-downloads-src]: https://img.shields.io/npm/dm/h3-compression?style=flat\u0026colorA=080f12\u0026colorB=1fa669\n[npm-downloads-href]: https://npmjs.com/package/h3-compression\n[bundle-src]: https://img.shields.io/bundlephobia/minzip/h3-compression?style=flat\u0026colorA=080f12\u0026colorB=1fa669\u0026label=minzip\n[bundle-href]: https://bundlephobia.com/result?p=h3-compression\n[license-src]: https://img.shields.io/github/license/CodeDredd/h3-compression.svg?style=flat\u0026colorA=080f12\u0026colorB=1fa669\n[license-href]: https://github.com/CodeDredd/h3-compression/blob/main/LICENSE\n[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat\u0026colorA=080f12\u0026colorB=1fa669\n[jsdocs-href]: https://www.jsdocs.io/package/h3-compression\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodedredd%2Fh3-compression","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodedredd%2Fh3-compression","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodedredd%2Fh3-compression/lists"}