@depup/tanstack__react-router 1.166.8-depup.0 → 1.167.0-depup.0

package/dist/llms/rules/api.js

@@ -979,7 +979,7 @@ type beforeLoad = (
 - Type:
 
 \`\`\`tsx
-type loader = (
+type loaderFn = (
   opts: RouteMatch & {
     abortController: AbortController
     cause: 'preload' | 'enter' | 'stay'
@@ -993,6 +993,13 @@ type loader = (
     route: AnyRoute
   },
 ) => Promise<TLoaderData> | TLoaderData | void
+
+type loader =
+  | loaderFn
+  | {
+      handler: loaderFn
+      staleReloadMode?: 'background' | 'blocking'
+    }
 \`\`\`
 
 - Optional
@@ -1001,6 +1008,9 @@ type loader = (
 - If this function returns a promise, the route will be put into a pending state and cause rendering to suspend until the promise resolves. If this route's pendingMs threshold is reached, the \`pendingComponent\` will be shown until it resolves. If the promise rejects, the route will be put into an error state and the error will be thrown during render.
 - If this function returns a \`TLoaderData\` object, that object will be stored on the route match until the route match is no longer active. It can be accessed using the \`useLoaderData\` hook in any component that is a child of the route match before another \`<Outlet />\` is rendered.
 - Deps must be returned by your \`loaderDeps\` function in order to appear.
+- Use the object form to configure loader-specific behavior like \`staleReloadMode\`.
+- \`staleReloadMode: 'background'\` preserves stale-while-revalidate behavior for stale successful matches.
+- \`staleReloadMode: 'blocking'\` waits for the stale loader reload to complete before continuing.
 
 > 🚧 \`opts.navigate\` has been deprecated and will be removed in the next major release. Use \`throw redirect({ to: '/somewhere' })\` instead. Read more about the \`redirect\` function [here](./redirectFunction.md).
 
@@ -1518,6 +1528,15 @@ The \`RouterOptions\` type accepts an object with the following properties and m
 - Defaults to \`0\`
 - The default \`staleTime\` a route should use if no staleTime is provided.
 
+### \`defaultStaleReloadMode\` property
+
+- Type: \`'background' | 'blocking'\`
+- Optional
+- Defaults to \`'background'\`
+- Controls how stale successful loader data is revalidated by default.
+- \`'background'\` preserves stale-while-revalidate behavior.
+- \`'blocking'\` waits for the stale loader reload to finish before navigation resolves.
+
 ### \`defaultPreloadStaleTime\` property
 
 - Type: \`number\`