Skip to content

useYield

Diagnostic Category: lint/correctness/useYield

JavaScript (and super languages)

Since: v1.0.0

Sources:

Same as: require-yield

Description

Require generator functions to contain yield.

This rule generates warnings for generator functions that do not have the yield keyword.

Examples

Invalid

function* foo() {
  return 10;
}

code-block.js:1:1 lint/correctness/useYield ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ This generator function doesn’t contain yield.
  
  > 1 │ function* foo() {
      │ ^^^^^^^^^^^^^^^^^
  > 2 │   return 10;
  > 3 │ }
      │ ^
    4 │

Valid

function* foo() {
  yield 5;
  return 10;
}

function foo() {
  return 10;
}

// This rule does not warn on empty generator functions.
function* foo() { }

How to configure

{
  "linter": {
    "rules": {
      "correctness": {
        "useYield": "error"
      }
    }
  }
}