-
Notifications
You must be signed in to change notification settings - Fork 251
docs(js): add JSDoc comments #2534
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
@nhs04047 thank you! Would you also consider adding the docs to https://github.com/apache/iggy-website/ which is then published to https://iggy.apache.org/docs/ so that there would be SDK -> Node section with some hints, tutorial etc.? |
|
Also, let's try to pack as much updates as possible into the single PR, since it's not a logic that would potentially break some stuff etc. |
Thanks for the suggestion! Contributing to the website docs sounds like a great opportunity for me. |
Got it, thanks! |
Changes: - Use lowercase bigint instead of BigInt for primitive type - Apply import type for type-only imports in 6 files - Remove unused CommandResponse import
|
i've completed the JSDoc documentation for all modules |
|
@nhs04047 thanks, please check the failing CI, and fix whitespaces + commit title (use |
bff3360 to
7d45d3a
Compare
|
@spetz all fixed! |
|
@nhs04047 please run |
|
@spetz Done, fixed and pushed. |
Hi!
I noticed that the Node.js SDK lacks documentation compared to other SDKs like Java and
Go, which have proper doc comments. So I'd like to start adding JSDoc comments to
improve the developer experience.
This is the first PR in a series - I'm planning to gradually add JSDoc documentation
across the entire Node.js SDK.
Changes
number.utils.ts,identifier.utils.ts,serialize.utils.ts,uuid.utils.ts,command.utils.ts,type.utils.ts)Test plan