Open
Description
openedon May 12, 2024
🔎 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
data
type, however from theloader
definition 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 the
satisifies` 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
data
type , and it must be inferred from the loader return type
Additional information about the issue
No response
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment