feat: make typed useRoute(currentRouteName)
return children route types as well
#2475
+176
−36
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In an app (with a typed router) where route
/a/b
is a child of route/a
, this makesuseRoute('/a')
returnRouteLocationNormalizedLoadedTyped<RouteNamedMap, "/a"> | RouteLocationNormalizedLoadedTyped<RouteNamedMap, "/a/b">
.It works in a recursive manner, so whenever route
/a/b/c
is added as a child of/a/b
,useRoute('/a')
will returnRouteLocationNormalizedLoadedTyped<RouteNamedMap, "/a"> | RouteLocationNormalizedLoadedTyped<RouteNamedMap, "/a/b">
| RouteLocationNormalizedLoadedTyped<RouteNamedMap, "/a/b/c">`.Of course
useRoute('/a/b/c')
will only returnRouteLocationNormalizedLoadedTyped<RouteNamedMap, "/a/b/c">
.Note
This PR is intended to be paired with the following
unplugin-vue-router
PR: posva/unplugin-vue-router#602That PR changes the DTS generation to include
RouteMeta
and a union of the children route's names as generics to everyRouteRecordInfo
type.