Skip to content

A React hook to run effect only if a component is mounted.

Notifications You must be signed in to change notification settings

felixgourdeau/use-mounted-effect

Repository files navigation

use-mounted-effect

npm bundle size npm

A React hook to run effect only if a component is mounted.

Installation

To add use-mounted-effect to your project, run:

yarn add use-mounted-effect

or

npm install use-mounted-effect

Purpose

When using an asynchronous effect, it can be a potential memory leak.

const [state, setState] = React.useState();

React.useEffect(() => {
  setInterval(() => setState(...), 10_000);
}, []);

If the component is unmounted before the setTimer callback is fired, the state will be updated on something that isn't existing anymore.

This hook will run your effect only if the component is mounted.

Usage

You can use useMountedEffect like you would use React.useEffect, but it provides you the following benefits:

  • You can pass an async callback
  • Your effect will be called with an isMounted() argument that it can use to check if the component is still mounted

Example

const [data, setData] = React.useState();

useMountedEffect(async (isMounted) => {
  const { data } = await fetch(url);

  if (!isMounted()) return;

  setState(data);
}, []);

About

A React hook to run effect only if a component is mounted.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published