Back to React Router

useAsyncValue

docs/api/hooks/useAsyncValue.md

7.6.2945 B
Original Source

useAsyncValue

<!-- ⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ Thank you for helping improve our documentation! This file is auto-generated from the JSDoc comments in the source code, so please edit the JSDoc comments in the file below and this file will be re-generated once those changes are merged. https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/hooks.tsx -->

[MODES: framework, data]

Summary

Reference Documentation ↗

Returns the resolved promise value from the closest <Await>.

tsx
function SomeDescendant() {
  const value = useAsyncValue();
  // ...
}

// somewhere in your app
<Await resolve={somePromise}>
  <SomeDescendant />
</Await>;

Signature

tsx
function useAsyncValue(): unknown

Returns

The resolved value from the nearest Await component