import { EffectCallback, DependencyList, Comparator } from '../types'; /** * A replacement for React.useEffect that'll allow for custom and deep * compares of the dependency list. * @see {@link https://reactjs.org/docs/hooks-reference.html#useeffect} * @param callback Accepts a callback that's forwarded to React.useEffect * @param dependencies A dependency array similar to React.useEffect however it utilizes a deep compare * @param customCompare Opportunity to provide a custom compare function * @example * function ComponentExample() { * const [, forceUpdate] = useState(); * const obj = {a: 1}; * * useDeepEffect(() => { * console.log('useDeepEffect invocation'); * forceUpdate(obj); * }, [obj]); * * return null; * } */ export declare function useDeepEffect(callback: EffectCallback, dependencies: DependencyList, customCompare?: Comparator): void;