fetchAlgoliaResults.d.ts 788 B

1234567891011121314151617181920
  1. import { UserAgent } from '@algolia/autocomplete-shared';
  2. import { MultipleQueriesQuery, SearchForFacetValuesResponse, SearchResponse } from '@algolia/client-search';
  3. import type { SearchClient } from 'algoliasearch/lite';
  4. export interface SearchParams {
  5. /**
  6. * The initialized Algolia search client.
  7. */
  8. searchClient: SearchClient;
  9. /**
  10. * A list of queries to execute.
  11. */
  12. queries: MultipleQueriesQuery[];
  13. /**
  14. * A list of user agents to add to the search client.
  15. *
  16. * This is useful to track usage of an integration.
  17. */
  18. userAgents?: UserAgent[];
  19. }
  20. export declare function fetchAlgoliaResults<TRecord>({ searchClient, queries, userAgents, }: SearchParams): Promise<Array<SearchResponse<TRecord> | SearchForFacetValuesResponse>>;