{"_id":"@arexico/kafkajs-zstd","name":"@arexico/kafkajs-zstd","dist-tags":{"latest":"0.1.2"},"versions":{"0.1.2":{"name":"@arexico/kafkajs-zstd","version":"0.1.2","description":"A KafkaJS codec for ZStandard compression using Bun's built-in zstd (forked from @kafkajs/zstd)","main":"src/index.js","types":"types/index.d.ts","scripts":{"lint":"eslint .","test":"jest","test:watch":"jest --watch","test:types":"tsc -p types/"},"repository":{"type":"git","url":"git+https://github.com/arexico/kafkajs-zstd.git"},"keywords":["zstd","compression","kafka","kafkajs","zstandard"],"author":{"name":"Arexico"},"license":"MIT","bugs":{"url":"https://github.com/arexico/kafkajs-zstd/issues"},"homepage":"https://github.com/arexico/kafkajs-zstd#readme","devDependencies":{"@types/node":"^14.11.5","eslint":"^7.10.0","eslint-plugin-prettier":"^3.1.4","execa":"^4.0.3","jest":"^26.5.2","kafkajs":"^1.15.0-beta.11","prettier":"^2.1.2","typescript":"^4.0.3"},"dependencies":{},"publishConfig":{"access":"public"},"_id":"@arexico/kafkajs-zstd@0.1.2","gitHead":"b63b946fba47cd3e9564a1da9dbec41543fc6c89","_nodeVersion":"18.20.4","_npmVersion":"10.7.0","dist":{"integrity":"sha512-QUYnvBAJ7oXX64dzGr7mrxzR6yZZkN6FE5GHed9kA6wyI985CIdDi/9hwpE/vrGM5dgjm+lTQLiRvfe8QewRjw==","shasum":"6627949677a269f8e4353cb32a3ee7e18c2f5285","tarball":"https://registry.npmjs.org/@arexico/kafkajs-zstd/-/kafkajs-zstd-0.1.2.tgz","fileCount":6,"unpackedSize":130563,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQD+HyGb1pl1mFtUJHK/s3lJSPLR4P0oTgefFawKsP0m9wIhAK48pzX8T/qM32DBlCE7dcEo/qlzimrFz25aMU3v7K3T"}]},"_npmUser":{"name":"dev2adventure","email":"julian.lang@arexico.com"},"directories":{},"maintainers":[{"name":"dev2adventure","email":"julian.lang@arexico.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/kafkajs-zstd_0.1.2_1754917213057_0.004982470932294536"},"_hasShrinkwrap":false}},"time":{"created":"2025-08-11T13:00:12.645Z","0.1.2":"2025-08-11T13:00:13.233Z","modified":"2025-08-11T13:00:13.534Z"},"maintainers":[{"name":"dev2adventure","email":"julian.lang@arexico.com"}],"description":"A KafkaJS codec for ZStandard compression using Bun's built-in zstd (forked from @kafkajs/zstd)","homepage":"https://github.com/arexico/kafkajs-zstd#readme","keywords":["zstd","compression","kafka","kafkajs","zstandard"],"repository":{"type":"git","url":"git+https://github.com/arexico/kafkajs-zstd.git"},"author":{"name":"Arexico"},"bugs":{"url":"https://github.com/arexico/kafkajs-zstd/issues"},"license":"MIT","readme":"# `@arexico/kafkajs-zstd`\n\nZStandard codec for KafkaJS using Bun's built-in zstd compression.\n\n> **Fork Notice**: This is a fork of [`@kafkajs/zstd`](https://github.com/kafkajs/zstd) that has been ported to use Bun's native zstd compression instead of the `cppzst` native module.\n\n> **NOTE**: This codec requires Bun v1.2.14 or higher with built-in zstd compression APIs (`Bun.zstdCompress` and `Bun.zstdDecompress`).\n>\n> This package is provided on a best-effort basis. Original repository: [@kafkajs/zstd](https://github.com/kafkajs/zstd)\n\n## Installation\n\n```sh\nnpm install --save @arexico/kafkajs-zstd\n```\n\n## Configuration\n\n```javascript\nconst {  CompressionTypes, CompressionCodecs } = require('kafkajs')\nconst ZstdCodec = require('@arexico/kafkajs-zstd')\n\n// Both compressionParams and decompressionParams are optional\nconst compressionParams = { level: 1 }\nconst decompressionParams = {}\nCompressionCodecs[CompressionTypes.ZSTD] = ZstdCodec(compressionParams, decompressionParams)\n```\n\n### `compressionParams`\n\n**Optional** Allows you to configure the compression level.\n\n```js\n{\n    /*  \n     * Higher compression level means better compression ratio at the cost of speed.\n     * See https://facebook.github.io/zstd/\n     */\n    level: 3\n}\n```\n\n### `decompressionParams`\n\n**Optional** Currently unused but kept for API compatibility.\n\n## Testing\n\n**Requirements**: This package requires Bun v1.2.14 or higher with zstd support.\n\n```sh\n# Run with Docker (for integration tests)\n$ docker-compose up -d && node scripts/waitForKafka.js\n$ bun test\n\n# Run unit tests only (no Docker required)\n$ bun test src/compression.spec.js\n\n# Verify type definitions\n$ npm run test:types\n\n# Lint\n$ npm run lint\n```\n\n## License\n\nSee [LICENSE](https://github.com/arexico/kafkajs-zstd/blob/master/LICENSE) for more details.","readmeFilename":"README.md","_rev":"1-47cb18614a2b7e27de0e3fd9a3a60552"}