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(types): mark type parameters as optional #1101

Merged
merged 3 commits into from
Feb 24, 2025
Merged

Conversation

wolfy1339
Copy link
Member

Some types which end-users could be using, declare the type parameters as requried, when in fact they are entirely optional.

This arises when users try to use the event handler code on it's own

Resolves #ISSUE_NUMBER


Before the change?

  • Types which had optional type parameters had them set as required

After the change?

  • The types now have the type parameter set to optional and default to unknown
    This change shouldn't introduce any noticeable behaviour changes for users who use the default Webhooks class

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes
  • No

Some types which end-users could be using, declare the type parameters as requried, when in fact they are entirely optional.

This arises when users try to use the event handler code on it's own
@wolfy1339 wolfy1339 added the Type: Bug Something isn't working as documented, or is being fixed label Feb 5, 2025
Copy link
Contributor

github-actions bot commented Feb 5, 2025

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

@wolfy1339 wolfy1339 mentioned this pull request Feb 5, 2025
1 task
@wolfy1339 wolfy1339 enabled auto-merge (squash) February 24, 2025 14:04
@wolfy1339 wolfy1339 merged commit fead46f into main Feb 24, 2025
6 checks passed
@wolfy1339 wolfy1339 deleted the fix-type-optional-param branch February 24, 2025 14:05
Copy link
Contributor

🎉 This PR is included in version 13.7.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Type: Bug Something isn't working as documented, or is being fixed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants