microsoft / microsoft/TypeScript
JSDOC generics bug for callbacks when args are present
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 2 T. 4 Std.
- Gemergte PRs (30 T.)
- 132
Beschreibung
🔎 Search Terms
"Generics", "JSDOC", "Callback"
🕗 Version & Regression Information
TS 5.7.3
v5.8.0-dev.20250131
⏯ Playground Link
💻 Code
In the following example, define() should return VC<S>, but when arg callback has args it does not resolve S and returns VC<any>.
/**
* @template S
* @param {(arg0: { observer: EO }) => S} callback
* @param {Options} [options]
* @returns {VC<S>}
*/
/*
* @type { <S>(fn: (arg0: { observer: EO; }) => S, options?: Options) => VC<S> }
*/
function define(callback, options) {
const { name } = options ?? {}
const observer = new EO()
const state = callback({ observer })
return new VC(state)
}
/**
* @template S
*/
class VC {
/** @type {S} */
state
/**
* @param {S} state
*/
constructor(state) {
this.state = state
}
}
/** @typedef {{ name?: string }} Options */
class EO {}
// Arg `callback` with args - JSDOC doesn't resolve S.
// JSDOC const v1: VC<any>
// TS const v1: VC<boolean>
const v1 = define((arg0) => true, { name: 'default' })
// Arg `callback` without args - JSDOC does resolve S.
// JSDOC const v2: VC<boolean>
// TS const v2: VC<boolean>
const v2 = define(() => true, { name: 'default' })
🙁 Actual behavior
JSDOC doesn't resolve S
🙂 Expected behavior
JSDOC should resolve S in the same way as TS.
Additional information about the issue
No response
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 mit dem verlinkten TypeScript Playground-Repro und vergleiche die inferierten Typen von v1 und v2 mit den erwarteten TypeScript-Ergebnissen. Verfolge anschließend den Inferenzpfad für generische JSDoc-Callbacks im Compiler und füge einen Regressionstest hinzu, der zeigt, dass v1 als VC inferiert wird, wenn der Callback ein Argument hat.
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
- 35/100