require-returns-check returning false errors #924
Description
Expected behavior
There should be no jsdoc/require-returns-check errors reported for the functions below. This was working correctly with eslint-plugin-jsdoc v39.3.14.
/**
* Return a V1 style query identifier.
*
* @param {string} id - The query identifier.
* @returns {string} V1 style query identifier.
*/
function v1QueryId(id) {
switch (id.substring(0, 4)) {
case 'addq':
case 'aliq':
case 'locq':
return id.substring(3);
case 'lost':
return id.substring(4);
default:
return id;
}
}
/**
* Parses the required header fields for the given SIP message.
*
* @param {string} logPrefix - The log prefix.
* @param {string} sipMessage - The SIP message.
* @param {string[]} headers - The header fields to be parsed.
* @returns {object} Object with parsed header fields.
*/
function parseSipHeaders(logPrefix, sipMessage, headers) {
try {
return esappSip.parseHeaders(sipMessage, headers);
} catch (err) {
logger.error(logPrefix, `Failed to parser SIP header(s): ${headers}. ${err}\nMessage:${sipMessage}`);
return {};
}
}Actual behavior
After upgrading to v39.3.19 both functions above return a jsdoc/require-returns-check error.
/test/common.js
125:1 error JSDoc @returns declaration present but return expression not available in function jsdoc/require-returns-check
/test/eventWriter.js
46:1 error JSDoc @returns declaration present but return expression not available in function jsdoc/require-returns-check
ESLint Config
"rules": {
"jsdoc/require-returns-check": 2
}Environment
- Node version: 18.11.0
- ESLint version: 8.26.0
eslint-plugin-jsdocversion: 39.3.19