@empathyco/x-components
Version:
Empathy X Components
193 lines (84 loc) • 3.12 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [QueriesPreviewMutations](./x-components.queriespreviewmutations.md)
## QueriesPreviewMutations interface
QueriesPreview store mutations.
**Signature:**
```typescript
export interface QueriesPreviewMutations extends ConfigMutations<QueriesPreviewState>
```
**Extends:** [ConfigMutations](./x-components.configmutations.md)<!-- --><[QueriesPreviewState](./x-components.queriespreviewstate.md)<!-- -->>
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[addQueryPreviewInstance](./x-components.queriespreviewmutations.addquerypreviewinstance.md)
</td><td>
</td><td>
(queryPreviewHash: string) => void
</td><td>
Increases in 1 the instance counter.
</td></tr>
<tr><td>
[clearQueryPreview](./x-components.queriespreviewmutations.clearquerypreview.md)
</td><td>
</td><td>
(queryPreviewHash: string) => void
</td><td>
Removes a query preview entry from the queries preview's dictionary.
</td></tr>
<tr><td>
[removeQueryPreviewInstance](./x-components.queriespreviewmutations.removequerypreviewinstance.md)
</td><td>
</td><td>
({ queryPreviewHash, cache, }: { queryPreviewHash: string; cache: boolean; }) => void
</td><td>
Decreases in 1 the instance counter and removes the query preview if the counter is 0 and cache is false.
</td></tr>
<tr><td>
[setParams](./x-components.queriespreviewmutations.setparams.md)
</td><td>
</td><td>
(params: Dictionary<unknown>) => void
</td><td>
Sets the extra params of the module.
</td></tr>
<tr><td>
[setQueryPreviewCached](./x-components.queriespreviewmutations.setquerypreviewcached.md)
</td><td>
</td><td>
(queryPreview: [QueryPreviewItem](./x-components.querypreviewitem.md)<!-- -->) => void
</td><td>
Adds a new entry to the cached queries preview's dictionary.
</td></tr>
<tr><td>
[setSelectedQueryPreview](./x-components.queriespreviewmutations.setselectedquerypreview.md)
</td><td>
</td><td>
(selectedQueryPreview: [QueryPreviewInfo](./x-components.querypreviewinfo.md) \| null) => void
</td><td>
Sets the selected query preview of the module.
</td></tr>
<tr><td>
[setStatus](./x-components.queriespreviewmutations.setstatus.md)
</td><td>
</td><td>
(payload: [QueryPreviewStatusPayload](./x-components.querypreviewstatuspayload.md)<!-- -->) => void
</td><td>
Sets the status of a query preview request.
</td></tr>
<tr><td>
[updateAQueryPreviewResult](./x-components.queriespreviewmutations.updateaquerypreviewresult.md)
</td><td>
</td><td>
({ result, queryPreviewHash, }: { result: Result; queryPreviewHash: string; }) => void
</td><td>
Updates a result with new fields.
</td></tr>
</tbody></table>