microsoft / microsoft/TypeScript

Show incompatible union members in discriminated union discriminator errors

Abierto
#62,737 3 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Experimentation Needed Help Wanted Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.3k
Merge medio
2 d 4 h
PR fusionados (30 d)
132

Descripción

🔍 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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con el ejemplo motivador de una unión discriminada y compara el diagnóstico actual con el propuesto. Sigue la ruta del comprobador de tipos para la asignabilidad y los errores del discriminador de las uniones discriminadas; después, verifica que el comportamiento implementado identifique miembros incompatibles de la unión de origen, como "baz", sin cambiar la salida en tiempo de ejecución.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
typescript
Área
compilers
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Tranquilo
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.