import { FuzzyOptions, FuzzyResponse } from '../vanilla/types.mjs';

type useFuzzyOptions<T, U = T> = {
    /**
     * List of items to search against
     */
    list: T[];
    /**
     * The query to search for. This is the string that will be searched for in the items.
     * @default ""
     * @example "foo"
     */
    query: string;
} & FuzzyOptions<T, U>;
/**
 * Hook for fuzzy searching `list` against `query` and mapping the results with `mapResult`.
 *
 * If `query` is blank, `list` is returned in whole.
 *
 * See `createFuzzySearch` for more details. This hook simply wraps it (with memoization) in a React hook.
 *
 * For best performance, `getKey` and `mapResult` functions should be memoized by the user.
 */
declare function useFuzzy<T, U = T>({ list, query, ...options }: useFuzzyOptions<T, U>): FuzzyResponse<U>;

export { useFuzzy, type useFuzzyOptions };