docs(eslint-plugin): [prefer-for-of] mention DOM elements and lib: dom.iterable #11642
Conversation
|
Thanks for the PR, @JoshuaKGoldberg! 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 project configuration. |
|
View your CI Pipeline Execution ↗ for commit d02375f
☁️ Nx Cloud last updated this comment at |
| {/* Intentionally Omitted: When Not To Use It */} | ||
| ## DOM Elements | ||
|
|
||
| By default, TypeScript's type checking only allows `for-of` loops over DOM iterables such as `HTMLCollectionOf` when the `dom.iterable` `lib` option is enabled. |
There was a problem hiding this comment.
Worth noting that this is basically a TS bug and will be changed in TS 6. There are probably better references but this is discussed at microsoft/TypeScript#62196
There was a problem hiding this comment.
I'm so excited for TS 6 🙌
There was a problem hiding this comment.
@kirkwaiblinger I'm a little hesitant to mention "this might change hopefully probably" - do you mind if we leave it out of the docs for now?
There was a problem hiding this comment.
think this one is pretty safe to count on to be in TS 6 (another ref here microsoft/TypeScript#54500), but I'm also ok if we leave it off and update the docs again in the future 👍
There was a problem hiding this comment.
I set a calendar reminder for December 1st if we don't get to it by then.
There was a problem hiding this comment.
Here's the issue I was thinking of
JoshuaKGoldberg
added
the
1 approval
| {/* Intentionally Omitted: When Not To Use It */} | ||
| ## DOM Elements | ||
|
|
||
| By default, TypeScript's type checking only allows `for-of` loops over DOM iterables such as `HTMLCollectionOf` when the `dom.iterable` `lib` option is enabled. |
There was a problem hiding this comment.
think this one is pretty safe to count on to be in TS 6 (another ref here microsoft/TypeScript#54500), but I'm also ok if we leave it off and update the docs again in the future 👍
JoshuaKGoldberg
merged commit 692d4ee
into
typescript-eslint:main
3 participants
PR Checklist
Overview
As a nice side effect, this reduces the "Intentionally Omitted: When Not To Use It" comments from 7 to 6.
💖