react-qif
Version:
Powerful filtering system for React.js applications
17 lines (16 loc) • 651 B
TypeScript
import { Values, UseQueryStatesKeysMap } from 'nuqs';
import { FiltersValue } from './types';
interface UseFiltersOptions<T extends FiltersValue> {
syncWithSearchParams?: boolean;
parsers: UseQueryStatesKeysMap<T>;
}
export declare function useFilters<T extends FiltersValue>(options: UseFiltersOptions<T>): {
reset: () => void;
filters: T | Values<UseQueryStatesKeysMap<T>>;
setValue: <K extends keyof T>(name: K, value: T[K]) => void;
getValue: <K extends keyof T>(name: K) => T[K] | null;
unregister: (name: keyof T) => void;
isResetDisabled: boolean;
setFilters: (newFilters: Partial<T>) => void;
};
export {};