mirror of
https://github.com/TanStack/router.git
synced 2026-11-16 19:38:07 +00:00
1.2 KiB
1.2 KiB
| id | title |
|---|---|
| deferFunction | defer function |
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
DeferredPromise<T>that can be passed to theuseAwaitedhook 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>
)
}