Function: useInstantSearch()

useInstantSearch(query): UseQueryResult<SearchResultsResponse, Error>

Defined in: web/lib/hooks/use-search.ts:133

Instant search hook for autocomplete and type-ahead suggestions.

Parameters

query

string

Search query string (minimum 2 characters)

Returns

UseQueryResult<SearchResultsResponse, Error>

Query result with limited search results for autocomplete

Remarks

Optimized for real-time search with shorter stale time and fewer results. Uses a separate cache key to avoid interfering with full search results.

Example

const [query, setQuery] = useState('');
const { data, isLoading } = useInstantSearch(query);

return (
  <SearchAutocomplete
    onChange={setQuery}
    suggestions={data?.hits ?? []}
    isLoading={isLoading}
  />
);

Throws

When the search API request fails