@empathyco/x-components
Version:
Empathy X Components
45 lines (36 loc) • 3.94 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [SearchMutations](./x-components.searchmutations.md)
## SearchMutations interface
Search store mutations.
**Signature:**
```typescript
export interface SearchMutations extends StatusMutations, QueryMutations, ConfigMutations<SearchState>
```
**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, [QueryMutations](./x-components.querymutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- --><[SearchState](./x-components.searchstate.md)<!-- -->>
## Methods
| Method | Description |
| --- | --- |
| [appendResults(results)](./x-components.searchmutations.appendresults.md) | Append the results to the results state. |
| [resetState()](./x-components.searchmutations.resetstate.md) | Resets the "resettable" part of the Search state to the initial state. See the for details. |
| [resetStateForReload()](./x-components.searchmutations.resetstateforreload.md) | Resets the "resettable" part of the Search state like [SearchMutations.resetState()](./x-components.searchmutations.resetstate.md) but maintains the values required to perform the search request again. |
| [setBanners(banners)](./x-components.searchmutations.setbanners.md) | Sets the banners of the module. |
| [setDisplayTagging(DisplayTagging)](./x-components.searchmutations.setdisplaytagging.md) | Sets the display tagging of the module. |
| [setFacets(facets)](./x-components.searchmutations.setfacets.md) | Sets the facets of the module. |
| [setFromNoResultsWithFilters(fromNoResultsWithFilters)](./x-components.searchmutations.setfromnoresultswithfilters.md) | Sets the <code>fromNoResultsWithFilters</code> flag value. |
| [setIsAppendResults(isAppendResults)](./x-components.searchmutations.setisappendresults.md) | Set the <code>isAppendResuls</code> flag value. |
| [setIsNoResults(isNoResults)](./x-components.searchmutations.setisnoresults.md) | Sets the <code>isNoResults</code> flag value. |
| [setOrigin(origin)](./x-components.searchmutations.setorigin.md) | Sets the origin of the module. |
| [setPage(page)](./x-components.searchmutations.setpage.md) | Sets the page of the module. |
| [setParams(params)](./x-components.searchmutations.setparams.md) | Sets the extra params of the module. |
| [setPartialResults(partialResults)](./x-components.searchmutations.setpartialresults.md) | Sets the partial results of the module. |
| [setPromoteds(promoteds)](./x-components.searchmutations.setpromoteds.md) | Sets the promoteds of the module. |
| [setQueryTagging(queryTagging)](./x-components.searchmutations.setquerytagging.md) | Sets the query tagging of the module, which is used to track the query. |
| [setRedirections(redirections)](./x-components.searchmutations.setredirections.md) | Sets the redirection of the module. |
| [setRelatedTags(relatedTags)](./x-components.searchmutations.setrelatedtags.md) | Sets the related tags of the module. |
| [setResults(results)](./x-components.searchmutations.setresults.md) | Sets the results of the module. |
| [setSelectedFilters(selectedFilters)](./x-components.searchmutations.setselectedfilters.md) | Sets the selected filters of the module. |
| [setSort(sort)](./x-components.searchmutations.setsort.md) | Sets the selected sort option of the module. |
| [setSpellcheck(spellcheckedQuery)](./x-components.searchmutations.setspellcheck.md) | Sets the spellcheckedQuery of the module. |
| [setStats(stats)](./x-components.searchmutations.setstats.md) | Sets the stats of the module. |
| [setTotalResults(totalResults)](./x-components.searchmutations.settotalresults.md) | Sets the total results of the module. |
| [updateResult(result)](./x-components.searchmutations.updateresult.md) | Updates a result with new fields. |