jsdoc/require-returns-type Pedantic ​
What it does ​
Requires that @returns tag has a type value (in curly brackets).
Why is this bad? ​
A @returns tag should have a type value.
Examples ​
Examples of incorrect code for this rule:
javascript
/** @returns */
function quux(foo) {}Examples of correct code for this rule:
javascript
/** @returns {string} */
function quux(foo) {}How to use ​
To enable this rule in the CLI or using the config file, you can use:
bash
oxlint --deny jsdoc/require-returns-type --jsdoc-pluginjson
{
"plugins": ["jsdoc"],
"rules": {
"jsdoc/require-returns-type": "error"
}
}