getAlgoliaResults
Retrieves Algolia results from one or multiple indices.
Example
import { getAlgoliaResults } from '@francoischalifour/autocomplete-preset-algolia';
import algoliasearch from 'algoliasearch/lite';
const searchClient = algoliasearch(APP_ID, SEARCH_API_KEY);
getAlgoliaResults({
searchClient,
queries: [
{
indexName: 'instant_search',
query,
params: {
hitsPerPage: 3,
},
},
],
}).then((results) => {
console.log(results);
});
Options
searchClient
SearchClient| required
queries
indexName
string| required
query
string| required
params
SearchParameters| required
Default search parameters:
{
"hitsPerPage": 5,
"highlightPreTag": "<mark>",
"highlightPostTag": "</mark>"
}
Returns
It returns a promise of the following schema:
{
"hits": [
{
"firstname": "Jimmie",
"lastname": "Barninger",
"objectID": "433",
"_highlightResult": {
"firstname": {
"value": "<em>Jimmie</em>",
"matchLevel": "partial"
},
"lastname": {
"value": "Barninger",
"matchLevel": "none"
},
"company": {
"value": "California <em>Paint</em> & Wlpaper Str",
"matchLevel": "partial"
}
}
}
],
"page": 0,
"nbHits": 1,
"nbPages": 1,
"hitsPerPage": 20,
"processingTimeMS": 1,
"query": "jimmie paint",
"params": "query=jimmie+paint&attributesToRetrieve=firstname,lastname&hitsPerPage=50"
}