Module augmentation allows non-identical type parameters as long as there are defaults, but doesn't pass them
#55,026 opened on Jul 14, 2023
Repository metrics
- Stars
- (48,455 stars)
- PR merge metrics
- (Avg merge 6d 17h) (9 merged PRs in 30d)
Description
Bug Report
🔎 Search Terms
- module augmentation
- callback generic type
🕗 Version & Regression Information
Currently using typescript 5.1.6, but AFAIK this behavior was the same in previous versions. This also occurs on the Nightly.
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about generics (and the rest of the FAQ)
⏯ Playground Link
Playground link with relevant code
💻 Code
interface Chainable<Subject = any> {
within(fn: (prevSubject: Subject) => Chainable<Subject>): Chainable<Subject>;
}
interface Chainable<Subject = any, ExtraType = undefined> {
within(fn: (prevSubject: Subject, extra: ExtraType) => Chainable<Subject>): Chainable<Subject, ExtraType>;
}
interface ChainableLike<Subject = any, ExtraType = undefined> {
within(fn: (prevSubject: Subject) => Chainable<Subject>): Chainable<Subject>;
within(fn: (prevSubject: Subject, extra: ExtraType) => Chainable<Subject>): Chainable<Subject, ExtraType>;
}
type ChainableWithSecondType = Chainable<string, string>;
type Wrong = ChainableWithSecondType['within'];
type Correct = ChainableLike<string, string>['within'];
🙁 Actual behavior
If you omit the default on the added generic ExtraType, you get an error: All declarations of 'Chainable' must have identical type parameters. But when there's a default, it allows the type parameters to be different, but doesn't properly infer types.
Typescript does not produce any errors, but when you mouseover Wrong, it shows the type of extra to be ExtraType.
🙂 Expected behavior
Either TS should completely ban adding an optional extra type parameter, or it should properly infer type (i.e. mousing over Wrong should produce the same as mousing over Correct)