Feature: Provide comprehensive JSDoc for `StreamClient`

[Jaydbrown]

Problem

The main StreamClient class has no JSDoc comments. When developers hover over methods like createStream or cancelStream in VS Code, they only see the type signature, not the explanation of parameters or thrown errors.

Task

• Add @param, @returns, and @throws tags to every public method in StreamClient.
• Add examples using @example where appropriate (especially for complex config objects).

[Leemxiey]

@Leemxiey has applied to work on this issue as part of the Stellar Wave Program's 7th wave.

I would love to work on this issue professionally, please assign it to me

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Leemxiey to this issue.

[oscarj007]

@oscarj007 has applied to work on this issue as part of the Stellar Wave Program's 7th wave.

Hello maintainer
Permit me to resolve this issue please

ℹ️ Repo Maintainers: To accept this application, review their application or assign @oscarj007 to this issue.

[Glittersup]

@Glittersup has applied to work on this issue as part of the Stellar Wave Program's 7th wave.

I'm interested in taking this on.

I have experience contributing to existing codebases and enjoy working on improvements ranging from features and bug fixes to performance, security, and developer experience. I'll make sure the implementation aligns with the project's architecture and satisfies the acceptance criteria.

Thanks for considering my application!

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Glittersup to this issue.

[JafetCHVDev]

@JafetCHVDev has applied to work on this issue as part of the Stellar Wave Program's 7th wave.

Hello Team,

My Background

My name is Cristian, and I’m a passionate full-stack developer from Costa Rica 🇨🇷💻. I’m excited about the opportunity to contribute to your Stellar-based project during Drips Wave! 🌊
I enjoy building web applications that combine clean user interfaces with solid back-end logic and reliable databases.

Experience

I have experience developing web applications using technologies such as React, .NET Core, SQL Server, and Firebase. I’ve worked on projects that include role-based systems, CRUD platforms, booking systems, and data-driven web apps.
While I’m still growing in Web3 and blockchain, I’m highly motivated to learn and apply these technologies, especially within the Stellar ecosystem.

I’m driven by the opportunity to improve my skills, collaborate with a talented team, and make a meaningful contribution to your project.

Links

You can find my profiles and links here:

GitHub: https://github.com/JafetCHVDev

Thank you for considering my candidacy. I am excited about the opportunity to contribute to this project and create a positive impact. Please let me know if you have any questions or need additional information.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @JafetCHVDev to this issue.

[Viky207]

@Viky207 has applied to work on this issue as part of the Stellar Wave Program's 7th wave.

hello please can i work on this issue

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Viky207 to this issue.

[Theraxia]

@Theraxia has applied to work on this issue as part of the Stellar Wave Program's 7th wave.

hi maintainer, i would like to work on this, thanks

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Theraxia to this issue.

[drips-wave]

Congratulations, @oscarj007! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on July 30, 2026.

🧑‍💻 @oscarj007: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

Warning

When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.

🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

🌊 Happy Wave 🌊