Skip to content
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

fix: Fix typings for eventwebhook.d.ts PublicKey #1351

Merged

Conversation

Cellule
Copy link
Contributor

@Cellule Cellule commented Mar 16, 2022

Fixes

Installing @sendgrid/eventwebhook in a project using typescript cannot properly compile because starkbank-ecdsa does not provide any typings and none are available in DefinitelyTyped project either.
Right now the only way to use the module is to ourselves provide a definition of starkbank-ecdsa OR patch-package @sendgrid/eventwebhook

I've decided to change the import statement with a minimal interface of PublicKey which should be enough to use the package properly in a typescript project.

Technically speaking, @types/node is also required because you use Buffer in the types, but a typescript project without it would be weird so I think we can let that one as-is.

Checklist

  • I acknowledge that all my contributions will be made under the project's license
  • I have made a material change to the repo (functionality, testing, spelling, grammar)
  • I have read the Contribution Guidelines and my PR follows them
  • I have titled the PR appropriately
  • I have updated my branch with the main branch
  • I have added tests that prove my fix is effective or that my feature works
  • I have added the necessary documentation about the functionality in the appropriate .md file
  • I have added inline documentation to the code I modified

Copy link
Contributor

@childish-sambino childish-sambino left a comment

Choose a reason for hiding this comment

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

LGTM

@childish-sambino childish-sambino merged commit dd8ddac into sendgrid:main Mar 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants