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: Promise<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

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 })
  // ...
}