Getting error after I put Async function in useEffect

32,187

Solution 1

You're returning the result of calling getResponse() from the useEffect function. If you return anything from useEffect, it has to be a function. Changing your code to this should fix it because you're no longer returning anything from the useEffect function.

useEffect(() => { 
  getResponse();
});

The useEffect Cleanup Function

If you return anything from the useEffect hook function, it must be a cleanup function. This function will run when the component unmounts. This can be thought of as roughly equivalent to the componentWillUnmount lifecycle method in class components.

useEffect(() => { 
  doSomething();

  return () => {
    console.log("This will be logged on unmount");
  }
});

Solution 2

An async function is really just syntax sugar for promises, so when you call an async function, it's returning a promise.

Instead, you can wrap your async function with an IIFE (Immediately-invoked Function Expression) like this, so nothing is returned to useEffect and used as a cleanup function:

useEffect(() => { 
  (async () => getResponse())();
});

Edit: or as @json pointed out in comment below. Just:

useEffect(() => { getResponse() });

Solution 3

The reason the simple code above is crashing your app is due to how the useEffect hook, async functions, and the shorthand arrow function syntax work.

One feature of the useEffect hook is a cleanup function. If you return anything from the useEffect hook function, it must be a cleanup function. This function will run when the component unmounts. This can be thought of as roughly equivalent to the componentWillUnmount lifecycle method in class components.

In JavaScript, functions marked with the async keyword enable the use of the await feature, which lets developers pause the execution of a function while waiting for an asynchronous task to finish. Async functions also always return a Promise; if the function doesn’t return one already, the return value is automatically wrapped in a Promise.

Finally, the shorthand arrow function syntax allows developers to omit the curly braces around the function body, which is useful for simple one-liners. The value of the function body automatically becomes the return value of the arrow function, removing the need of the return keyword. This functionality is called Implicit Return.

Now, how do these tidbits come together to cause such a cryptic error? Simply put, the value of getResponse, which is a Promise, becomes the return value of the arrow function in the useEffect hook. Remember that the useEffect hook expects a cleanup function to be returned? A Promise is not a function. so React stumbles and produces the error.

To fix your app, change the useEffect arrow function to add curly braces and remove the Implicit Return, as shown:

useEffect(() => { 
  getResponse();
});

Now, the arrow function in the useEffect hook returns undefined, which is acceptable and tells React that there is no cleanup function needed. This will solve the problem, but it would be great if React gave a more useful error message when this occurs!

Share:
32,187
Irakli Tchigladze
Author by

Irakli Tchigladze

Updated on December 27, 2021

Comments

  • Irakli Tchigladze
    Irakli Tchigladze almost 2 years

    In the useEffect function, if I just mention the getResults function variable, the app doesn't crash. But when I call it as I am doing in code below, I get these errors:

    react-dom.development.js:21857 Uncaught TypeError: destroy is not a function

    and

    Consider adding an error boundary to your tree to customize error handling behavior.

      function App() {
      const [foods, setFoods] = useState([]);
      const [isLoaded, setIsLoaded] = useState(false);
      useEffect(() => getResponse());
      const getResponse = async () => {
        const response = await fetch(sampleRequest);
        const data = await response.json();
        setFoods(data.hits);
      };
      let query = "Tomato";
      let sampleRequest = `https://api.edamam.com/search?q=${query}&app_id=${"1811484f"}&app_key=${"9cac93361efc99e2ebfbb8a453882af8"}`;
    
      return (
        <div className="App">
          <div className="main">
            <div className="navbars">
              {" "}
              <Navbars></Navbars>
            </div>
            <div className="listings">
              <Listing></Listing>
              <Listing></Listing>
              <Listing></Listing>
              <Listing></Listing>
              <Listing></Listing>
              <Listing></Listing>
              <Listing></Listing>
              <Listing></Listing>
              <Listing></Listing>
              <Listing></Listing>
            </div>
            <div className="footer">
              <h5>Made By YoYo Strangler in 2019</h5>
            </div>
          </div>
        </div>
      );
    }
    
    export default App;
    
  • Irakli Tchigladze
    Irakli Tchigladze about 4 years
    thank you so much. It worked. So, essentially, two brackets {} around it made the difference? Can you give me keywords or phrases, which i can google and read more about this?
  • Nick
    Nick about 4 years
    @IrakliTchigladze yeah, “implicit return” of arrow functions. Also look up how useEffect works and what’s returned from it. Glad it worked!
  • Jason Kohles
    Jason Kohles over 3 years
    It's worth noting that while this solution does work, the IIFE has nothing to do with it, the braces around it suppress the implicit return value and that's what makes it work.