Skip to content

docs: added note on async generator support in require-await #9795

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

Conversation

xaos7991
Copy link
Contributor

PR Checklist

Overview

Added a note to the @typescript-eslint/require-await documentation indicating that the rule supports async generator functions. This clarification ensures users are aware that async generators are subject to the same enforcement as other async functions.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @xaos7991!

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.

Copy link

netlify bot commented Aug 14, 2024

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 02070fd
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/66d1df5280a069000893298e
😎 Deploy Preview https://deploy-preview-9795--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 99 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 90 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@kirkwaiblinger kirkwaiblinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @xaos7991!

Thanks for sending in your first contribution to typescript-eslint!! Just requesting an example be added for clarity. But this is great! 🙂

@kirkwaiblinger kirkwaiblinger added awaiting response Issues waiting for a reply from the OP or another party documentation Documentation ("docs") that needs adding/updating labels Aug 18, 2024
@github-actions github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Aug 19, 2024
Copy link

codecov bot commented Aug 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.05%. Comparing base (e5d1ac4) to head (02070fd).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #9795   +/-   ##
=======================================
  Coverage   88.05%   88.05%           
=======================================
  Files         407      407           
  Lines       13947    13947           
  Branches     4071     4071           
=======================================
  Hits        12281    12281           
  Misses       1354     1354           
  Partials      312      312           
Flag Coverage Δ
unittest 88.05% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Copy link
Member

@kirkwaiblinger kirkwaiblinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me. Thanks for taking care of this!
congratulatory gif

@kirkwaiblinger kirkwaiblinger added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Aug 27, 2024
@kirkwaiblinger kirkwaiblinger merged commit 46f27e6 into typescript-eslint:main Aug 30, 2024
56 of 59 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 8, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge documentation Documentation ("docs") that needs adding/updating
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: [require-await] document behavior around generator functions
3 participants