[Fix] add a few jsdoc type annotations to work around TS inference bugs for consumers #3695
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
bradzacher
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3695 +/- ##
=======================================
Coverage 97.76% 97.76%
=======================================
Files 133 133
Lines 9471 9471
Branches 3472 3472
=======================================
Hits 9259 9259
Misses 212 212 ☔ View full report in Codecov by Sentry. |
ljharb
reviewed
Feb 21, 2024
ljharb
force-pushed
the
add-minor-type-annotations
branch
from
85617a6
to
2124d13
Compare
ljharb
approved these changes
Mar 3, 2024
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.
Figured I'd split this out of #3694
This PR adds a few JSDoc type annotations to hint to TS what the types are. This helps work-around issues like typescript-eslint/typescript-eslint#8522 / microsoft/TypeScript#57460 where TS would infer the wrong type from the JS and would break strictly-typed config files.