@tanstack/react-router 1.162.9 → 1.163.2

package/dist/llms/rules/api.js

@@ -1699,7 +1699,7 @@ When both \`basepath\` and \`rewrite\` are configured, they are automatically co
 - Type: \`boolean\`
 - Optional
 - Defaults to \`false\`
-- If \`true\`, route masks will, by default, be removed when the page is reloaded. This can be overridden on a per-mask basis by setting the \`unmaskOnReload\` option on the mask, or on a per-navigation basis by setting the \`unmaskOnReload\` option in the \`Navigate\` options.
+- If \`true\`, route masks will, by default, be removed when the page is reloaded. This can be overridden on a per-mask basis by setting \`unmaskOnReload\` on the mask, or on a per-navigation basis by setting \`mask.unmaskOnReload\` in [\`NavigateOptions\`](./NavigateOptionsType.md).
 
 ### \`Wrap\` property
 
@@ -1947,7 +1947,7 @@ Builds a new parsed location object that can be used later to navigate to a new
     - \`unmaskOnReload\`
       - Type: \`boolean\`
       - Optional
-      - If \`true\`, the route mask will be removed when the page is reloaded. This can be overridden on a per-navigation basis by setting the \`unmaskOnReload\` option in the \`Navigate\` options.
+      - If \`true\`, the route mask will be removed when the page is reloaded. This can be overridden on a per-navigation basis by setting \`mask.unmaskOnReload\` in [\`NavigateOptions\`](./NavigateOptionsType.md).
 
 ### \`.commitLocation\` method
 
@@ -2091,19 +2091,25 @@ Hydrates the router's critical state from a serializable object that was sent fr
 
 # ToMaskOptions type
 
-The \`ToMaskOptions\` type extends the [\`ToOptions\`](./ToOptionsType.md) type and describes additional options available when using route masks.
+The \`ToMaskOptions\` type includes the same destination fields as [\`ToOptions\`](./ToOptionsType.md), excluding \`mask\`, and adds options specific to route masking.
 
 \`\`\`tsx
-type ToMaskOptions = ToOptions & {
-  unmaskOnReload?: boolean
-}
+type ToMaskOptions = {
+  from?: ValidRoutePath | string
+  to?: ValidRoutePath | string
+  hash?: true | string | ((prev?: string) => string)
+  state?: true | HistoryState | ((prev: HistoryState) => HistoryState)
+} & SearchParamOptions &
+  PathParamOptions & {
+    unmaskOnReload?: boolean
+  }
 \`\`\`
 
 - [\`ToOptions\`](./ToOptionsType.md)
 
 # ToOptions type
 
-The \`ToOptions\` type contains several properties that can be used to describe a router destination.
+The \`ToOptions\` type contains several properties that can be used to describe a router destination, including \`mask\` for route masking.
 
 \`\`\`tsx
 type ToOptions = {
@@ -2112,7 +2118,8 @@ type ToOptions = {
   hash?: true | string | ((prev?: string) => string)
   state?: true | HistoryState | ((prev: HistoryState) => HistoryState)
 } & SearchParamOptions &
-  PathParamOptions
+  PathParamOptions &
+  MaskOptions
 
 type SearchParamOptions = {
   search?: true | TToSearch | ((prev: TFromSearch) => TToSearch)
@@ -2124,6 +2131,10 @@ type PathParamOptions = {
     | Record<string, TPathParam>
     | ((prev: TFromParams) => TToParams)
 }
+
+type MaskOptions = {
+  mask?: ToMaskOptions<TRouter, TMaskFrom, TMaskTo>
+}
 \`\`\`
 
 # UseMatchRouteOptions type