docs: add JSDoc documentation to useConnect hook and requestRaw function#493
Open
Dark-Brain07 wants to merge 8 commits intostx-labs:mainfrom
Open
docs: add JSDoc documentation to useConnect hook and requestRaw function#493Dark-Brain07 wants to merge 8 commits intostx-labs:mainfrom
Dark-Brain07 wants to merge 8 commits intostx-labs:mainfrom
Conversation
…sMobile functions
d255fc9 to
0403aa6
Compare
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.
Description
Added comprehensive JSDoc documentation to undocumented functions in the
@stacks/connectand@stacks/connect-reactpackages to improve the developer experience and IDE support.Changes
packages/connect/src/request.tsrequestRawwith@param,@returns,@throws, and cross-reference torequestvia@linkpackages/connect-react/src/react/hooks/use-connect.tsuseConnecthook with usage exampledoContractCall- contract call transaction popupdoContractDeploy- contract deploy popupdoSTXTransfer- STX transfer popupdoProfileUpdate- profile update popupdoSignTransaction- sign pre-built transaction hexsign- arbitrary message signingsignPsbt- PSBT signingMotivation
The
useConnecthook is the primary React integration point for Stacks wallets, but its functions had no documentation. Developers usinguseConnecthad to read the source to understand what each function does and what parameters it accepts.Testing
Documentation-only changes. No functional code was modified.