@depup/tanstack__react-router 1.168.2-depup.0 → 1.168.4-depup.0

package/dist/llms/rules/api.js

@@ -1337,6 +1337,7 @@ type RouterEvents = {
     toLocation: ParsedLocation
     pathChanged: boolean
     hrefChanged: boolean
+    hashChanged: boolean
   }
   onBeforeLoad: {
     type: 'onBeforeLoad'
@@ -1344,6 +1345,7 @@ type RouterEvents = {
     toLocation: ParsedLocation
     pathChanged: boolean
     hrefChanged: boolean
+    hashChanged: boolean
   }
   onLoad: {
     type: 'onLoad'
@@ -1351,6 +1353,7 @@ type RouterEvents = {
     toLocation: ParsedLocation
     pathChanged: boolean
     hrefChanged: boolean
+    hashChanged: boolean
   }
   onResolved: {
     type: 'onResolved'
@@ -1358,6 +1361,7 @@ type RouterEvents = {
     toLocation: ParsedLocation
     pathChanged: boolean
     hrefChanged: boolean
+    hashChanged: boolean
   }
   onBeforeRouteMount: {
     type: 'onBeforeRouteMount'
@@ -1365,6 +1369,7 @@ type RouterEvents = {
     toLocation: ParsedLocation
     pathChanged: boolean
     hrefChanged: boolean
+    hashChanged: boolean
   }
   onInjectedHtml: {
     type: 'onInjectedHtml'
@@ -1373,6 +1378,9 @@ type RouterEvents = {
     type: 'onRendered'
     fromLocation?: ParsedLocation
     toLocation: ParsedLocation
+    pathChanged: boolean
+    hrefChanged: boolean
+    hashChanged: boolean
   }
 }
 \`\`\`
@@ -1383,7 +1391,7 @@ Once an event is emitted, the following properties will be present on the event
 
 ### \`type\` property
 
-- Type: \`onBeforeNavigate | onBeforeLoad | onLoad | onBeforeRouteMount | onResolved\`
+- Type: \`onBeforeNavigate | onBeforeLoad | onLoad | onBeforeRouteMount | onResolved | onRendered | onInjectedHtml\`
 - The type of the event
 - This is useful for discriminating between events in a listener function.
 
@@ -1407,6 +1415,11 @@ Once an event is emitted, the following properties will be present on the event
 - Type: \`boolean\`
 - \`true\` if the href has changed between the \`fromLocation\` and \`toLocation\`.
 
+### \`hashChanged\` property
+
+- Type: \`boolean\`
+- \`true\` if the hash has changed between the \`fromLocation\` and \`toLocation\`.
+
 ## Example
 
 \`\`\`tsx
@@ -1902,10 +1915,11 @@ An instance of the \`Router\` has the following properties and methods:
 
 ### \`.subscribe\` method
 
-- Type: \`(eventType: TType, fn: ListenerFn<RouterEvents[TType]>) => (event: RouterEvent) => void\`
+- Type: \`(eventType: TType, fn: ListenerFn<RouterEvents[TType]>) => () => void\`
 - Subscribes to a [\`RouterEvent\`](./RouterEventsType.md).
 - Returns a function that can be used to unsubscribe from the event.
-- The callback provided to the returned function will be called with the event that was emitted.
+- The listener will be called with the event payload whenever that event is emitted.
+- See the [Router Events guide](../../guide/router-events.md) for lifecycle ordering and usage patterns.
 
 ### \`.matchRoutes\` method