Difficulty in reading documentation as a beginner

[simonebenati]

Is your feature request related to a problem? Please describe.
I have difficulties reading the documentation and especially what each parameter does.

Describe the solution you'd like
Could you please provide a brief explanation to each option and what it does or maybe a reference to official zookeeper docs?

Describe alternatives you've considered

Additional context

[DavidVujic]

Thank you for this feature request @simonebenati!

I agree, the docs are difficult to read and should be improved.

Here's some info that we have today about the parameters:
https://github.com/yfinkelstein/node-zookeeper?tab=readme-ov-file#input-parameters

[simonebenati]

@DavidVujic
Thank you for the swift reply, for example why is the .init method written after the .on method ? What does the init do? I believe it initializes the client.. then you want to connect to zookeeper. What do all the _cb variables do?

thank you,
Simone

[simonebenati]

Also one thing, how do you handle disconnects and errors using the .on method?

[DavidVujic]

Good feedback, thank you! This is very useful for me when updating the docs.

Meanwhile, there is the example code that I believe would answer some of your questions:

https://github.com/yfinkelstein/node-zookeeper/blob/master/examples/wrapper.js#L25