Repository navigation
Extend @interface support to @typedefs #3050
Description
Search Terms
interface typedef
Problem
type Foo = { a: number; b: boolean };
/** @interface */
type Bar = Omit<Foo, "b">; // Expands to { a: number }/**
* @typedef Foo
* @property {number} a
* @property {boolean} b
*/
/**
* @typedef {Omit<Foo, "b">} Bar
* Still rendered as `Omit<Foo, "b">`
* @interface
*/Suggested Solution
The rendered result is the same between typescript and javascript.
I understand javascript support isn't the primary focus of this project. If there is a disinclination to extend the @interface feature, would it at all be feasible as a plugin (before I dive in myself to try)?
Activity
stwlam commentedon Dec 10, 2025
Actually, I see from #2916 that this isn't possible with a separate
@interfaceline. I might try to parse out a hint buried in descriptions with a plugin.Support special handling of inline tags for typedefs
Gerrit0 commentedon Dec 13, 2025
Coming back to this several months later, there is a way to do this by allowing TypeDoc to parse
{@interface}as a modifier tag when parsing comments for@typedef(and friends)... it's kind of hacky, but honestly most things to do with@typedefare kind of hacky.stwlam commentedon Dec 13, 2025
In case it has any relevance, I also recently noticed that block tags like
@templatemust be above the@typedefline for vscode (and presumably therefore tsc) to process them correctly: