Skip to content

Docs: [require-await] document behavior around generator functions #9769

Closed
@kirkwaiblinger

Description

@kirkwaiblinger

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

The base rule explicitly mentions that it does not flag on generators.

Our rule intentionally departs from that behavior. However, we don't say so in the docs, so, it's surprising when you encounter a require-await error in a generator function. Let's document this!

See, e.g. #1782 and #8003

Affected URL(s)

https://typescript-eslint.io/rules/require-await/

Metadata

Metadata

Assignees

No one assigned

    Labels

    accepting prsGo ahead, send a pull request that resolves this issuedocumentationDocumentation ("docs") that needs adding/updatinglocked due to agePlease open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions