import { useEffect, useState } from 'react'; import { getIndexSearchResults } from './getIndexSearchResults'; import { useIndexContext } from './useIndexContext'; import { useInstantSearchContext } from './useInstantSearchContext'; import type { SearchResults } from 'algoliasearch-helper'; import type { ScopedResult } from 'instantsearch.js'; export type SearchResultsApi = { results: SearchResults; scopedResults: ScopedResult[]; }; export function useSearchResults(): SearchResultsApi { const search = useInstantSearchContext(); const searchIndex = useIndexContext(); const [searchResults, setSearchResults] = useState(() => getIndexSearchResults(searchIndex) ); useEffect(() => { function handleRender() { const results = searchIndex.getResults(); // Results can be `null` when the first search is stalled. // In this case, we skip the update. // See: https://github.com/algolia/instantsearch.js/blob/20996c7a159988c58e00ff24d2d2dc98af8b980f/src/widgets/index/index.ts#L652-L657 if (results !== null) { setSearchResults({ results, scopedResults: searchIndex.getScopedResults(), }); } } search.addListener('render', handleRender); return () => { search.removeListener('render', handleRender); }; }, [search, searchIndex]); return searchResults; }