What does it mean to 'move this variable directly inside useEffect' in this error message?

Sam Schantz picture Sam Schantz · May 15, 2019 · Viewed 19.4k times · Source

I am attempting to pass an object through props to a child component. The value is set in the useEffect hook and lost when passed to my child component.

I have tried setting the value of the object outside the useEffect hook in a separate function but the value is still lost.

import React, { useState, useEffect } from 'react';

function SetValue(props){

    let users = {};

    useEffect(() => {
          users = { user: 'bob' };
    })        

    return <NewComponent users={users} />
}

export default SetValue;

I expected props.users to be { user: 'bob' } and not an empty object {}.

The error message is:

"Assignments to the 'users' variable from inside React Hook useEffect will be lost after each render. To preserve the value over time, store it in a useRef Hook and keep the mutable value in the '.current' property. Otherwise, you can move this variable directly inside useEffect react-hooks/exhaustive-deps"

Answer

Andrii Golubenko picture Andrii Golubenko · May 15, 2019

About useEffect hook:

By using this Hook, you tell React that your component needs to do something after render. React will remember the function you passed (we’ll refer to it as our “effect”), and call it later after performing the DOM updates. more

This means that function inside useEffect will be called after rendering of the component. That's why you have an empty object.

About the error. You have it because React doesn't remember your users variable - it will be recreated on each render of SetValue component. It will be better to use useState hook to set value in useEffect and remember it on the next render.

And one more note. Don't forget about passing the second argument in useEffect with an array of dependencies. Now your hook will be called after each render of SetValue component.

Here's how to use useState hook:

import React, { useState, useEffect } from 'react';

function SetValue(props){

    const [users, setUsers] = useState({});

    useEffect(() => {
          setUsers({ user: 'bob' });
    }, [
       //here you could pass dependencies, or leave it empty to call this effect only on first render
    ]);        

    return <NewComponent users={users} />
}

export default SetValue;