@empathyco/x-components
Version:
Empathy X Components
28 lines (19 loc) • 1.99 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [SearchActions](./x-components.searchactions.md)
## SearchActions interface
Search store actions.
**Signature:**
```typescript
export interface SearchActions
```
## Methods
| Method | Description |
| --- | --- |
| [cancelFetchAndSaveSearchResponse()](./x-components.searchactions.cancelfetchandsavesearchresponse.md) | Cancels / interrupt [SearchActions.fetchAndSaveSearchResponse()](./x-components.searchactions.fetchandsavesearchresponse.md) synchronous promise. |
| [fetchAndSaveSearchResponse(request)](./x-components.searchactions.fetchandsavesearchresponse.md) | Fetches a new search response and stores them in the module state. |
| [fetchSearchResponse(request)](./x-components.searchactions.fetchsearchresponse.md) | Fetches the search response and returns them. |
| [increasePageAppendingResults()](./x-components.searchactions.increasepageappendingresults.md) | Checks if there are more pages of results to load. If there are, then increases the page number in state and set to <code>true</code> the [SearchState.isAppendResults](./x-components.searchstate.isappendresults.md) flag. |
| [resetRequestOnRefinement(watchedRequest)](./x-components.searchactions.resetrequestonrefinement.md) | Batches state resets in a single action after [SearchGetters.request](./x-components.searchgetters.request.md) parameters update. |
| [saveOrigin(originInit)](./x-components.searchactions.saveorigin.md) | Creates a [QueryOrigin](./x-components.queryorigin.md) and saves it. |
| [saveSearchResponse(response)](./x-components.searchactions.savesearchresponse.md) | Saves the [SearchResponse](./x-types.searchresponse.md)<!-- -->. |
| [setUrlParams(urlParams)](./x-components.searchactions.seturlparams.md) | Checks if the url has params on it and then updates the state with these values. |