react-code-dataset / react-use /docs /useUnmountPromise.md
Devendra174's picture
Upload folder using huggingface_hub
1e92f2d verified

useUnmountPromise

A life-cycle hook that provides a higher order promise that does not resolve if component un-mounts.

Usage

import useUnmountPromise from 'react-use/lib/useUnmountPromise';

const Demo = () => {
  const mounted = useUnmountPromise();
  useEffect(async () => {
    await mounted(someFunction()); // Will not resolve if component un-mounts.
  });
};

Reference

const mounted = useUnmountPromise();

mounted(promise);
mounted(promise, onError);
  • onError — if promise rejects after the component is unmounted, onError callback is called with the error.