@utilityjs/use-is-mounted
Version:
A React hook that returns `true` if the component is mounted.
50 lines (35 loc) • 1.41 kB
Markdown
<div align="center">
<h1 align="center">
useIsMounted
</h1>
</div>
<div align="center">
A React hook that returns `true` if the component is mounted.
[](https://github.com/mimshins/utilityjs/blob/main/LICENSE)
[](https://www.npmjs.com/package/@utilityjs/use-is-mounted)
[](https://www.npmjs.com/package/@utilityjs/use-is-mounted)
[](https://www.npmjs.com/package/@utilityjs/use-is-mounted)
```bash
npm i @utilityjs/use-is-mounted | yarn add @utilityjs/use-is-mounted
```
</div>
<hr>
## Usage
```ts
import useGetLatest from "@utilityjs/use-get-latest";
import useIsMounted from "@utilityjs/use-is-mounted";
import * as React from "react";
const useHook = (callback: () => void) => {
const isMounted = useIsMounted();
const getLatestCallback = useGetLatest(callback);
React.useEffect(() => {
const cb = getLatestCallback();
if (isMounted()) cb();
}, []);
};
```
## API
### `useIsMounted()`
```ts
declare const useIsMounted: () => (() => boolean);
```