microsoft / microsoft/TypeScript
Cannot specify a JSDoc `@overload` signature using the `@type` tag
Abierto
Nadie ha tomado este issue todavía.
Awaiting More Feedback
checkJs
Domain: JavaScript
Domain: JSDoc
Suggestion
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.4k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 117
Descripción
Often, I use @type because the @param + @return syntax is so unwieldy; however, it's not usable with @overload.
// @ts-check
/**
* @overload
* @type {(x: number) => number}
*/
/**
* @type {(x: number) => number}
*/
function id(x) {
return x;
}
id(123).toFixed(2);
// ~~~ Expected 0 arguments, but got 1.
I'd expect the above not to error; but it does.
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
Comienza reproduciendo el ejemplo mínimo de JavaScript con @ts-check y las etiquetas JSDoc @overload y @type asociadas. Sigue cómo el comprobador de tipos gestiona las declaraciones @overload usando @type y, después, verifica que id(123).toFixed(2) ya no informe de un error en el número de argumentos.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript, 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
- 42/100