fix: added definite type so that caller does not get warnings #1622
Conversation
This file contains 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
This will give typescript the correct return type.
gr2m
reviewed
Nov 29, 2021
src/context.ts
Outdated
| /** Repo owner type, either string or never depending on the context */ | ||
| type RepoOwnerType<T extends WebhookEvents> = | ||
| WebhookEvent<T>["payload"] extends { repository: { owner: { login: string } } } ? string : never | | ||
| WebhookEvent<T>["payload"] extends { repository: { owner: { name: string } } } ? string : never; |
There was a problem hiding this comment.
I don't think there is such a thing as repository.owner.name? It's always owner.login, even for organizations
There was a problem hiding this comment.
I'm not sure, I just took it from here:
Line 76 in 718025d
There was a problem hiding this comment.
got it, it's out of scope of this PR then. .name does exist, but it's human name of the owner, such as "Gregor Martynus" for @gr2m. This code is not correct. If you like feel free to send a PR to fix that and remove the || repo.owner.name part
gr2m
approved these changes
Nov 29, 2021
|
🎉 This PR is included in version 12.1.2 🎉 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
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.
This will give typescript the correct return type.
My ts compiler complains about the any type, this should fix it.
Only question would be if the context type does not support some of the properties the correct type would be undefined.
This would mask the error.
The first commit is the easy solution, the second uses conditional types to detect that problem.
Let me know what you think.
Should I add export to the types?