Skip to content

Conversation

@nhs04047
Copy link
Contributor

@nhs04047 nhs04047 commented Jan 4, 2026

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

  • Add JSDoc to wire utility functions (number.utils.ts, identifier.utils.ts,
    serialize.utils.ts, uuid.utils.ts, command.utils.ts, type.utils.ts)
  • Fix typo: "Unsuported" → "Unsupported"

Test plan

  • Lint and existing tests pass
  • No breaking changes (documentation only)

@spetz
Copy link
Contributor

spetz commented Jan 4, 2026

@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.?

@spetz
Copy link
Contributor

spetz commented Jan 4, 2026

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.

@nhs04047
Copy link
Contributor Author

nhs04047 commented Jan 4, 2026

@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.?

Thanks for the suggestion! Contributing to the website docs sounds like a great opportunity for me.
Let me first complete the JSDoc work on the SDK, and once I get more familiar with the project, I'd be happy to add a Node.js SDK section with tutorials and examples to the website.

@nhs04047
Copy link
Contributor Author

nhs04047 commented Jan 4, 2026

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.

Got it, thanks!

@nhs04047 nhs04047 changed the title docs(node): add JSDoc comments to wire utility functions docs(node): add JSDoc comments Jan 4, 2026
  Changes:
  - Use lowercase bigint instead of BigInt for primitive type
  - Apply import type for type-only imports in 6 files
  - Remove unused CommandResponse import
@nhs04047
Copy link
Contributor Author

nhs04047 commented Jan 4, 2026

i've completed the JSDoc documentation for all modules
also fixed all lint errors (type imports, unused imports, primitive type casing)

@spetz
Copy link
Contributor

spetz commented Jan 6, 2026

@nhs04047 thanks, please check the failing CI, and fix whitespaces + commit title (use js).

@nhs04047 nhs04047 changed the title docs(node): add JSDoc comments docs(js): add JSDoc comments Jan 6, 2026
@nhs04047 nhs04047 force-pushed the docs/node-jsdoc-wire-utils branch from bff3360 to 7d45d3a Compare January 6, 2026 15:20
@nhs04047
Copy link
Contributor Author

nhs04047 commented Jan 6, 2026

@spetz all fixed!

@spetz
Copy link
Contributor

spetz commented Jan 6, 2026

@nhs04047 please run ./scripts/ci/trailing-whitespace.sh --fix to fix the whitespace issues.

@nhs04047
Copy link
Contributor Author

nhs04047 commented Jan 7, 2026

@spetz Done, fixed and pushed.

@spetz spetz merged commit 8664e0f into apache:master Jan 7, 2026
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants