mirror of
https://github.com/TanStack/router.git
synced 2026-11-18 19:34:24 +00:00
both router and react 19 were modifying the Promise object in a similar manner which caused a conflict. See https://github.com/facebook/react/blob/v19.0.0/packages/react-reconciler/src/ReactFiberThenable.js#L162-L228 for how React 19 modifies the Promise object. Both used an additional `status` property to track the Promise status, but router was using the value "success" and React was using the value "fulfilled" to mark a fulfilled Promise. This change stores the router specific Promise tracking values using a symbol to avoid any potential collision. fixes #2953
1.3 KiB
1.3 KiB
| id | title |
|---|---|
| deferFunction | defer function |
Caution
You don't need to call
defermanually anymore, Promises are handled automatically now.
The defer function wraps a promise with a deferred state object that can be used to inspect the promise's state. This deferred promise can then be passed to the useAwaited hook or the <Await> component for suspending until the promise is resolved or rejected.
The defer function accepts a single argument, the promise to wrap with a deferred state object.
defer options
- Type:
Promise<T> - Required
- The promise to wrap with a deferred state object.
defer returns
- A promise that can be passed to the
useAwaitedhook or the<Await>component.
Examples
import { defer } from '@tanstack/react-router'
const route = createRoute({
loader: () => {
const deferredPromise = defer(fetch('/api/data'))
return { deferredPromise }
},
component: MyComponent,
})
function MyComponent() {
const { deferredPromise } = Route.useLoaderData()
const data = useAwaited({ promise: deferredPromise })
// or
return (
<Await promise={deferredPromise}>
{(data) => <div>{JSON.stringify(data)}</div>}
</Await>
)
}