{"_id":"lz4-kafkajs","name":"lz4-kafkajs","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"lz4-kafkajs","version":"1.0.0","description":"LZ4 streaming compression and decompression library for KafkaJS","author":{"name":"Marvin Pöperny"},"keywords":["kafka","kafkajs","compression","decompression","lz4","codec"],"homepage":"http://github.com/paister/lz4-kafkajs","repository":{"type":"git","url":"git://github.com/paister/lz4-kafkajs.git"},"bugs":{"url":"http://github.com/paister/lz4-kafkajs/issues"},"main":"./src/index.js","license":"MIT","dependencies":{"lz4":"^0.6.5"},"types":"./src/index.d.ts","gitHead":"20a189ef7f63aa2df2c9f41c97601e5df69c655f","_id":"lz4-kafkajs@1.0.0","_nodeVersion":"16.18.1","_npmVersion":"8.19.2","dist":{"integrity":"sha512-h6BPUx/yO55Ys30ZLgAl9ps7Rj0PEaMYDZXJGnc5ZqAclPXwp1goi13oalwqsc0QjMaUGBrE1WlmZOlypNN9Aw==","shasum":"b10c6b18fa2013b723aecef900c5df56b67a37c7","tarball":"https://registry.npmjs.org/lz4-kafkajs/-/lz4-kafkajs-1.0.0.tgz","fileCount":4,"unpackedSize":3992,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDlJFfvWW2ui0oV19YCIwwvLc2zWj8DhSFhsO7WD40P/AiEArgYJ6o1redfJ/mNfnWic7SZOVhVGFDmMqFxV6O+EFzY="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj/4A3ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmrz3Q/+K5vAZ5VE68lFKUYCGXB2zb1z/Cgnz89UXVWpzthYbzTSllar\r\nh76NM5BobwxMV7tXooSblvKoR7Tx1zVB5J5Eef+1UkeqPKi+qW0TccG8KQq5\r\nRTfXCAwPGVjw/hIr7nocboRmTVU7/GU6S4JPIFTdn9/XwD/sDxuwl2zAcwTy\r\nzm7UyU39QPKJf381Bmsxth2NaOt3FciQtxgbD2IGw4gPvweVq2q8OX9beUAz\r\nc8l0qqayxJHjf1WSmpnr8JH1uYizqnl7GniJEBzNv2bJanKHGQOT7wXeDmZC\r\nMU3Atun4XdSvwlNs3ZWJHRBXhn5Coj8yayNCWgKT5FfshcSNF+lTRtbOPY5t\r\nW3aiNwc52+NIF8KIpO4dz7OjN6Iw4ORdOxvO7X5k/nCGP70hkKlaHzjcC0A6\r\nrlG3g0lHvqerHNqTlY4RN/ywhnqrfVHYZuLD+reWZ453489igEYN1oXzpyWq\r\nj2paQQni3bW7vi36sLqlZ32xztZSiOea48D7NMv9G3zH3VUG+vKg3oXKQa6w\r\nWiCvz1vlsF+UHwWNzHOwr0eGPDp7sd/ZdroEnQZLSTmopH+mgZcP3venDVLe\r\neh9RSlfJGhWgb6F8lRjtG9JSOvlga8I6/Zj4HafHySVoPh5ihjBwhvzn8Imq\r\nXN0xaWfWiPc4MsoB4L9Y1qGaFozx6zT968Q=\r\n=S7Kv\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"paister","email":"marvin.poeperny@gmail.com"},"directories":{},"maintainers":[{"name":"paister","email":"marvin.poeperny@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/lz4-kafkajs_1.0.0_1677688886943_0.5648064735028118"},"_hasShrinkwrap":false}},"time":{"created":"2023-03-01T16:41:26.942Z","1.0.0":"2023-03-01T16:41:27.131Z","modified":"2023-03-01T16:41:27.283Z"},"maintainers":[{"name":"paister","email":"marvin.poeperny@gmail.com"}],"description":"LZ4 streaming compression and decompression library for KafkaJS","homepage":"http://github.com/paister/lz4-kafkajs","keywords":["kafka","kafkajs","compression","decompression","lz4","codec"],"repository":{"type":"git","url":"git://github.com/paister/lz4-kafkajs.git"},"author":{"name":"Marvin Pöperny"},"bugs":{"url":"http://github.com/paister/lz4-kafkajs/issues"},"license":"MIT","readme":"# lz4-kafkajs\n\nTypeScript-ready [lz4](https://www.npmjs.com/package/lz4) compression codec for [KafkaJS](https://www.npmjs.com/package/kafkajs).\n\nℹ️ Requires Node v10 or above to work.\n\n## Install\n\nWith yarn\n\n```bash\n$ yarn add lz4-kafkajs\n```\n\nWith npm\n\n```bash\n$ npm install lz4-kafkajs\n```\n\n## Usage\n\n```typescript\nimport { CompressionTypes, CompressionCodecs } from \"kafkajs\";\nimport LZ4 from \"lz4-kafkajs\";\n\nCompressionCodecs[CompressionTypes.LZ4] = new LZ4().codec;\n```\n\n## Options\n\nAll options are passed on to the [lz4 library](https://www.npmjs.com/package/lz4).\n\n### Example\n\nTo configure the decompression and compression:\n\n```typescript\nimport LZ4, {\n  CompressOptions,\n  DecompressOptions,\n  LZ4Options,\n} from \"lz4-kafkajs\";\n\nconst decompressOptions: DecompressOptions = {\n  useJS: false,\n};\n\nconst compressOptions: CompressOptions = {\n  blockChecksum: false,\n  blockIndependence: true,\n  blockMaxSize: 4 << 20,\n  dict: false,\n  dictId: 0,\n  highCompression: false,\n  streamChecksum: true,\n  streamSize: false,\n};\n\nconst options: LZ4Options = {\n  decompressOptions,\n  compressOptions,\n};\n\nCompressionCodecs[CompressionTypes.LZ4] = new LZ4(options).codec;\n```\n","readmeFilename":"README.md"}