Skip to content

docs: add comprehensive JSDoc to SplitClient methods - #730

Merged
Kingsman-99 merged 1 commit into
Stellar-split:mainfrom
kingsrichie79-cmyk:fix/client-jsdoc
Aug 29, 2026
Merged

docs: add comprehensive JSDoc to SplitClient methods#730
Kingsman-99 merged 1 commit into
Stellar-split:mainfrom
kingsrichie79-cmyk:fix/client-jsdoc

Conversation

@kingsrichie79-cmyk

Copy link
Copy Markdown
Contributor

Closes #698

Description:

Description

This PR resolves the issue regarding the lack of JSDoc comments on SplitClient methods in src/client.ts. By ensuring that all public methods are well-documented, we reduce the time new integrators need to spend reading the source code to understand how to use the SDK.

Changes Made

  • Added detailed JSDoc blocks to every public method on SplitClient.
  • Ensured every public method's JSDoc block includes @param, @returns, and @throws tags.
  • Added practical @example blocks to the three most heavily utilized methods:
    • createInvoice
    • pay
    • getInvoice
  • Explicitly marked all private/internal methods with the /** @internal */ tag to exclude them from external public-facing documentation.

Notes

  • Documentation only: No method signatures or runtime behaviors were modified.
  • All existing unit tests pass seamlessly as this is strictly a documentation update.

@drips-wave

drips-wave Bot commented Aug 28, 2026

Copy link
Copy Markdown

@kingsrichie79-cmyk 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

@Kingsman-99
Kingsman-99 merged commit 6b54a90 into Stellar-split:main Aug 29, 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.

client.ts: Document all public SplitClient methods with JSDoc

2 participants