Add JSDoc to encodeMuxed() with @throws and @param tags#157
Merged
codeZe-us merged 1 commit intoBoxkit-Labs:mainfrom Mar 26, 2026
Merged
Add JSDoc to encodeMuxed() with @throws and @param tags#157codeZe-us merged 1 commit intoBoxkit-Labs:mainfrom
codeZe-us merged 1 commit intoBoxkit-Labs:mainfrom
Conversation
|
@Jay1280 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
2 participants
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 #125
Add comprehensive JSDoc documentation to encodeMuxed() function with proper parameter descriptions, return type, and all potential thrown errors. This improves IDE tooltips and API discoverability for consumers.
Changes:
Added JSDoc block with @param, @returns, and @throws tags
Documented TypeError for invalid bigint parameter
Documented RangeError for uint64 boundary violations
Documented Error for invalid Ed25519 public keys
Closes #125