UNPKG

@empathyco/x-components

Version:
30 lines (18 loc) 1.06 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [NextQueriesActions](./x-components.nextqueriesactions.md) &gt; [fetchNextQueryPreview](./x-components.nextqueriesactions.fetchnextquerypreview.md) ## NextQueriesActions.fetchNextQueryPreview() method Requests the results to preview a next query, limited by [NextQueriesConfig.maxPreviewItemsToRequest](./x-components.nextqueriesconfig.maxpreviewitemstorequest.md)<!-- -->. **Signature:** ```typescript fetchNextQueryPreview(payload: { query: string; location: FeatureLocation | undefined; }): SearchResponse | null; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | | payload | { query: string; location: [FeatureLocation](./x-components.featurelocation.md) \| undefined; } | The payload object containing the query and its location. | **Returns:** SearchResponse \| null A search response based on the next query.