You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
jsdoc/require-returns should not emit a warning because the return type is Promise<void>.
Actual behavior
1:1 warning Missing JSDoc @returns declaration jsdoc/require-returns.
Happens even if the function is declared async explicitly. Without the <void>, the return type is inferred to be Promise<unknown> in which case the warning makes sense. Is this type knowledge lost to jsdoc in this case?
Expected behavior
jsdoc/require-returns
should not emit a warning because the return type isPromise<void>
.Actual behavior
1:1 warning Missing JSDoc @returns declaration jsdoc/require-returns
.Happens even if the function is declared
async
explicitly. Without the<void>
, the return type is inferred to bePromise<unknown>
in which case the warning makes sense. Is this type knowledge lost to jsdoc in this case?ESLint Config
ESLint sample
The warning can be fixed by adding
@returns nothing
to the jsdoc above.Environment
14.18.1
8.10.0
eslint-plugin-jsdoc
version:37.9.4
The text was updated successfully, but these errors were encountered: