microsoft / microsoft/TypeScript
JSDoc doesnt support generics correctly
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.4k
- Ø Merge
- 1 T. 19 Std.
- Gemergte PRs (30 T.)
- 117
Beschreibung
🔎 Search Terms
jsdoc generics
🕗 Version & Regression Information
- This is a crash
- This changed between versions ______ and _______
- This changed in commit or PR _______
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about _________
- I was unable to test this on prior versions because _______
⏯ Playground Link
No response
💻 Code
Given the following code:
function api<T>(endpoint: string): Promise<T> {
return fetch(endpoint).then(res => res.json());
}
When I consume the api function in a .js file, I'd still like to leverage the T generic via JSDoc-only. There currently isnt a straightforward way to do this, and the DX of this could definitely be improved.
🙁 Actual behavior
Cant leverage the T generic
🙂 Expected behavior
I can leverage the T generic
Additional information about the issue
This is a long overdue feature :)
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
Reproduziere das api-Beispiel in einem .js-Consumer und untersuche, wie TypeScript derzeit JSDoc-Generics behandelt. Im Issue ist keine bestimmte Quelldatei oder kein bestimmter Test angegeben; als erledigt gilt die Aufgabe, wenn JavaScript-Nutzer das T-Generic über JSDoc mit einer verbesserten Entwicklererfahrung ausdrücken und verwenden können.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript, typescript
- Bereich
- compilers, developer-experience
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 35/100