microsoft / microsoft/TypeScript
Distribute union types over generic function application
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.4k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
Suggestion
🔍 Search Terms
generic union distribute function mapped
✅ Viability Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
⭐ Suggestion
It should be possible to call a generic function with a union as input and separately resolve the generics for each member of the union. This mimics the way generic types can be distributed over a union.
📃 Motivating Example
Consider this simple example (playground):
type A<T> = (a: T) => T; // any type invariant on T
function foo<T>(a: A<T>) {}
declare const a: A<1> | A<2>;
foo(a); // error: A<1> | A<2> is not assignable to A<1 | 2>
The function foo is perfectly capable of handling an input of either A<1> or A<2>, but Typescript will not allow you to execute it on the union of those types. That is because it tries to find a single instantiation for T that works, but there is none, because the type A<T> is not covariant.
In the case that foo had an output, foo: <T>(a: A<T>) => B<T>, for input of A<1> | A<2> the output type would be B<1> | B<2>, much the same as how distributing over a union works in a type expression like X extends A<infer T> ? B<T> : never;
💻 Use Cases
This is one of a few issues that make non-covariant types a little bit second-class to work with in Typescript. And some of the other issues might be very hard to resolve, like how to type "An array of A<T> where each element can have a different T" without using any. But in comparison, I don't think this one requires any deep thought for the desired behavior, and while the implementation might be tricky I don't think it requires any truly new capabilities.
Workarounds:
- For a function where
Tdoesn't appear in the output, like<T>(a: A<T>) => void, can be typed as(a: A<any>) => void. Then it works with unions as input. However, that introducesanys into the typechecking of the function's implementation, which don't need to be there. Instead, you can explicitly specifyfoo<any>(x)when calling the function. But if the function has other generics, that will make it so they also have to be explicitly specified instead of inferred. - For a function where
Tdoes appear in the output, like<T>(a: A<T>) => B<T>whereA<T>andB<T>are both invariant, I am not aware of any workaround except casting. Usinganyleaks into the output type and therefore the rest of your code. Even casting in that situation is more brittle than usual, as changes to the input union type or to the definition of the function's output type will both be lost.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the motivating example in the linked TypeScript Playground and read the issue's discussion of generic inference over unions. Done means a generic function accepts A<1> | A<2>, resolves the generic separately for each member, and produces the corresponding union output without requiring any or a cast.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100