@anb98/react-hooks/dist/useSearch.d.ts

Custom hooks for react

import * as React from 'react';
export declare type Properties<T> = Array<keyof T>;
export declare type Props<T> = {
    allowFields: Properties<T>;
    denyFields: Properties<T>;
    sourceData: T[];
};
/**
 * This hook filters results when searching.
 * @param props Initial options
 * @example
 * ```
const { setSourceData, setSearchValue, filtered, sourceData }
= useSearch({ allowFields: [], denyFields: [] sourceData: [] });
 * ```
 * @see https://www.npmjs.com/package/@anb98/react-hooks#useSearch
 */
declare const useSearch: <T>(props?: Partial<Props<T>>) => {
    filtered: T[];
    setSearchValue: React.Dispatch<React.SetStateAction<string>>;
    setSourceData: React.Dispatch<React.SetStateAction<T[]>>;
    sourceData: T[];
};
export default useSearch;