fix: correct typing for Route.useNavigate (#1940)

TanStack · Jul 24, 2024 · b212862 · b212862
1 parent 789c466
commit b212862
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 5 deletions.
diff --git a/packages/react-router/src/route.ts b/packages/react-router/src/route.ts
@@ -890,7 +890,7 @@ export class Route<
     return useLoaderData({ ...opts, from: this.id } as any)
   }
 
-  useNavigate = (): UseNavigateResult<string> => {
+  useNavigate = (): UseNavigateResult<TFullPath> => {
     return useNavigate({ from: this.id })
   }
 }

diff --git a/...ct-router/tests/createRouteApi.test-d.tsx → ...es/react-router/tests/routeApi.test-d.tsx b/...ct-router/tests/createRouteApi.test-d.tsx → ...es/react-router/tests/routeApi.test-d.tsx
@@ -36,17 +36,31 @@ const defaultRouter = createRouter({
 
 type DefaultRouter = typeof defaultRouter
 
-describe('createRouteApi', () => {
+type ExtractDefaultFrom<T> =
+  T extends UseNavigateResult<infer DefaultFrom> ? DefaultFrom : never
+
+describe('getRouteApi', () => {
   const invoiceRouteApi = getRouteApi<'/invoices/$invoiceId', DefaultRouter>(
     '/invoices/$invoiceId',
   )
   describe('useNavigate', () => {
     test('has a static `from`', () => {
       const navigate = invoiceRouteApi.useNavigate()
+      navigate
+      expectTypeOf<
+        ExtractDefaultFrom<typeof navigate>
+      >().toEqualTypeOf<'/invoices/$invoiceId'>()
+    })
+  })
+})
 
-      expectTypeOf(navigate).toEqualTypeOf<
-        UseNavigateResult<'/invoices/$invoiceId'>
-      >()
+describe('createRoute', () => {
+  describe('useNavigate', () => {
+    test('has a static `from`', () => {
+      const navigate = invoiceRoute.useNavigate()
+      expectTypeOf<
+        ExtractDefaultFrom<typeof navigate>
+      >().toEqualTypeOf<'/invoices/$invoiceId'>()
     })
   })
 })