import { __LEGIT_ANY__ } from "@ls-stack/utils/saferTyping";

//#region src/useOnChange.d.ts
/** Function that compares two values for equality */
type EqualityFn = (a: __LEGIT_ANY__, b: __LEGIT_ANY__) => boolean;
/** Function returned from callbacks to clean up side effects */
type CleanupFn = () => void;
/** Options for configuring onChange behavior */
type OnChangeOptions = {
  /** Custom equality function for value comparison. Defaults to deepEqual */
  equalityFn?: EqualityFn;
  /** Whether to call the callback on component mount. Defaults to false */
  callOnMount?: boolean;
};
/**
 * A replacement for useEffect that doesn't need a dependency array.
 * Automatically triggers the callback when the value changes based on deep equality comparison.
 * By default, the callback is not called on mount (use `callOnMount` option to change this).
 *
 * @param value - The value to watch for changes
 * @param callBack - Function called when value changes, receives prev and current values
 * @param options - Configuration options
 * @param options.equalityFn - Custom equality function for comparison (defaults to deepEqual)
 * @param options.callOnMount - Whether to call callback on mount (defaults to false)
 *
 * @example
 * ```tsx
 * const [count, setCount] = useState(0);
 *
 * useOnChange(count, ({ prev, current }) => {
 *   console.log(`Count changed from ${prev} to ${current}`);
 * });
 * ```
 */
declare function useOnChange<T>(value: T, callBack: (values: {
  prev: T | undefined;
  current: T;
}) => void | CleanupFn, {
  equalityFn: areEqual,
  callOnMount
}?: OnChangeOptions): void;
/**
 * Layout effect version of useOnChange that runs synchronously before DOM updates.
 * Similar to useOnChange but uses useLayoutEffect instead of useEffect for timing-sensitive updates.
 *
 * @param value - The value to watch for changes
 * @param callBack - Function called when value changes, receives prev and current values
 * @param options - Configuration options
 * @param options.equalityFn - Custom equality function for comparison (defaults to deepEqual)
 * @param options.callOnMount - Whether to call callback on mount (defaults to false)
 */
declare function useOnChangeLayoutEffect<T>(value: T, callBack: (values: {
  prev: T | undefined;
  current: T;
}) => void | CleanupFn, {
  equalityFn: areEqual,
  callOnMount
}?: Omit<OnChangeOptions, 'layoutEffect'>): void;
/**
 * Triggers callback only when value changes to a specific target value.
 * Useful for watching for specific state transitions or reaching particular values.
 *
 * @param value - The value to watch for changes
 * @param target - The specific target value to watch for
 * @param callBack - Function called when value changes to target, receives prev and target values
 * @param options - Configuration options
 * @param options.equalityFn - Custom equality function for comparison (defaults to deepEqual)
 * @param options.callOnMount - Whether to call callback on mount (defaults to false)
 *
 * @example
 * ```tsx
 * const [status, setStatus] = useState('idle');
 *
 * useOnChangeTo(status, 'loading', ({ prev, target }) => {
 *   console.log(`Status changed from ${prev} to loading`);
 * });
 * ```
 */
declare function useOnChangeTo<T, U extends T>(value: T, target: U, callBack: (values: {
  prev: T | undefined;
  target: U;
}) => void | CleanupFn, {
  equalityFn: areEqual,
  callOnMount
}?: OnChangeOptions): void;
/**
 * Layout effect version of useOnChangeTo that runs synchronously before DOM updates.
 * Combines specific target value watching with useLayoutEffect timing for synchronous execution.
 *
 * @param value - The value to watch for changes
 * @param target - The specific target value to watch for
 * @param callBack - Function called when value changes to target, receives prev and target values
 * @param options - Configuration options
 * @param options.equalityFn - Custom equality function for comparison (defaults to deepEqual)
 * @param options.callOnMount - Whether to call callback on mount (defaults to false)
 */
declare function useOnChangeToLayoutEffect<T, U extends T>(value: T, target: U, callBack: (values: {
  prev: T | undefined;
  target: U;
}) => void | CleanupFn, {
  equalityFn: areEqual,
  callOnMount
}?: OnChangeOptions): void;
//#endregion
export { useOnChange, useOnChangeLayoutEffect, useOnChangeTo, useOnChangeToLayoutEffect };