Skip to content

Feat/streamclient jsdoc - #425

Merged
Jaydbrown merged 2 commits into
conduit-protocol:mainfrom
oscarj007:feat/streamclient-jsdoc
Aug 26, 2026
Merged

Feat/streamclient jsdoc#425
Jaydbrown merged 2 commits into
conduit-protocol:mainfrom
oscarj007:feat/streamclient-jsdoc

Conversation

@oscarj007

Copy link
Copy Markdown

This change addresses issue #337 by adding comprehensive JSDoc annotations to the ConduitClient class and its public
methods (constructor, pauseStream, unpauseStream, and setWallet).

Changes:

  • Added high-level class documentation with an usage example that demonstrates typical configuration using
    environment variables.
  • Added @PARAM, @returns, and @throws tags to all public methods to improve IDE intellisense support.
  • Documented error conditions (@throws) for better developer awareness of failure modes.
  • Ensured consistent documentation style across the class.

These improvements will significantly enhance the developer experience by providing clear documentation directly
within the editor when consuming the SDK.

closes #337

@drips-wave

drips-wave Bot commented Aug 7, 2026

Copy link
Copy Markdown

@oscarj007 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@Jaydbrown

Copy link
Copy Markdown
Contributor

Thanks for the contribution here — squash-merging this now. Any follow-ups we'll track in a fresh issue. 🚀

@Jaydbrown
Jaydbrown merged commit ee7309c into conduit-protocol:main Aug 26, 2026
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.

Feature: Provide comprehensive JSDoc for StreamClient

3 participants