microsoft / microsoft/TypeScript
Cannot specify a JSDoc `@overload` signature using the `@type` tag
Offen
Dieses Issue hat noch niemand übernommen.
Awaiting More Feedback
checkJs
Domain: JavaScript
Domain: JSDoc
Suggestion
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 1 T. 19 Std.
- Gemergte PRs (30 T.)
- 117
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, das minimale JavaScript-Beispiel mit @ts-check und den zugehörigen JSDoc @overload- und @type-Tags zu reproduzieren. Verfolge, wie der Typechecker @overload-Deklarationen mithilfe von @type verarbeitet, und überprüfe anschließend, dass id(123).toFixed(2) keinen Fehler bezüglich der Anzahl der Argumente mehr meldet.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript, typescript
- Bereich
- compilers
- Issue-Typ
- Bug
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 42/100