search

nodefluent / node-sinek

:tophat: Most advanced high level Node.js Kafka client
MIT License
290 stars 52 forks source link

Documentation? #152

Open olasundell opened 4 years ago

olasundell commented 4 years ago

This might very well be the most advanced client for JS/TS. However, to be honest, it's very hard even to get started due to the near-total lack of documentation. You should really take a week off from writing code and just work on docs, in my not so humble opinion. For instance, I struggle to see the difference between a Producer's send, buffer and bufferFormat methods. Please update the docs so we can use this driver!

Apparently there's a lack of good drivers for Kafka in the Node world in general, so if this is as good as you claim, please write documentation which shows it and underpins it.

krystianity commented 4 years ago

Hi @olasundell I get that this might be frustrating. However in regards to that statement you are mentioning.. this line was added in 22 Oct 2017, when sinek was surely the most advanced Kafka client out there.. As long as time goes I currently wont have any to write a doc for this.

Besides the buffer methods only implement best practice formats for JSON Kafka messages. Using send is just fine and also encouraged in the best practice example.

If you are looking for a more active project you might want to take a look at https://github.com/tulios/kafkajs. Their API is heavily inspired by sinek.