damilola jerugba for Brimble

Posted on Dec 27, 2021 • Originally published at damiisdandy.com

Custom React useFetch() hook for data fetching with revalidation

#react #javascript #tutorial #typescript

This guide is to show you how to create a simple react hook for data fetching (with revalidation).

🤨 Why this hook?

When fetching data for your react applications, you'd usually use both useState and useEffect, with values like loading, data and error e.g This example, this hook is to help abstract that functionality into one simple hook that can be used anywhere and multiple times.

🕺 Setting up the project

We would be using the create-react-app boiler template for typescript and the only external library we would be using is axios for data fetching.

Open up your terminal and type in the following commands.

yarn create react-app use-fetch --template typescript
# for npm
npx create-react-app use-fetch --template typescript

Change into the directory and install axios

cd use-fetch
yarn add axios
# for npm
npm install axios

Within the src directory delete the following file (because they aren't needed)

App.css
App.test.tsx

🎣 Custom `useFetch` hook

Within the src directory create another directory called hooks, this is where our hook will reside.

cd src
mkdir hooks

Your file structure should look something like this.

Within the hooks directory create a file called useFetch.tsx.

Type in the following inside the useFetch file.

import { useState, useEffect, useCallback } from "react";
import axios from "axios";

interface UseFetchProps {
  url: string;
}

const useFetch = ({ url }: UseFetchProps) => {
  const [data, setData] = useState<any>();
  const [error, setError] = useState(false);

  // function to fetch data
  const fetch = useCallback(async () => {
    setError(false);
    try {
      const fetchedData = await axios.get(url);
      setData(fetchedData.data);
    } catch {
      setError(true);
    }
  }, [url]);

  useEffect(() => {
    // on first load fetch data
    fetch();
  }, [fetch]);

  return {
    data,
    error,
    revalidate: fetch,
  };
};

export default useFetch;

The hook takes in a prop url, which is the API url at which we want to fetch data from. It has two states data and error which are used to store data gotten from the API and check for errors respectively.

We created a separate function for fetching the data called fetch and wrapped it within a useCallback hook, Visit here to see the reason why we used a useCallback hook.

Then we simply used a useEffect hook to run the fetch function as soon as the hook is mounted 🙂.

The hook returns data, error and revalidate which is the fetch function for when we want to programmatically revalidate the data.

😎 Using the hook

To use the hook we simply just import it and extract its values.
Within the App.tsx

import useFetch from "./hooks/useFetch";
import logo from "./logo.svg";

function App() {
  const { error, data, revalidate } = useFetch({
    url: "https://random-data-api.com/api/users/random_user?size=5",
  });

  if (!data) {
    return <h2>Loading...</h2>;
  }

  if (error) {
    return <h2>Error fetching users</h2>;
  }

  return (
    <div className="App">
      <img src={logo} alt="react logo" />
      <h1 className="title">useFetch()</h1>
      <button onClick={revalidate}>revalidate</button>
      <div className="items">
        {data.map((el: any) => (
          <div className="item" key={el.uid}>
            <img
              src={`https://avatars.dicebear.com/api/big-smile/${el.first_name}.svg`}
              alt={`${el.username} profile`}
              className="item__img"
            />
            <div className="item__info">
              <p className="name">
                {el.first_name} {el.last_name}{" "}
                <span className="username">(@{el.username})</span>
              </p>
              <p className="job">{el.employment.title}</p>
              <p
                className={`status ${
                  el.subscription.status.toLowerCase() === "active"
                    ? "success"
                    : el.subscription.status.toLowerCase() === "blocked"
                    ? "danger"
                    : "warn"
                }`}
              >
                {el.subscription.status}
              </p>
            </div>
          </div>
        ))}
      </div>
    </div>
  );
}

export default App;

⏰ Adding Interval revalidation

You might need to fetch data from your API every 5 seconds for revalidation (ensuring your data is up-to-date).

We need to add some modifications to our useFetch hook. Lets and more props.

interface UseFetchProps {
  url: string;
  revalidate?: boolean;
  interval?: number;
}

revalidate will be a boolean to check if we want to implement interval revalidation or not, interval will be the time taken between every revalidation (in seconds).

...
const useFetch = ({ url, revalidate, interval }: UseFetchProps) => {
...

We'll create a state called revalidateKey that we will change on every interval which will be added to our useEffect dependency array. Adding this to our dependency array will ensure that the function within our useEffect will run everytime the revalidateKey changes.

To change the revalidateKey, we will create a new useEffect that has a setInterval.

...
const [revalidateKey, setRevalidateKey] = useState("");
...
useEffect(() => {
    const revalidateInterval = setInterval(() => {
      if (revalidate) {
        setRevalidateKey(Math.random().toString());
      }
      // if no interval is given, use 3 seconds
    }, (interval ? interval : 3) * 1000);
    return () => clearInterval(revalidateInterval);
  }, [interval, revalidate]);

Our useFetch hook should then look something like this.

const useFetch = ({ url, revalidate, interval }: UseFetchProps) => {
  const [revalidateKey, setRevalidateKey] = useState("");
  const [data, setData] = useState<any>();
  const [error, setError] = useState(false);

  // function to fetch data
  const fetch = useCallback(async () => {
    setError(false);
    try {
      const fetchedData = await axios.get(url);
      setData(fetchedData.data);
    } catch {
      setError(true);
    }
  }, [url]);

  useEffect(() => {
    const revalidateInterval = setInterval(() => {
      if (revalidate) {
        setRevalidateKey(Math.random().toString());
      }
      // if no interval is given, use 3 seconds
    }, (interval ? interval : 3) * 1000);
    return () => clearInterval(revalidateInterval);
  }, [interval, revalidate]);

  useEffect(() => {
    // on first load fetch data and when revalidateKey changes
    fetch();
  }, [fetch, revalidateKey]);

  return {
    data,
    error,
    revalidate: fetch,
  };
};

Using the useFetch hook ✨

const { error, data, revalidate } = useFetch({
    url: "https://random-data-api.com/api/users/random_user?size=5",
    revalidate: false,
    // fetch every 5 seconds
    interval: 5,
  });

⚠️ Graphql support

This hook uses only the GET method, and Graphql uses POST method for data fetching. To make the hook more dynamic you can add more props like isGraphql and query, isGraphql will be a boolean to check if its Graphql or REST so you can have a condition in your hook to use axios.post() instead of axios.get() and query for the graphql query.

Thank you for reading 🙏🏾, If you have any questions, additions, or subtractions please comment below.

The full source code is linked below 👇👇

brimblehq / use-fetch

data fetching hook with revalidation

Top comments (14)

ZaheerAlii • Jan 3 '22

Cool Work, But I'm agree with one of the user that could you add some cancel request.

Imran Murtaza • Jan 4

"Thank you for your feedback! That's a great suggestion, and I'll definitely consider adding a 'cancel request' feature in future updates. It's always helpful to know what users find most useful. Stay tuned for improvements!"

José María CL • Dec 28 '21

Nice! Working with graphql I saw a hook called useQuery which returns loading, data, error and refetch.

So, after some attempts to decouple the gql or rest implementation we've created a hook very similar to your useFetch which returns the four variables like the useQuery.

I think that the loading flag could be useful for this hook too. You know, we can infer it if the data has a value but the loading will help you to know if there is a "fetching" task in progress

damilola jerugba Brimble • Dec 28 '21

Yeah, I kept thinking whether I should add a loading value or not, I initially did but I removed it, You can contribute to the repo.

David Lorenz • Dec 27 '21

Isn' that what SWR does? Why not go with Standards?

damilola jerugba Brimble • Dec 27 '21

It’s always fun to build and know how things work

David Lorenz • Dec 27 '21

I agree. But for production it's mostly better to go with the standards 🤗

Aleks • Dec 27 '21

From quick look of example code, it will show loading state for infinite time, if your api call fails.

damilola jerugba Brimble • Dec 27 '21 • Edited

It sets error to true, which displays

if (error) {
    return <h2>Error fetching users</h2>;
  }

Kyle Scheuerlein • Dec 28 '21

Are you sure? It looks like data would be falsy (if the fetch errors out!) and so your second if block can never run.

damilola jerugba Brimble • Dec 28 '21 • Edited

git clone the repo and look for yourself, if this is really an issue please add an issue to the repo or try to contribute to it 💜

damilola jerugba Brimble • Dec 28 '21

Thank you

apisit Amunayworrabut • Dec 29 '21

Can u add cancel request when components is unmount

damilola jerugba Brimble • Dec 29 '21

Hmmm, Could you add it as a GitHub issue

View full discussion (14 comments)