UNPKG

@react-hookz/web

Version:

React hooks done right, for browser and SSR.

21 lines (20 loc) 911 B
/* eslint-disable @typescript-eslint/no-explicit-any */ import { useEffect } from 'react'; import { useThrottledCallback } from '..'; /** * Like `useEffect`, but passed function is throttled. * * @param callback Callback like for `useEffect`, but without ability to return * a cleanup function. * @param deps Dependencies list that will be passed to underlying `useEffect` * and `useThrottledCallback`. * @param delay Throttle delay. * @param noTrailing If `noTrailing` is true, callback will only execute every * `delay` milliseconds, otherwise, callback will be executed one final time * after the last throttled-function call. */ export function useThrottledEffect(callback, deps, delay, noTrailing) { if (noTrailing === void 0) { noTrailing = false; } // eslint-disable-next-line react-hooks/exhaustive-deps useEffect(useThrottledCallback(callback, deps, delay, noTrailing), deps); }