microsoft / microsoft/TypeScript

Distribute union types over generic function application

Aperta
#52,295 5 commenti 4 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Awaiting More Feedback Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.4k
Merge medio
1g 19h
PR unite (30g)
117

Descrizione

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:

  1. For a function where T doesn'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 introduces anys into the typechecking of the function's implementation, which don't need to be there. Instead, you can explicitly specify foo<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.
  2. For a function where T does appear in the output, like <T>(a: A<T>) => B<T> where A<T> and B<T> are both invariant, I am not aware of any workaround except casting. Using any leaks 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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia riproducendo l’esempio motivante nel TypeScript Playground collegato e leggi la discussione dell’issue sull’inferenza generica sulle union. Il lavoro è completato quando una funzione generica accetta A<1> | A<2>, risolve il generico separatamente per ogni membro e produce l’output union corrispondente senza richiedere any né un cast.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript
Ambito
compilers
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
30/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.