Microsoft/TypeScript
JSDoc `@callback` tag types are only checked if referenced by code
Ouverte
#47 608 ouverte le 26 janv. 2022
BugDomain: JSDocHelp Wanted
Métriques du dépôt
- Stars
- (108 860 étoiles)
- Métriques de merge PR
- (Métriques PR en attente)
Description
Bug Report
🔎 Search Terms
@callback jsdoc "no error"
🕗 Version & Regression Information
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about
@callback
⏯ Playground Link
Playground link with relevant code
💻 Code
// @ts-check
/**
* @callback UnreferencedCb
* Does not report an error on "badtype".
* @returns {badtype}
*/
/**
* @callback ReferencedCb
* Reports an error on "badtype", but only if ReferencedCb is referenced by actual code.
* @returns {badtype} abc
*/
/**
* @typedef {badtype} UnreferencedType
* Properly reports an error on "badtype".
*/
/** @type {ReferencedCb} Without this reference, the badtype in ReferencedCb is ignored. */
const foo = () => 'abc';
🙁 Actual behavior
The badtype in the definition UnreferencedCb is not marked as an unknown name, but it is one. Typing some JS code with UnreferencedCb causes TS to behave correctly and be marked as an unknown name.
The other badtypes are correctly marked as unknown names (Cannot find name 'badtype'.(2304)).
🙂 Expected behavior
All occurrences of badtype should be marked as syntax errors with Cannot find name 'badtype'.(2304), since that type is not defined.
The @callback JSDocs should be checked when // @ts-check is enabled, regardless of whether they are actually referenced by JS code in the same file.