ValidateNavigateOptions doesn't seem to work

[C-Higgins]

I'm not sure what is going wrong here.

const a: ValidateNavigateOptions = {
  to: "/images/$id",
  params: { id: "1" }, // Object literal may only specify known properties, and id does not exist in type ...
};

const navigate = useNavigate();
navigate({
  to: "/images/$id",
  params: { id: "1" }, // works 
});

I have also tried passing generic parameters to the type. Is this supposed to work, or am I using the type utility incorrectly?

[schiller-manuel]

you need linkOptions for this

https://tanstack.com/router/latest/docs/framework/react/guide/link-options

[schiller-manuel]

at which function boundary? did you have a look at the docs? https://tanstack.com/router/latest/docs/framework/react/guide/type-utilities#type-checking-navigate-options-with-validatenavigateoptions

[C-Higgins]

For example if I have a function that takes correctly typed link options as a parameter, or returns them, how can I type that? I see the docs for how to make a typesafe custom link, but this doesn't appear to work with plain functions. I cannot pass a linkOptions response into a ValidateLinkOptions parameter, as shown above. I can pass it to a LinkOptions parameter, but then it's not validated.

[schiller-manuel]

cc @chorobin

[chorobin]

ValidateX type utilities are only intended for inference sites as the docs say. They are to help build your own functions and components which rely on inference for type checking. This means you need at least a function or class with a TOptions and TRouter type parameter. Generally all TSR api's rely on inference and thats because we need inference for resolving search params, params and relative navigation.

I am not sure how else to improve the docs here to help. To me it feels clear but because its quite advanced, it might need to be improved.

[C-Higgins]

It is odd to me that there is not a "valid navigation object" type. I just want to write a function which accepts valid navigation options for my registered router. I expected that NavigationOptions or ValidateNavigationOptions was that type. If linkOptions can validate the options without passing any generics, as can the Link component, why can there not be an exported type that my function uses as the parameter type which also validates the options?