← Back to rules

jsdoc/require-yields-type Pedantic

What it does

Requires a type on the @yields tag.

Why is this bad?

A @yields tag should document the type yielded by the generator.

Examples

Examples of incorrect code for this rule:

/** @yields */
function* quux() {}

Examples of correct code for this rule:

/** @yields {string} */
function* quux() {}

How to use

To enable this rule using the config file or in the CLI, you can use:

Config (.oxlintrc.json)

{
  "plugins": ["jsdoc"],
  "rules": {
    "jsdoc/require-yields-type": "error"
  }
}

Config (oxlint.config.ts)

import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["jsdoc"],
  rules: {
    "jsdoc/require-yields-type": "error",
  },
});

CLI

oxlint --deny jsdoc/require-yields-type --jsdoc-plugin

Version

This rule was added in vnext.

References

• Rule Source
• Open rule in Oxc Playground