Generated type FileRoutesByFullPath doesn't match runtime type #3780
Send to my agentWhich project does this relate to?#
Router
Describe the bug#
Problem#
router.routesByPath is defined as RoutesByPath<TRouteTree> which includes trailing '/' for index routes. However this does not match the runtime type which removes trailing slashes.
Description#
Given the following structure:
foo/
└── bar/
├── index.tsx
├── route.tsx
└── __root.tsx
generates:
export interface FileRoutesByFullPath {
'/bar': typeof fooBarRouteRouteWithChildren
'/bar/': typeof fooBarIndexRoute
}
but in:
if (!childRoute.isRoot && childRoute.path) {
const trimmedFullPath = trimPathRight(childRoute.fullPath)
if (
!(this.routesByPath as any)[trimmedFullPath] ||
childRoute.fullPath.endsWith('/')
) {
;(this.routesByPath as any)[trimmedFullPath] = childRoute
}
}
we can see that the trimmed path is the key that is used for the object at runtime.
Your Example Website or App#
https://stackblitz.com/edit/tanstack-router-nychtyxe
Steps to Reproduce the Bug or Issue#
- Create a router project with an index route matching above structure
- Observe that Types does not match runtime types
Expected behavior#
The typing for the property should match the runtime type i.e. without slashes
Screenshots or Videos#
Platform#
All
Additional context#
The included link goes to a StackBlitz where you can quickly see the problem in action by comparing the interface and the actual runtime types.
same as #3005 ?
Not quite the same, almost the inverse. Probably fixed in the same area though.
This issue seems still relevant
const parentFullPath = useParentMatches({ select: (matches) => { const lastMatch = matches.pop() const fullPath = lastMatch?.fullPath // https://github.com/TanStack/router/issues/3780 return (fullPath as RemoveTrailingSlashes<typeof fullPath>) || PATH_ROOT } }) return ( <RouterLink to={parentFullPath} {...props}> {children} </RouterLink> )Still relevant. This is my current workaround.
import { useRouter, type RegisteredRouter } from "@tanstack/react-router"; type FileRoutesByFullPath = RegisteredRouter["routesByPath"]; type RouteFullPathWithSlash = keyof FileRoutesByFullPath; type TrimSlash<T extends string> = T extends `${infer P}/` ? P : T; /** * Type-safe wrapper around `routesByPath` that handles the mismatch between * the generated types (which include trailing slashes for index routes) and * the runtime object (which trims them). * * @see https://github.com/TanStack/router/issues/3780 */ function useRoutePath<T extends RouteFullPathWithSlash>(path: T): TrimSlash<T> { const { routesByPath } = useRouter(); // The generated FileRoutesByFullPath type includes trailing slashes for index // routes, but routesByPath trims them at runtime — so we trim before lookup. const trimmed = path.replace(/\/$/, "") as T; return routesByPath[trimmed].fullPath as TrimSlash<T>; } export { useRoutePath };closing this as neither those types nor the router properties are public API.
Sign in to join this conversation.
same as https://github.com/TanStack/router/issues/3005 ?