import { DebounceOptions } from "@ls-stack/utils/debounce";

//#region src/useDebouncedValue.d.ts

/**
 * Hook that debounces a reactive value, returning a delayed version that only
 * updates after the specified delay has passed without changes.
 *
 * Pass `0` as `debounceMs` to disable debouncing entirely, which makes the
 * hook act as a passthrough (the returned value always matches the input).
 * This is useful for conditionally disabling debouncing without changing the
 * call site.
 *
 * @example
 *   ```tsx
 *   function SearchResults({ query }: { query: string }) {
 *     const [debouncedQuery, flush, isPending] = useDebouncedValue(query, 300);
 *
 *     // debouncedQuery updates 300ms after the last query change
 *     return isPending ? <Spinner /> : <Results query={debouncedQuery} />;
 *   }
 *   ```;
 *
 * @param value - The value to debounce
 * @param debounceMs - The debounce delay in milliseconds. Use `0` to disable
 *   debouncing and pass the value through immediately.
 * @param options - Debounce options (leading, trailing, maxWait)
 * @returns Tuple of [debouncedValue, flush, isPending]
 */
declare function useDebouncedValue<T>(value: T, debounceMs: number, options?: DebounceOptions): readonly [debouncedValue: T, flush: () => void, isPending: boolean];
//#endregion
export { useDebouncedValue };