algoliasearch-lite.d.ts 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. import { ClientTransporterOptions } from '@algolia/client-common';
  2. import { FindAnswersOptions } from '@algolia/client-search';
  3. import { FindAnswersResponse } from '@algolia/client-search';
  4. import { MultipleQueriesOptions } from '@algolia/client-search';
  5. import { MultipleQueriesQuery } from '@algolia/client-search';
  6. import { MultipleQueriesResponse } from '@algolia/client-search';
  7. import { Request } from '@algolia/transporter';
  8. import { RequestOptions } from '@algolia/transporter';
  9. import { SearchClient as SearchClient_2 } from '@algolia/client-search';
  10. import { SearchClientOptions } from '@algolia/client-search';
  11. import { SearchForFacetValuesQueryParams } from '@algolia/client-search';
  12. import { SearchForFacetValuesResponse } from '@algolia/client-search';
  13. import { SearchIndex as SearchIndex_2 } from '@algolia/client-search';
  14. import { SearchOptions } from '@algolia/client-search';
  15. import { SearchResponse } from '@algolia/client-search';
  16. declare function algoliasearch(appId: string, apiKey: string, options?: AlgoliaSearchOptions): SearchClient;
  17. declare namespace algoliasearch {
  18. var version: string;
  19. }
  20. export default algoliasearch;
  21. export declare type AlgoliaSearchOptions = Partial<ClientTransporterOptions> & WithoutCredentials<SearchClientOptions>;
  22. declare type Credentials = {
  23. readonly appId: string;
  24. readonly apiKey: string;
  25. };
  26. export declare type SearchClient = SearchClient_2 & {
  27. readonly initIndex: (indexName: string) => SearchIndex;
  28. readonly search: <TObject>(queries: readonly MultipleQueriesQuery[], requestOptions?: RequestOptions & MultipleQueriesOptions) => Readonly<Promise<MultipleQueriesResponse<TObject>>>;
  29. readonly searchForFacetValues: (queries: ReadonlyArray<{
  30. readonly indexName: string;
  31. readonly params: SearchForFacetValuesQueryParams & SearchOptions;
  32. }>, requestOptions?: RequestOptions) => Readonly<Promise<readonly SearchForFacetValuesResponse[]>>;
  33. readonly customRequest: <TResponse>(request: Request, requestOptions?: RequestOptions) => Readonly<Promise<TResponse>>;
  34. };
  35. export declare type SearchIndex = SearchIndex_2 & {
  36. readonly search: <TObject>(query: string, requestOptions?: RequestOptions & SearchOptions) => Readonly<Promise<SearchResponse<TObject>>>;
  37. readonly searchForFacetValues: (facetName: string, facetQuery: string, requestOptions?: RequestOptions & SearchOptions) => Readonly<Promise<SearchForFacetValuesResponse>>;
  38. readonly findAnswers: <TObject>(query: string, queryLanguages: readonly string[], requestOptions?: RequestOptions & FindAnswersOptions) => Readonly<Promise<FindAnswersResponse<TObject>>>;
  39. };
  40. export declare type WithoutCredentials<TClientOptions extends Credentials> = Omit<TClientOptions, keyof Credentials>;
  41. export { }