Usage

Search…
Usage
React Async offers three primary APIs: the useAsync hook, the <Async> component and the createInstance factory function. Each has its unique benefits and downsides.
As a hook
The useAsync hook (available from React v16.8.0) offers direct access to React Async's core functionality from within your own function components:
1
import { useAsync } from "react-async"
2
​
3
// You can use async/await or any function that returns a Promise
4
const loadPlayer = async ({ playerId }, { signal }) => {
5
  const res = await fetch(`/api/players/${playerId}`, { signal })
6
  if (!res.ok) throw new Error(res.statusText)
7
  return res.json()
8
}
9
​
10
const MyComponent = () => {
11
  const { data, error, isPending } = useAsync({ promiseFn: loadPlayer, playerId: 1 })
12
  if (isPending) return "Loading..."
13
  if (error) return `Something went wrong: ${error.message}`
14
  if (data)
15
    return (
16
      <div>
17
        <strong>Player data:</strong>
18
        <pre>{JSON.stringify(data, null, 2)}</pre>
19
      </div>
20
    )
21
  return null
22
}
Copied!
Using helper components can greatly improve readability of your render functions by not having to write all those conditional returns.
Or using the shorthand version:
1
const MyComponent = () => {
2
  const { data, error, isPending } = useAsync(loadPlayer, options)
3
  // ...
4
}
Copied!
With useFetch
Because fetch is so commonly used with useAsync, there's a dedicated useFetch hook for it:
1
import { useFetch } from "react-async"
2
​
3
const MyComponent = () => {
4
  const headers = { Accept: "application/json" }
5
  const { data, error, isPending, run } = useFetch("/api/example", { headers }, options)
6
  // This will setup a promiseFn with a fetch request and JSON deserialization.
7
​
8
  // you can later call `run` with an optional callback argument to
9
  // last-minute modify the `init` parameter that is passed to `fetch`
10
  function clickHandler() {
11
    run(init => ({
12
      ...init,
13
      headers: {
14
        ...init.headers,
15
        authentication: "...",
16
      },
17
    }))
18
  }
19
​
20
  // alternatively, you can also just use an object that will be spread over `init`.
21
  // please note that this is not deep-merged, so you might override properties present in the
22
  // original `init` parameter
23
  function clickHandler2() {
24
    run({ body: JSON.stringify(formValues) })
25
  }
26
}
Copied!
useFetch takes the same arguments as fetch itself, as well as options to the underlying useAsync hook. The options object takes two special boolean properties: defer and json. These can be used to switch between deferFn and promiseFn, and enable JSON parsing. By default useFetch automatically uses promiseFn or deferFn based on the request method (deferFn for POST / PUT / PATCH / DELETE) and handles JSON parsing if the Accept header is set to "application/json".
As a component
The classic interface to React Async. Simply use <Async> directly in your JSX component tree, leveraging the render props pattern:
1
import Async from "react-async"
2
​
3
// Your promiseFn receives all props from Async and an AbortController instance
4
const loadPlayer = async ({ playerId }, { signal }) => {
5
  const res = await fetch(`/api/players/${playerId}`, { signal })
6
  if (!res.ok) throw new Error(res.statusText)
7
  return res.json()
8
}
9
​
10
const MyComponent = () => (
11
  <Async promiseFn={loadPlayer} playerId={1}>
12
    {({ data, error, isPending }) => {
13
      if (isPending) return "Loading..."
14
      if (error) return `Something went wrong: ${error.message}`
15
      if (data)
16
        return (
17
          <div>
18
            <strong>Player data:</strong>
19
            <pre>{JSON.stringify(data, null, 2)}</pre>
20
          </div>
21
        )
22
      return null
23
    }}
24
  </Async>
25
)
Copied!
Using helper components can greatly improve readability of your render functions by not having to write all those conditional returns.
As a factory
You can also create your own component instances, allowing you to preconfigure them with options such as default onResolve and onReject callbacks.
1
import { createInstance } from "react-async"
2
​
3
const loadPlayer = async ({ playerId }, { signal }) => {
4
  const res = await fetch(`/api/players/${playerId}`, { signal })
5
  if (!res.ok) throw new Error(res.statusText)
6
  return res.json()
7
}
8
​
9
// createInstance takes a defaultOptions object and a displayName (both optional)
10
const AsyncPlayer = createInstance({ promiseFn: loadPlayer }, "AsyncPlayer")
11
​
12
const MyComponent = () => (
13
  <AsyncPlayer playerId={1}>
14
    <AsyncPlayer.Fulfilled>{player => `Hello ${player.name}`}</AsyncPlayer.Fulfilled>
15
  </AsyncPlayer>
16
)
Copied!
With helper components
Several helper components are available to improve legibility. They can be used with useAsync by passing in the state, or with <Async> by using Context. Each of these components simply enables or disables rendering of its children based on the current state.
1
import { useAsync, IfPending, IfFulfilled, IfRejected } from "react-async"
2
​
3
const loadPlayer = async ({ playerId }, { signal }) => {
4
  // ...
5
}
6
​
7
const MyComponent = () => {
8
  const state = useAsync({ promiseFn: loadPlayer, playerId: 1 })
9
  return (
10
    <>
11
      <IfPending state={state}>Loading...</IfPending>
12
      <IfRejected state={state}>{error => `Something went wrong: ${error.message}`}</IfRejected>
13
      <IfFulfilled state={state}>
14
        {data => (
15
          <div>
16
            <strong>Player data:</strong>
17
            <pre>{JSON.stringify(data, null, 2)}</pre>
18
          </div>
19
        )}
20
      </IfFulfilled>
21
    </>
22
  )
23
}
Copied!
As compounds to <Async>
Each of the helper components are also available as static properties of <Async>. In this case you won't have to pass the state object, instead it will be automatically provided through Context.
1
import Async from "react-async"
2
​
3
const loadPlayer = async ({ playerId }, { signal }) => {
4
  const res = await fetch(`/api/players/${playerId}`, { signal })
5
  if (!res.ok) throw new Error(res.statusText)
6
  return res.json()
7
}
8
​
9
const MyComponent = () => (
10
  <Async promiseFn={loadPlayer} playerId={1}>
11
    <Async.Pending>Loading...</Async.Pending>
12
    <Async.Fulfilled>
13
      {data => (
14
        <div>
15
          <strong>Player data:</strong>
16
          <pre>{JSON.stringify(data, null, 2)}</pre>
17
        </div>
18
      )}
19
    </Async.Fulfilled>
20
    <Async.Rejected>{error => `Something went wrong: ${error.message}`}</Async.Rejected>
21
  </Async>
22
)
Copied!
Getting started - Previous
Upgrading
Next - Getting started
DevTools
Last modified 2yr ago
Copy link
Contents
With helper components
As compounds to <Async>
As a hook

With `useFetch`

As a component

As a factory

With helper components

As compounds to `<Async>`
