docs: add comprehensive JSDoc to SplitClient methods - #730
Merged
Kingsman-99 merged 1 commit intoAug 29, 2026
Conversation
|
@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! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #698
Description:
Description
This PR resolves the issue regarding the lack of JSDoc comments on
SplitClientmethods insrc/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
SplitClient.@param,@returns, and@throwstags.@exampleblocks to the three most heavily utilized methods:createInvoicepaygetInvoice/** @internal */tag to exclude them from external public-facing documentation.Notes