fix(router-core): type mismatch for navigate function (#4625)

According to the docs this should only return a promise
https://tanstack.com/router/latest/docs/framework/react/api/router/RouterType#navigate-method
Makes sense otherwise you cannot .then() it

---------

Co-authored-by: Nico Lynzaad <44094871+nlynzaad@users.noreply.github.com>

Author: mkarajohn

packages/react-router/src/link.tsx

@@ -276,7 +276,7 @@ export function useLinkProps<
 
       // All is well? Navigate!
       // N.B. we don't call `router.commitLocation(next) here because we want to run `validateSearch` before committing
-      return router.navigate({
+      router.navigate({
         ...options,
         from,
         replace,

packages/router-core/src/RouterProvider.ts

@@ -30,7 +30,7 @@ export type NavigateFn = <
   TMaskTo extends string = '',
 >(
   opts: NavigateOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo>,
-) => Promise<void> | void
+) => Promise<void>
 
 export type BuildLocationFn = <
   TRouter extends RegisteredRouter,

packages/router-core/src/router.ts

@@ -1755,7 +1755,7 @@ export class RouterCore<
       } else {
         window.location.href = href
       }
-      return
+      return Promise.resolve()
     }
 
     return this.buildAndCommitLocation({

packages/solid-router/src/link.tsx

@@ -286,7 +286,7 @@ export function useLinkProps<
 
       // All is well? Navigate!
       // N.B. we don't call `router.commitLocation(next) here because we want to run `validateSearch` before committing
-      return router.navigate({
+      router.navigate({
         ..._options(),
         replace: local.replace,
         resetScroll: local.resetScroll,