@empathyco/x-components
Version:
Empathy X Components
24 lines (15 loc) • 1.49 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [RelatedPromptsActions](./x-components.relatedpromptsactions.md)
## RelatedPromptsActions interface
Related prompts module actions.
**Signature:**
```typescript
export interface RelatedPromptsActions
```
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [cancelFetchAndSaveRelatedPrompts](./x-components.relatedpromptsactions.cancelfetchandsaverelatedprompts.md) | | () => void | Cancels / interrupt [RelatedPromptsActions.fetchAndSaveRelatedPrompts](./x-components.relatedpromptsactions.fetchandsaverelatedprompts.md) synchronous promise. |
| [fetchAndSaveRelatedPrompts](./x-components.relatedpromptsactions.fetchandsaverelatedprompts.md) | | (request: RelatedPromptsRequest \| null) => void | Requests a new set of related prompts and stores them in the module. |
| [fetchRelatedPrompts](./x-components.relatedpromptsactions.fetchrelatedprompts.md) | | (request: RelatedPromptsRequest \| null) => RelatedPrompt\[\] \| null | Requests a new set of related prompts for the module query, and returns them. |
| [setUrlParams](./x-components.relatedpromptsactions.seturlparams.md) | | (urlParams: [UrlParams](./x-components.urlparams.md)<!-- -->) => void | Checks if the URL has params on it and then updates the state with these values. |