All files / hooks/use-mount/src useMount.ts

100% Statements 2/2
100% Branches 0/0
100% Functions 2/2
100% Lines 2/2

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28                                            5x 3x        
import { useEffect } from "react";
 
/**
 * Runs a callback exactly once, when the component mounts.
 *
 * A readable alias for `useEffect(fn, [])` that makes mount-only intent
 * explicit. The callback may return a cleanup function, which runs on unmount.
 *
 * Note: under React StrictMode in development, effects run twice on mount to
 * surface missing cleanup — this is expected.
 *
 * @param effect - Callback to run on mount; may return a cleanup function
 *
 * @example
 * ```tsx
 * useMount(() => {
 *   analytics.page();
 *   return () => cleanup();
 * });
 * ```
 */
export function useMount(effect: () => void | (() => void)): void {
  useEffect(() => {
    return effect();
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, []);
}