@jungle-commerce/typesense-react/dist/hooks/useSearch.d.ts

React hooks and components for building search interfaces with Typesense

import { UseSearchReturn } from '../types';
/**
 * Options for configuring the useSearch hook
 */
export interface UseSearchOptions {
    /** Fields to search in (comma-separated) */
    queryBy?: string;
    /** Debounce delay for search queries in milliseconds */
    debounceMs?: number;
    /** Whether to search on mount */
    searchOnMount?: boolean;
    /** Maximum number of facet values to return */
    maxFacetValues?: number;
    /** Callback when search succeeds */
    onSearchSuccess?: (results: any) => void;
    /** Callback when search fails */
    onSearchError?: (error: Error) => void;
}
/**
 * Main hook for performing searches and managing search state
 * @param options - Configuration options
 * @returns Search state and actions
 */
export declare function useSearch(options?: UseSearchOptions): UseSearchReturn;
/**
 * Helper to check if a facet is disjunctive
 */
export declare function isDisjunctiveFacet(facetConfig: any): boolean;
/**
 * Helper to get total results count
 */
export declare function getTotalResults(state: any): number;
/**
 * Helper to get total pages
 */
export declare function getTotalPages(state: any): number;
/**
 * Helper to check if there's a next page
 */
export declare function hasNextPage(state: any): boolean;
/**
 * Helper to check if there's a previous page
 */
export declare function hasPreviousPage(state: any): boolean;
/**
 * Helper to get current results range
 */
export declare function getResultsRange(state: any): string;
//# sourceMappingURL=useSearch.d.ts.map