useAwaited hook
The useAwaited method is a hook that suspends until the provided promise is resolved or rejected.
useAwaited options
The useAwaited hook accepts a single argument, an options object.
options.promise option
- Type: DeferredPromise<T>
- Required
- The deferred promise to await.
useAwaited returns
- Throws an error if the promise is rejected.
- Suspends (throws a promise) if the promise is pending.
- Returns the resolved value of a deferred promise if the promise is resolved.
Examples
tsx
import { useAwaited } from '@tanstack/react-router'
function Component() {
const { deferredPromise } = route.useLoaderData()
const data = useAwaited({ promise: myDeferredPromise })
// ...
}
import { useAwaited } from '@tanstack/react-router'
function Component() {
const { deferredPromise } = route.useLoaderData()
const data = useAwaited({ promise: myDeferredPromise })
// ...
}
'%3e%3c/path%3e%3c/svg%3e)
'%3e%3c/path%3e%3c/svg%3e)
Subscribe to Bytes
Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.