Skip to content

feat: add TypeScript type definitions for base58.js#32

Merged
ChALkeR merged 6 commits intomainfrom
copilot/update-base58js
Jan 22, 2026
Merged

feat: add TypeScript type definitions for base58.js#32
ChALkeR merged 6 commits intomainfrom
copilot/update-base58js

Conversation

Copy link
Contributor

Copilot AI commented Jan 22, 2026

  • Create base58.d.ts TypeScript type definitions file
  • Update package.json to include base58.d.ts in files array
  • Update package.json exports to include types for base58.js
  • Verify TypeScript types compile correctly
  • Run tests to ensure everything works
  • Address code review feedback - add third overload for better type safety
  • Remove unrelated .gitignore change per review feedback
  • Add documentation for base58 functions in README
  • Add IETF base58 specification link to documentation
Original prompt

This section details on the original issue you should resolve

<issue_title>Types: base58.js</issue_title>
<issue_description></issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI changed the title [WIP] Update base58.js to address types issue Add TypeScript type definitions for base58.js Jan 22, 2026
Copilot AI requested a review from ChALkeR January 22, 2026 10:39
@ChALkeR ChALkeR changed the title Add TypeScript type definitions for base58.js feat: add TypeScript type definitions for base58.js Jan 22, 2026
.gitignore Outdated
coverage
playground
*.tgz
package-lock.json
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot remove unrelated change

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Removed the .gitignore change in commit 0b4df81.

Copy link
Collaborator

@ChALkeR ChALkeR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot Also add the same docs to README to corresponding sessions.

Copy link
Contributor Author

Copilot AI commented Jan 22, 2026

@copilot Also add the same docs to README to corresponding sessions.

Added documentation for all base58 functions in README in commit 9a1a983.

Copilot AI and others added 5 commits January 22, 2026 18:56
Co-authored-by: ChALkeR <291301+ChALkeR@users.noreply.github.com>
…e safety

Co-authored-by: ChALkeR <291301+ChALkeR@users.noreply.github.com>
Co-authored-by: ChALkeR <291301+ChALkeR@users.noreply.github.com>
Co-authored-by: ChALkeR <291301+ChALkeR@users.noreply.github.com>
@ChALkeR ChALkeR force-pushed the copilot/update-base58js branch from 9a1a983 to 5e925e7 Compare January 22, 2026 14:56
Co-authored-by: ChALkeR <291301+ChALkeR@users.noreply.github.com>
@ChALkeR ChALkeR marked this pull request as ready for review January 22, 2026 15:04
Copilot AI requested a review from ChALkeR January 22, 2026 15:04
@ChALkeR ChALkeR requested a review from Copilot January 22, 2026 15:04
Copy link

Copilot AI left a 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 base58.js module, improving type safety and developer experience when using this library in TypeScript projects.

Changes:

  • Added comprehensive TypeScript type definitions in base58.d.ts with function overloads for different return types
  • Updated package.json to include the types file in the distribution and configure proper type exports
  • Enhanced README.md with detailed documentation for base58 functions and IETF specification link

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.

File Description
base58.d.ts New TypeScript type definitions file with proper overloads for fromBase58, toBase58, fromBase58xrp, and toBase58xrp functions, including JSDoc documentation
package.json Added base58.d.ts to files array and configured exports with types field for proper TypeScript resolution
README.md Added comprehensive documentation for base58 functions with descriptions and links to IETF specification

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@ChALkeR ChALkeR merged commit 613d893 into main Jan 22, 2026
36 checks passed
@ChALkeR ChALkeR deleted the copilot/update-base58js branch January 22, 2026 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Types: base58.js

2 participants