react-use/docs/useUnmountPromise.md
2019-12-08 00:54:58 +01:00

31 lines
617 B
Markdown

# `useUnmountPromise`
A life-cycle hook that provides a higher order promise that does not resolve if component un-mounts.
## Usage
```ts
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
```ts
const mounted = useUnmountPromise();
mounted(promise);
mounted(promise, onError);
```
- `onError` — if promise rejects after the component is unmounted, `onError`
callback is called with the error.