{"_id":"@kafkajs/zstd","_rev":"2-09eec5cb87b32147082c99e99494341b","name":"@kafkajs/zstd","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.0":{"name":"@kafkajs/zstd","version":"0.1.0","description":"A KafkaJS codec for ZStandard compression","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/kafkajs/zstd.git"},"keywords":["zstd","compression","kafka","kafkajs","zstandard"],"author":{"name":"Tommy Brunn","email":"tommy.brunn@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/kafkajs/zstd/issues"},"homepage":"https://github.com/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":{"cppzst":"^2.0.6"},"funding":"https://github.com/sponsors/Nevon/","publishConfig":{"access":"public"},"gitHead":"6c46ba9d99a599b7d343a1a3bc640d360ccb1efa","_id":"@kafkajs/zstd@0.1.0","_nodeVersion":"14.13.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-th4PKNYxO0NsfLZ2hRKBkPbFqJ8WEDA/zK0+gB7wJszM9yGjsCH3h0av7t180BR9CwrO8CI59r6zlGI6hUqvVA==","shasum":"27b8de910823c9f98ee31dfe28f1cb1e9d67b0c2","tarball":"https://registry.npmjs.org/@kafkajs/zstd/-/zstd-0.1.0.tgz","fileCount":5,"unpackedSize":5083,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfgF+QCRA9TVsSAnZWagAA3hkP+wT67EaYJIKPCwWLQnnn\nk5sOcw4sHZng0bJrggQyy8q/ImDQM3DbZFKo9XYkeaUlk4uRRF4w2gFsN9Ix\npBA88FpznFJ9ttpKnNQuL00A43Vlol/MIXdGnlhB/agh8+H5TJ/uXDZhMHsu\n/UWDVjSTNS+fU8lL+hyR0+myQBu0+9Beh8EV5Ml1ybrlyk+g0ZFyk6Nnpesc\nmpBo6Kc7VAXEz5zhJkMZFDNJp3yv6zPELxCTXqDGluj+sKMl3rDZbOcXPg2q\n6aOfwilAsURGXGiS9TT/prjywehpwu3PLYv/OUnJRsXdrU1Pf1tDcjRIEcN1\nyXSg8jfXucHCG4U7PojaU+E7gvdnYzYlpmck8LC0Iomx8uHQvuYfkdEG9wbQ\n8likjQggVGQ9e/ioNFSOaeVMHgtmmbn2ov4vNVDwtbn4CISvSs1g6IMtcYya\nrL9PRY3G8pRA3j7UD18wTeEO3+oDz9xvcQiMPDdAuNFOxwhqtdLc+kpnQfgM\n59yMfpNG7nwtO1+ea0hrkJSnz8a49QC0caAF+uJYgMj+9OBoBibhBdYUqyTq\ncpUGFEd1bdpDwqx0j41LcuqcwRUu4JhH4KjY2j5nDpBRlrUNR1ki7MOiFRxs\nHAe8lLV/9QAUkJ6TfdDyDZZ4cankOIHie52KG39EqebBwui5usukDqVSu4ZK\nB6Ki\r\n=1ETC\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFE3swdNJofLdMhTV9Upf6cxuIN5KMxLogPORxnJbWfNAiEA8gTY5YHUnJJFSa1rvHohwUJofBGyozm8rNLbKj/82hw="}]},"maintainers":[{"name":"nevon","email":"tommy.brunn@gmail.com"},{"name":"engervall","email":"erik.engervall@gmail.com"},{"name":"tulios","email":"ornelas.tulio@gmail.com"}],"_npmUser":{"name":"nevon","email":"tommy.brunn@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/zstd_0.1.0_1602248592251_0.7961179807693717"},"_hasShrinkwrap":false},"0.1.1":{"name":"@kafkajs/zstd","version":"0.1.1","description":"A KafkaJS codec for ZStandard compression","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/kafkajs/zstd.git"},"keywords":["zstd","compression","kafka","kafkajs","zstandard"],"author":{"name":"Tommy Brunn","email":"tommy.brunn@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/kafkajs/zstd/issues"},"homepage":"https://github.com/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":{"cppzst":"2.0.6"},"funding":"https://github.com/sponsors/Nevon/","publishConfig":{"access":"public"},"gitHead":"c8d3e2a94a35e21c3a77ab59c4bf0479e7a8a664","_id":"@kafkajs/zstd@0.1.1","_nodeVersion":"14.16.1","_npmVersion":"6.14.12","dist":{"integrity":"sha512-55Wo12dD6Kij5Q+l6TfTRglI+LIx0W3+pPkQgQvfRIcVJv2J3W1K8O2C+RGm7ZwC6xPQT9WkoHrE4aQv9htkVw==","shasum":"6937b2743e6ee438b78cbad1dd3c2e7ec97a5d75","tarball":"https://registry.npmjs.org/@kafkajs/zstd/-/zstd-0.1.1.tgz","fileCount":5,"unpackedSize":5083,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgfoHrCRA9TVsSAnZWagAAt84P/0HX97fJwdk1/z6BRg7O\n7Ycaefqds5FueCyiWNGu7Wxt3XreYtCgvzc7eYRe6VXjmAw21pMYZMjdH4pT\ndKeuPviHp9ImMq6w7jYY/vxp3R39XHvJDBK+CbeMfyyT7sxOvbbfSztfiDMK\nNL8eC2RHojY5gJYVoysZaOxxQkpmv3bLOQFWKsplvZQmO5bn1RW9LOVRu69L\nFik/a54YeMyNk20z/mA0broraLu3j75YdNbv/KnsgCzX09cFc6Y2DjHiXsNC\nnNrD2KYHDu7rAHPRaUKJTgZi3D1vynm+kN7xU/JsUwbDry0OMnBGOe+FBXee\nKJkgvkTE4PA5Tk/d6aEeLEr0SSoKRFy/ohN7+oHG11KsXBay3mp/LIJ6tJXx\naSX52iCaBZsMPC7LnqMJ2BdQTkLAXO2bOQVorwwu2W4EepVz2EGNQa7GgV9O\nf9CaOALfu37+VWDsaIiAen1CjWbR4b1PFggsqEiJLOqfrPPCSxEgFDz8XwUE\nuBYxHmzBksaqaAClHp0NsrCQnajWqS7DULBxx5ZiyMBaCT5un1WbsfMXBbi7\nUQQWjycdNrDZvKRvCYvZHzS/iuU9EKaNM/0rvHzQ9hhSo4+9CCVOULAraFCO\n8BtQflZptTfk8pdGlNVCj0Dk0PHon3r753HFs6diG80RBO3gxw0THXT452PY\nzTAO\r\n=rQuR\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDhQgsjzXojmuVskieRBDXvHrE9KvHt+mgrKg3lFxs+mwIhAJGjOdlUlhCaHnhT2uqd59DAji2T9nV4WVMnrtBFtGEZ"}]},"_npmUser":{"name":"nevon","email":"tommy.brunn@gmail.com"},"directories":{},"maintainers":[{"name":"tulios","email":"ornelas.tulio@gmail.com"},{"name":"engervall","email":"erik.engervall@gmail.com"},{"name":"nevon","email":"tommy.brunn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/zstd_0.1.1_1618903530473_0.11386291821452232"},"_hasShrinkwrap":false}},"time":{"created":"2020-10-09T13:03:12.026Z","0.1.0":"2020-10-09T13:03:12.380Z","modified":"2022-04-05T22:58:20.731Z","0.1.1":"2021-04-20T07:25:30.700Z"},"maintainers":[{"name":"tulios","email":"ornelas.tulio@gmail.com"},{"name":"engervall","email":"erik.engervall@gmail.com"},{"name":"nevon","email":"tommy.brunn@gmail.com"}],"description":"A KafkaJS codec for ZStandard compression","homepage":"https://github.com/kafkajs/zstd#readme","keywords":["zstd","compression","kafka","kafkajs","zstandard"],"repository":{"type":"git","url":"git+https://github.com/kafkajs/zstd.git"},"author":{"name":"Tommy Brunn","email":"tommy.brunn@gmail.com"},"bugs":{"url":"https://github.com/kafkajs/zstd/issues"},"license":"MIT","readme":"# `@kafkajs/zstd`\n\nZStandard codec for KafkaJS.\n\n> **NOTE**: This codec relies on [cppzst](https://www.npmjs.com/package/cppzst) for compression and decompression. Please divert any issues with cppzst there, and only open issues on this repo in case the version being used here needs to be updated.\n>\n> This package is provided on a best-effort basis. See [#2](https://github.com/kafkajs/zstd/issues/2)\n\n## Installation\n\n```sh\nnpm install --save @kafkajs/zstd\n```\n\n## Configuration\n\n```javascript\nconst {  CompressionTypes, CompressionCodecs } = require('kafkajs')\nconst ZstdCodec = require('@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 and training data.\n\n```js\n{\n    /*  \n     * Higher compression level means faster at the cost of compression ratio or memory usage.\n     * See https://facebook.github.io/zstd/\n     */\n    level: 3,\n\n    /*\n     * Training data for improving performance on small payloads.\n     * See https://facebook.github.io/zstd/#small-data\n     */\n    dict: trainingData,\n    dictSize: Buffer.byteLength(trainingData)\n}\n```\n\n### `decompressionParams`\n\n**Optional** Allows you to configure the training data.\n\n```js\n{\n    /*\n     * Training data for improving performance on small payloads.\n     * See https://facebook.github.io/zstd/#small-data\n     */\n    dict: trainingData,\n    dictSize: Buffer.byteLength(trainingData)\n}\n```\n\n## Testing\n\n```sh\n$ docker-compose up -d && node scripts/waitForKafka.js\n$ npm test\n\n# Interactive mode\n$ npm run test:watch\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/kafkajs/zstd/blob/master/LICENSE) for more details.","readmeFilename":"README.md"}