Repository navigation
Bad error when using import() type within JSDoc tag @implements #58542
Description
🔎 Search Terms
import@implements2304
🕗 Version & Regression Information
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about the JSDoc tag
@implements
⏯ Playground Link
💻 Code
/** @implements {import("a").B} */
class A {}🙁 Actual behavior
Two TypeScript errors:
Cannot find name 'import'.(2304)'}' expected.(2304)
🙂 Expected behavior
TypeScript should allow using import() types within the type of the JSDoc tag @implements.
Additional information about the issue
A workaround is to use a JSDoc @typedef to import the type under an alias, and then use that alias within the JSDoc tag @implements type, e.g:
/** @typedef {import("a").B} B */
/** @implements {B} */
class A {}
Activity
sandersn commentedon Jun 17, 2024
@implementsuses the same grammar as Typescript implements. This is an error in Typescript:However, the error is informative in typescript: "A class can only implement an identifier..." and not in Javascript. Javascript should give the same error.
With the new
@importtag, you should be able to/** @import { B } from 'a' */instead of using@typedef.[-]Error when using `import()` type within JSDoc tag `@implements`[/-][+]Bad error when using `import()` type within JSDoc tag `@implements`[/+]Make @implements/@extends parse more like TS
jaydenseric commentedon Sep 25, 2024
See also #49905 .