fix jsdoc tag #833
Merged
fix jsdoc tag #833
Conversation
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
There was a problem hiding this comment.
Pull request overview
Updates the JSDoc for SigningCallback to correct the @returns type annotation.
Changes:
- Fixes the
@returnsunion type forSigningCallbackto be expressed as a singlePromise<...>resolving to a union.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
src/auth.js
Outdated
Comment on lines
20
to
22
| * @returns { | ||
| * Promise<Uint8Array> | | ||
| * Promise<{signature: Uint8Array, publicKey: string} | ||
| * Promise<Uint8Array | {signature: Uint8Array, publicKey: string}> | ||
| * } the signature of the raw payload (which is the sha256 hash of the preimage |
There was a problem hiding this comment.
@returns is the only JSDoc in the repo using a multi-line type block (@returns { on one line, type on the next). To match the rest of the codebase (e.g., src/auth.js:65 and src/invocation.js:184-185) and improve tooling compatibility, put the full type on the same line as the tag (e.g., @returns {Promise<Uint8Array | {signature: Uint8Array, publicKey: string}>} ...).
|
Size Change: -20 B (0%) Total Size: 3.47 MB
ℹ️ View Unchanged
|
quietbits
approved these changes
Jan 22, 2026
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.
No description provided.