UNPKG

@empathyco/x-components

Version:
116 lines (51 loc) 1.81 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QuerySuggestionsActions](./x-components.querysuggestionsactions.md) ## QuerySuggestionsActions interface QuerySuggestions store actions. **Signature:** ```typescript export interface QuerySuggestionsActions ``` ## Properties <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td> [cancelFetchAndSaveSuggestions](./x-components.querysuggestionsactions.cancelfetchandsavesuggestions.md) </td><td> </td><td> () =&gt; void </td><td> Cancels / interrupt [QuerySuggestionsActions.fetchAndSaveSuggestions](./x-components.querysuggestionsactions.fetchandsavesuggestions.md) synchronous promise. </td></tr> <tr><td> [fetchAndSaveSuggestions](./x-components.querysuggestionsactions.fetchandsavesuggestions.md) </td><td> </td><td> (request: QuerySuggestionsRequest \| null) =&gt; void </td><td> Requests and saves to the state a list of suggestions. </td></tr> <tr><td> [fetchSuggestions](./x-components.querysuggestionsactions.fetchsuggestions.md) </td><td> </td><td> (request: QuerySuggestionsRequest \| null) =&gt; Suggestion\[\] </td><td> Requests and returns a list of suggestions based on the module state. </td></tr> <tr><td> [setUrlParams](./x-components.querysuggestionsactions.seturlparams.md) </td><td> </td><td> (urlParams: [UrlParams](./x-components.urlparams.md)<!-- -->) =&gt; void </td><td> Checks if the url has a query on it and then updates the state with that value. </td></tr> </tbody></table>