require-returns-check.md

require-returns-check

{"gitdown": "contents", "rootId": "require-returns-check"}

Requires a return statement (or non-undefined Promise resolve value) be present in a function body if a @returns tag (without a void or undefined type) is specified in the function's JSDoc comment block.

Will also report @returns {void} and @returns {undefined} if exemptAsync is set to false and a non-undefined value is returned or a resolved value is found. Also reports if @returns {never} is discovered with a return value.

Will also report if multiple @returns tags are present.

Options

• exemptGenerators- Because a generator might be labeled as having a IterableIterator @returns value (along with an iterator type corresponding to the type of any yield statements), projects might wish to leverage @returns in generators even without a return statement. This option is therefore true by default in typescript mode (in "jsdoc" mode, one might be more likely to take advantage of @yields). Set it to false if you wish for a missing return to be flagged regardless.
• exemptAsync - By default, functions which return a Promise that are not detected as resolving with a non-undefined value and async functions (even ones that do not explicitly return a value, as these are returning a Promise implicitly) will be exempted from reporting by this rule. If you wish to insist that only Promise's which resolve to non-undefined values or async functions with explicit return's will be exempted from reporting (i.e., that async functions can be reported if they lack an explicit (non-undefined) return when a @returns is present), you can set exemptAsync to false on the options object.
• reportMissingReturnForUndefinedTypes - If true and no return or resolve value is found, this setting will even insist that reporting occur with void or undefined (including as an indicated Promise type). Unlike require-returns, with this option in the rule, one can discourage the labeling of undefined types. Defaults to false.

Context and settings

Context	ArrowFunctionExpression, FunctionDeclaration, FunctionExpression
Tags	returns
Aliases	return
Options	exemptAsync, exemptGenerators, reportMissingReturnForUndefinedTypes
Recommended	true

Failing examples

Passing examples