-
Notifications
You must be signed in to change notification settings - Fork 3
feat: add TypeScript types for wif.js #35
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
ChALkeR
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- remove package-lock.json (without gitignoring it)
- mirror the doc to README
package-lock.json
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot remove this file, we use pnpm
Done in commits e3852ec and 46052ee:
|
kewdex
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
utACK
LGTM
e3852ec to
46d9702
Compare
Co-authored-by: ChALkeR <291301+ChALkeR@users.noreply.github.com>
Co-authored-by: ChALkeR <291301+ChALkeR@users.noreply.github.com>
…sion' Co-authored-by: ChALkeR <291301+ChALkeR@users.noreply.github.com>
46d9702 to
c0aeff7
Compare
wif.d.ts
Outdated
| * Also no inconsistent behavior on Buffer/Uint8Array input. | ||
| * | ||
| * ```js | ||
| * import { fromWifString, toWifString, fromWifStringSync, toWifStringSync } from '@exodus/bytes/wif.js' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot Use the exact import syntax from README
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in 52b3552. The import syntax now matches the README exactly with two separate import statements.
Co-authored-by: ChALkeR <291301+ChALkeR@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds TypeScript type definitions for the wif.js module, following the established patterns used by other modules in the repository (such as base58check.d.ts, base64.d.ts, etc.).
Changes:
- Created comprehensive TypeScript type definitions in
wif.d.tswith JSDoc documentation for all exported functions - Updated
package.jsonto includewif.d.tsin the files list and added types export configuration - Enhanced README.md with detailed function documentation including descriptions, parameters, return values, and error conditions
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| wif.d.ts | Adds TypeScript type definitions for the Wif interface and all exported functions (fromWifString, fromWifStringSync, toWifString, toWifStringSync) with comprehensive JSDoc documentation |
| package.json | Adds wif.d.ts to the files list and configures the types export for ./wif.js module |
| README.md | Enhances documentation for WIF functions with detailed descriptions, parameter documentation, and behavior specifications |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Add TypeScript types for wif.js ✅
wif.d.tswith type definitions for all exported functionswif.d.tsto package.json files list./wif.jsSummary
Successfully added TypeScript type definitions for the
wif.jsmodule, following the same pattern as other modules in the repository (e.g.,base64.d.ts,hex.d.ts,base32.d.ts).Updated README.md with comprehensive documentation for all WIF functions including descriptions, parameters, return values, and error conditions. Parameter names now match the actual implementation.
Import syntax in the type definitions now matches the README exactly (split into two import statements).
Security Summary: No vulnerabilities discovered.
Original prompt
wif.js#29✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.