-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
docs: [no-unsafe-call] clarify that you can never safely narrow Function #10058
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
docs: [no-unsafe-call] clarify that you can never safely narrow Function #10058
Conversation
Thanks for the PR, @kirkwaiblinger! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
☁️ Nx Cloud ReportCI is running/has finished running commands for commit d1bb0bd. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 2 targetsSent with 💌 from NxCloud. |
This looks great! I think the key clarification for me would be something explicit along the lines of “there is no safe way to narrow a value whose type you don’t know into something that’s safe to call” Maybe it would also be valuable to suggest type assertion within the try/catch as a preferred workaround to suppressing the lint rule? like: try {
(maybeFunction as () => void)();
} catch (e) {
console.error(
'Function either could not be called or threw an error when called:',
e,
);
} since this way, you still let but I think as-is, the PR is a great improvement to the docs for this new case |
@controversial Good suggestions! I've updated it, and pared down the extraneous information 👍 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #10058 +/- ##
==========================================
+ Coverage 85.99% 86.01% +0.02%
==========================================
Files 428 427 -1
Lines 14912 14892 -20
Branches 4332 4329 -3
==========================================
- Hits 12823 12810 -13
+ Misses 1744 1736 -8
- Partials 345 346 +1
Flags with carried forward coverage won't be shown. Click here to find out more. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🆒
PR Checklist
Overview
Followup to #9108 (comment)
cc @controversial feel free to chime in with your thoughts!
Co-authored-by: @controversial