microsoft / microsoft/TypeScript
Discriminated union with an optional discriminator is not being resolved as expected
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.3k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 117
Descripción
🔎 Search Terms
discriminated union, discriminated union with an optional discriminator, type inference in objects
🕗 Version & Regression Information
I have a simple piece of code (see the playground/below)
The runtime flow is very simple: whatever gets returned by the loader func gets passed as data to the handle's crumbBuilder method. If the loader is absent then data will also be absent
But when it comes to typing those behaviors then 2 issues arise:
- At first, the discriminated union is not being resolved properly: in the second case it should be a string but TS cannot infer it and defaults to
any - At second, we still have to explicitly annotate or assert the
datatype, however from theloaderdefinition it is possible to infer its return type. Is there a syntax way to say 'the type of data is the whatever awaited type the loader function returns?. I have tried to achieve that behaviour using generics and thesatisifies` keyword but failed to
⏯ Playground Link
💻 Code
type PathSegment = object[];
type Handle<TData> = {
crumbBuilder: (data: TData) => PathSegment[];
}
type Loader<TData> = (args: { params: Record<string, string> }) => Promise<TData>;
type RouteHandler<TData = any> =
| {
handle: Handle<never>;
loader?: never;
}
| {
handle: Handle<TData>;
loader: Loader<TData>
};
const routeHandlerWithoutLoader = {
handle: {
crumbBuilder: (data) => [], //data is correctly inferred as never
}
} satisfies RouteHandler
const routeHandler = {
loader: async (args) => {
return args.params.userId;
},
handle: {
crumbBuilder: (data) => [] //data is not inferred as string
}
} satisfies RouteHandler<string>
🙁 Actual behavior
data is not inferred as string
🙂 Expected behavior
-
data should be inferred as a string
-
there is no need to explicitly annotate or assert the
datatype , and it must be inferred from the loader return type
Additional information about the issue
No response
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con el ejemplo vinculado de TypeScript Playground y las definiciones de RouteHandler, Handle y Loader del issue. Reproduce ambos casos y, después, investiga cómo maneja el checker el discriminante opcional y si los tipos de retorno del loader pueden propagarse a handle. Se considera terminado cuando, en los casos indicados, data se infiere como never sin un loader y como string con el loader, sin una anotación explícita.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- compilers
- Tipo de issue
- Error
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 25/100