jsdoc/require-property Correctness

✅ This rule is turned on by default.

Requires that all @typedef and @namespace tags have @property tags when their type is a plain object, Object, or PlainObject.

Object type should have properties defined.

Examples of incorrect code for this rule:

javascript

/**
 * @typedef {Object} SomeTypedef
 */

/**
 * @namespace {Object} SomeNamesoace
 */

Examples of correct code for this rule:

javascript

/**
 * @typedef {Object} SomeTypedef
 * @property {SomeType} propName Prop description
 */

/**
 * @typedef {object} Foo
 * @property someProp
 */

How to use

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

CLIConfig (.oxlintrc.json)

bash

oxlint --deny jsdoc/require-property --jsdoc-plugin

json

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