@deprecated does not work on index signatures

[ab-pm]

🔎 Search Terms

index signature deprecation annotation @deprecated jsdoc

💻 Code

interface Example {
    /** @deprecated please no longer use this, it's unsafe and kept only for b/c */
    [p: string]: any;
    /** @deprecated please use `.y` instead  */
    x: number;
    /** Superseeds `.x` */
    y: number;
}

function example(e: Example) {
    console.log(e.x); // marked as deprecated, as expected
    console.log(e.y); // not marked as deprecated, as expected
    console.log(e.z); // not marked as deprecated, but should be
}

Playground with relevant code

🙁 Actual behavior

e.z shows up like a normal property, but it's deprecated.

🙂 Expected behavior

Any usage of e.z should be highlighted as deprecated.

[ab-pm]

@a-tarasyuk Wow thanks for the fix! I don't know if it's easy to add, or rather should be asked in a separate issue, but I noticed that actually none of the jsdoc annotations work for index signatures, it doesn't show doc comments either.

[sandersn]

@ab-pm Definitely open a new issue for that. Thanks for noticing and filing these bugs.