More complete types for RouterPush and abstact implementation into createRouterPush
#59
Conversation
src/types/routeMethods.ts
Outdated
There was a problem hiding this comment.
Unrelated but when I was testing some things to help with the recursive types I added this and felt it was worth keeping.
| name: TRoute, | ||
| params?: TRoute extends keyof Flattened<TRoutes> ? Flattened<TRoutes>[TRoute] : Record<never, never>, | ||
| } | ||
| type RoutePushConfigParams< |
There was a problem hiding this comment.
This type just makes sure the params property is not required if there are no required params.
src/types/routes.ts
Outdated
There was a problem hiding this comment.
Unrelated but noticed this didn't get updated when I added query to the route types.
There was a problem hiding this comment.
Updated createRouteMethods to accept an object rather than multiple arguments after I wrote createRouterPush that way and thought it felt good. So this is the same functionally.
| function replace(url: string, options: RouterReplaceOptions = {}): Promise<void> { | ||
| return push(url, { ...options, replace: true }) |
There was a problem hiding this comment.
Updated replace to just call router.push. That way theres only one implementation of what "replace" means.
src/utilities/createRouterPush.ts
Outdated
| import { component } from '@/utilities/testHelpers' | ||
| import { assembleUrl } from '@/utilities/urlAssembly' | ||
|
|
||
| type DummyRoutes = [{ name: string, path: '/', component: typeof component }] |
There was a problem hiding this comment.
Curious what you think of this. I'm using this below in the push implementation on line 16 so that typescript knows the correct types for the arguments and return types. I cannot use just RouterPush<[]> because an empty array produces no type for the overload and then it says string is the only type for urlOrRouteConfig.
There was a problem hiding this comment.
we can't use Route? Is this intended to be a temporary fix?
There was a problem hiding this comment.
Cannot use Route or Routes because they both have generics that cause the infinite depth errors. But something fixed that is more narrow works just fine.
Not intended to be temporary. Its gross. And open to other suggestions. But this is the most type safe I could make this.
There was a problem hiding this comment.
that makes sense. The things I really don't like about it is the name and the fact that it uses component from our utilities/testHelpers.
What if we changed the type to
type AnyRoute = [{ name: string, path: string, component: RouteComponent }]There was a problem hiding this comment.
Yep that totally work. Good suggestion
Description
Updates the types for
RouterPushto be a little more accurate. Was hoping to remove the need for anas anybut still had that same issue increateRouterPush. But at least now its consistent withcreateRouteMethods.