/** @deprecated */ support broken on mapped types

Bug Report

🔎 Search Terms

vscode, jsdoc

🕗 Version & Regression Information

4.1.3

⏯ Playground Link

Playground link with relevant code

💻 Code

type ApiDict = {
  /**
   * jsdoc for getString
   */
  getString: string;
  /**
   * jsdoc for getBoolean
   * 
   * @deprecated
   */
  getBoolean: boolean;
};

type Api = {
  [key in keyof ApiDict]: {
    (url: string): ApiDict[key]; 
  };
};

declare const api: Api;
declare const api2: ApiDict;

api.getBoolean
api2.getBoolean

related issue

https://github.com/microsoft/TypeScript/issues/42549

[scvnathan]

Should this be expected to work then? In this contrived example, Partial and MappedType aren’t really assigning a new type to the properties, right?

function getColor(colors?: {red?: string, orangered?: string}) {  
  return {
    /** @deprecated use orangered */
    red: colors?.orangered,
    orangered: colors?.orangered,
    blue: '...'
  }
}

type MappedType<T> = { [K in keyof T]: T[K]};

type ColorResponse = Partial<ReturnType<typeof getColor>>;
type ColorResponse2 = MappedType<ReturnType<typeof getColor>>;
type ColorResponse3 = ReturnType<typeof getColor>;

const colors: ColorResponse = getColor();
const colors2: ColorResponse2 = getColor();
const colors3: ColorResponse3 = getColor();


// no strikethrough
const red = colors?.red

// no strikethrough
const red2 = colors2?.red;

// strikethrough
const red3 = colors3?.red;

// All are deprecated in popup

Either way, I find it confusing that a property can be marked as deprecated in a popup and not also include the strike-through. Why the inconsistency?

https://www.typescriptlang.org/play?#code/GYVwdgxgLglg9mABAcwKZQMJwDZwE4AUEO+AzgPwBciA3nqgCZWKlR4xjIA0i+Ahp1T0m1Vu04BfAJS1EiAFBz6UEHiQ1FcxAHoAVLsQABBqgAO9CHyiNEIUql54BaYYl3bNSxtWK48FADp+QWEuT0dnIW9EXzJyIKcQxjCtRAAjbBBUagByAPyczQl5YvkoAE9TBwBZPlMqhgAVStQAHkaAPkQAXlkAbQBpRA5EAGtUcrhgREaAXWpGwdmJAG55MpbELD8AJVRSUwR7HsQABT48WD5sVr2VNWaq1oqqqZR0bfwOjrWXh0+8HsDkdUAAmE61eqMR5tO6qMAw54tN5oTAkPDfX6bAFAw5gewAZhOcIeLSRr2mqIBP3WxHxUBi6NI1Bx+zxx16VPRBCkazprEZflIoJZ6NxIPBnI+3N58n5DNi-gJot2bJBRKlaL8PLW6202kQABEzBYrDYRodTCBTDwwHAWGwYOMoAALPBwEDIF1yo4M1y9RWBYTyfVGk2oSzWBjDJCW622+1iJ3oN0er0++mIYSSwVkUHxYRrUPG8wRs3Ri1wK02h3sZ2pz3e+VZxga3NKguMFZAA

[moshest]

Think as well that deprecated keys should inherit deprecation marks from their parents.

@deprecated used to inform the user that this property will no longer exists in future versions. When this property removed, the type that used this deprecated key will also breaks so we should display this for the user as well.

Right now the inconsistent status when the tooltip showing the @deprecated comment on hover but don’t display the deprecation mark on the code feels buggy.