UNPKG

@empathyco/x-components

Version:
193 lines (84 loc) 3.12 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueriesPreviewMutations](./x-components.queriespreviewmutations.md) ## QueriesPreviewMutations interface QueriesPreview store mutations. **Signature:** ```typescript export interface QueriesPreviewMutations extends ConfigMutations<QueriesPreviewState> ``` **Extends:** [ConfigMutations](./x-components.configmutations.md)<!-- -->&lt;[QueriesPreviewState](./x-components.queriespreviewstate.md)<!-- -->&gt; ## 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) =&gt; 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) =&gt; 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; }) =&gt; 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&lt;unknown&gt;) =&gt; 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)<!-- -->) =&gt; 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) =&gt; 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)<!-- -->) =&gt; 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; }) =&gt; void </td><td> Updates a result with new fields. </td></tr> </tbody></table>