microsoft / microsoft/TypeScript
JSDoc disappeared in overloading with mapped type
Nadie ha tomado este issue todavía.
- 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
example 1, bug, no jsdoc:
No JSDoc if overloading in mapped type

example 2, works well:
Has JSDoc if no overloading in mapped type

example 3, bug, no jsdoc:
JSDoc disappeared without overloading

💻 Code
type ApiDict = {
/**
* jsdoc for getString
*/
getString: string;
/**
* jsdoc for getBoolean
*/
getBoolean: boolean;
};
type Api = {
[key in keyof ApiDict]: {
(url: string): ApiDict[key];
(url: string, config: {}): { data: ApiDict[key]; extra: any };
};
};
declare const api: Api;
api.getBoolean('', {});
type ApiDict = {
/**
* jsdoc for getString
*/
getString: string;
/**
* jsdoc for getBoolean
*/
getBoolean: boolean;
};
type Api = {
[key in keyof ApiDict]: {
(url: string, config: {}): { data: ApiDict[key]; extra: any };
};
};
declare const api: Api;
api.getBoolean('', {});
/**
* jsdoc for JsdocDisappearedWithoutOverloading
*/
interface JsdocDisappearedWithoutOverloading {
(url: string): any;
}
declare const jsdocDisappearedWithoutOverloading: JsdocDisappearedWithoutOverloading;
jsdocDisappearedWithoutOverloading('');
🙂 Expected behavior
All of examples has jsdoc
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza ejecutando los tres ejemplos enlazados de TypeScript Playground y compara los casos de sobrecargas en mapped types con el caso que funciona y con la callable interface independiente. Usa los fragmentos de TypeScript proporcionados para reproducir el JSDoc que falta. Se considera terminado cuando todos los ejemplos conservan su JSDoc declarado, incluidos los mapped types con firmas de llamada sobrecargadas.
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