Route ID / Path / To

[farsil]

Our team stumbled upon a bit of confusion when it comes to what type definition to use for what, making very difficult to write type safe helpers. I've noticed that, with version 1.130.12:

• The routeTree.gen.ts exports three interfaces: FileRoutesByFullPath, FileRoutesById, FileRoutesByTo.
• The keys of FileRoutesByFullPath are the from option type in useNavigate.
• The keys of FileRoutesById are the from option type in useParams and useSearch.
• Finally, the keys of FileRoutesByTo are the to options type in the Link component and I assume the navigate function returned by useNavigate.

These observations may or may be not correct of course, they are based upon the inspection of the type definitions, which are not always clear given the complexity of the type inference mechanism of tanstack router.

Could you help us gain a better understanding of what each property means, and why it is used in a specific place? For example, why aren't IDs used everywhere, and instead we have to rely on three enumerations that are slightly different from one another?

[schiller-manuel]

you should not use any of those types directly as they are internal. what kind of typesafe helper do you want to write?

we have type utilities here: https://tanstack.com/router/latest/docs/framework/react/guide/type-utilities#type-checking-link-options-with-validatelinkoptions

[farsil]

The typesafe helper uses a from argument that is passed to both useSearch and useNavigate. Full code is lengthy, but here's a minimal example:

function useHelper(from: ???) {
  const navigate = useNavigate({ from });
  const search = useSearch({ from });
  ...
}

What type should from be in this case? Also, are there similar Validate* type utilities for useSearch and useParams?