@tanstack/react-router 1.130.8 → 1.130.10

package/dist/llms/rules/api.js

@@ -447,6 +447,15 @@ The \`Redirect\` object accepts/contains the following properties:
 - Optional
 - The HTTP headers to use when redirecting.
 
+### Navigation Properties
+
+Since \`Redirect\` extends \`NavigateOptions\`, it also supports navigation properties:
+
+- **\`to\`**: Use for internal application routes (e.g., \`/dashboard\`, \`../profile\`)
+- **\`href\`**: Use for external URLs (e.g., \`https://example.com\`, \`https://authprovider.com\`)
+
+> **Important**: For external URLs, always use the \`href\` property instead of \`to\`. The \`to\` property is designed for internal navigation within your application.
+
 # Register type
 
 This type is used to register a route tree with a router instance. Doing so unlocks the full type safety of TanStack Router, including top-level exports from the \`@tanstack/react-router\` package.
@@ -2993,7 +3002,7 @@ The \`redirect\` function accepts a single argument, the \`options\` to determin
 import { redirect } from '@tanstack/react-router'
 
 const route = createRoute({
-  // throwing a redirect object
+  // throwing an internal redirect object using 'to' property
   loader: () => {
     if (!user) {
       throw redirect({
@@ -3001,6 +3010,14 @@ const route = createRoute({
       })
     }
   },
+  // throwing an external redirect object using 'href' property
+  loader: () => {
+    if (needsExternalAuth) {
+      throw redirect({
+        href: 'https://authprovider.com/login',
+      })
+    }
+  },
   // or forcing \`redirect\` to throw itself
   loader: () => {
     if (!user) {