@empathyco/x-components
Version:
Empathy X Components
27 lines (18 loc) • 2.34 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [NextQueriesActions](./x-components.nextqueriesactions.md)
## NextQueriesActions interface
Next queries module actions.
**Signature:**
```typescript
export interface NextQueriesActions
```
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [cancelFetchAndSaveNextQueries](./x-components.nextqueriesactions.cancelfetchandsavenextqueries.md) | | () => void | Cancels / interrupt [NextQueriesActions.fetchAndSaveNextQueries](./x-components.nextqueriesactions.fetchandsavenextqueries.md) synchronous promise. |
| [fetchAndSaveNextQueries](./x-components.nextqueriesactions.fetchandsavenextqueries.md) | | (request: NextQueriesRequest \| null) => void | Requests a new set of next queries and stores them in the module. |
| [fetchAndSaveNextQueryPreview](./x-components.nextqueriesactions.fetchandsavenextquerypreview.md) | | (payload: { query: string; location: [FeatureLocation](./x-components.featurelocation.md) \| undefined; }) => void | Requests the results to preview a next query and saves them in the state. |
| [fetchNextQueries](./x-components.nextqueriesactions.fetchnextqueries.md) | | (request: NextQueriesRequest \| null) => NextQuery\[\] \| null | Requests a new set of next queries for the module query, and returns them. |
| [fetchNextQueryPreview](./x-components.nextqueriesactions.fetchnextquerypreview.md) | | (payload: { query: string; location: [FeatureLocation](./x-components.featurelocation.md) \| undefined; }) => SearchResponse \| null | Requests the results to preview a next query, limited by [NextQueriesConfig.maxPreviewItemsToRequest](./x-components.nextqueriesconfig.maxpreviewitemstorequest.md)<!-- -->. |
| [setQueryFromLastHistoryQuery](./x-components.nextqueriesactions.setqueryfromlasthistoryquery.md) | | (historyQueries: HistoryQuery\[\]) => void | Sets the query of the module based on the last history query. |
| [setUrlParams](./x-components.nextqueriesactions.seturlparams.md) | | (urlParams: [UrlParams](./x-components.urlparams.md)<!-- -->) => void | Checks if the url has a query on it and then updates the state with that value. |