microsoft / microsoft/TypeScript

Show incompatible union members in discriminated union discriminator errors

Aperta
#62,737 3 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Experimentation Needed Help Wanted Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
2g 4h
PR unite (30g)
132

Descrizione

🔍 Search Terms

discriminated union error message, union type assignability error, misleading error message, discriminator property, wider union error, union literal type error, type narrowing error message

✅ Viability Checklist
⭐ Suggestion

Improve error messages when assigning objects with wider discriminator unions to discriminated union types. Currently, TypeScript reports the compatible literal as incompatible, rather than identifying the actual problematic values in the wider union that prevent assignment.

📃 Motivating Example

Consider this code [Playground Link]:

 type Discriminated =
    | { discriminator: "foo" }
    | { discriminator: "bar" };

  type UnionType = "foo" | "bar" | "baz";

  const obj = { discriminator: "foo" as UnionType };

  // Error: Type '{ discriminator: UnionType; }' is not assignable to type 'Discriminated'.
  //   Type '{ discriminator: UnionType; }' is not assignable to type '{ discriminator: "bar"; barValue: number; }'.
  //     Types of property 'discriminator' are incompatible.
  //       Type 'UnionType' is not assignable to type '"bar"'.
  //         Type '"foo"' is not assignable to type '"bar"'.
  const err: Discriminated = obj;

Current error message: Type '"foo"' is not assignable to type '"bar"'

Problem: This error is misleading. "foo" is compatible with the discriminated union. The real issue is that "baz" (present in UnionType) is
not compatible with any variant of Discriminated.

Better error message (proposed):
Type 'UnionType' is not assignable to the discriminator type '"foo" | "bar"'.
Type(s) '"baz"' from the source union are not assignable to the target.

This directly identifies "baz" as the problematic value, making it immediately clear what needs to be fixed.

💻 Use Cases
  1. What do you want to use this for?

When working with discriminated unions in large codebases, developers frequently encounter situations where:

  • API responses have wider string union types than the application's internal types
  • Type narrowing is attempted from generic to specific discriminated unions
  • Configuration objects use string unions that need to match discriminated union variants

Better error messages would significantly reduce debugging time by directly identifying incompatible discriminator values instead of
misleading developers toward compatible ones.

  1. What shortcomings exist with current approaches?

The current error message:

  • Points to a compatible literal type as the source of error
  • Requires developers to manually compare all members of both unions to identify the actual problem
  • Creates confusion, especially for TypeScript learners
  • Makes the error difficult to search for and understand in complex type hierarchies
  1. What workarounds are you using in the meantime?

Current workarounds include:

  • Manually extracting and comparing union members using type utilities
  • Adding explicit type assertions with as to silence the error (unsafe)
  • Creating intermediate types with explicit exclusions: Exclude<UnionType, "baz">
  • Trial-and-error removal of union members until the error clears

All of these approaches are suboptimal compared to a clear, actionable error message.


Note: This suggestion stems from issue https://github.com/microsoft/TypeScript/issues/62603

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 con l’esempio motivante di una discriminated union e confronta la diagnostica attuale con quella proposta. Segui quindi il percorso del type checker per l’assegnabilità e gli errori del discriminatore delle discriminated union, poi verifica che il comportamento implementato identifichi i membri incompatibili della source union, come "baz", senza modificare l’output a runtime.

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

Valutazione

Stack tecnologico
typescript
Ambito
compilers
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.