microsoft / microsoft/TypeScript

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

Abierto
#42,609 6 comentarios 7 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Awaiting More Feedback Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.4k
Merge medio
1 d 19 h
PR fusionados (30 d)
117

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Empieza con la reproducción vinculada en TypeScript Playground y compara la propiedad obsoleta getBoolean de ApiDict con el tipo Api mapeado. Rastrea cómo se conserva JSDoc a través de los tipos mapeados; se considera terminado cuando la propiedad mapeada muestra la misma advertencia de obsolescencia que la propiedad original, con cobertura de regresión añadida donde el compilador prueba este comportamiento.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
typescript
Área
compilers
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.