microsoft / microsoft/TypeScript

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

Ouverte
#42,609 6 commentaires 7 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Awaiting More Feedback Suggestion
Langage dominant
Go
Étoiles
111k
Forks
14.3k
Merge moyen
2 j 4 h
PR mergées (30 j)
132

Description

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

image

related issue

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la reproduction liée dans TypeScript Playground et comparez la propriété getBoolean dépréciée sur ApiDict avec le type Api mappé. Suivez la façon dont JSDoc est transmis à travers les types mappés ; le travail est terminé lorsque la propriété mappée affiche le même avertissement de dépréciation que la propriété d’origine, avec une couverture de régression ajoutée là où le compilateur teste ce comportement.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
typescript
Domaine
compilers
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.