For AI agents: the complete documentation index is available at https://rslint.rs/llms.txt, the full documentation bundle is available at https://rslint.rs/llms-full.txt, and this page is available as Markdown at https://rslint.rs/rules/eslint/require-yield.md.
close

require-yield

Added in v0.5.0

Configuration

PresetConfigured Value
✅ js.configs.recommended"error"
rslint.config.ts
import { defineConfig, js } from '@rslint/core';

export default defineConfig([
  js.configs.recommended,
  {
    rules: {
      'require-yield': 'error',
    },
  },
]);

Rule Details

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

Examples of incorrect code for this rule:

function* foo() {
  return 10;
}

Examples of correct code for this rule:

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

function foo() {
  return 10;
}

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

When Not To Use It

If you don't want to notify generator functions that have no yield expression, then it's safe to disable this rule.

Original Documentation