Kafkajs: Breaking changes when updating from version 1.8 to 1.9.3
Not sure when they were introduced but there are breaking changes between kafkajs version 1.8 and 1.9.3 when using Typescript (we're using TypeScript 3.5.2):
Examples include:
- Producing messages: key and value no longer accept a string but need a buffer instead
- Deleting a topic: now requires a timeout parameter
- Consuming messages:
ConsumerEachMessagePayloadno longer exists.
I'd like to suggest increasing the major version number if there are breaking changes in the future. Obviously, if semantic versioning is not being used for this repo, then please ignore this suggestion. Personally I have a preference for semantic versioning, though, as it helps with managing dependencies.
Thank you and keep up the great work!
ManfredLange
>All comments
Hi @ManfredLange, we use semver. The typescript definitions are still a bit messy as I assumed the original contribution was build up on top of @types/kafkajs, but it wasn't. It was also hard to review, but I consider your points bugs, and I have been working to fix them. I will work on another patch to address the incompatibilities, the code on 1.9 is 100% compatible with the previous versions and soon will reach a good state with the typescript definitions.
Thanks for the report.
tulios
on 1 Jul 2019
Related issues
oemergenc
路
5Comments
scmorse
路
3Comments
jgao54
路
5Comments
pekkalaaksonen
路
5Comments
pimpelsang
路
3Comments
Most helpful comment
Hi @ManfredLange, we use semver. The typescript definitions are still a bit messy as I assumed the original contribution was build up on top of
@types/kafkajs, but it wasn't. It was also hard to review, but I consider your points bugs, and I have been working to fix them. I will work on another patch to address the incompatibilities, the code on 1.9 is 100% compatible with the previous versions and soon will reach a good state with the typescript definitions.Thanks for the report.