@empathyco/x-components
Version:
Empathy X Components
117 lines (52 loc) • 1.48 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [RecommendationsState](./x-components.recommendationsstate.md)
## RecommendationsState interface
Recommendations store state.
**Signature:**
```typescript
export interface RecommendationsState extends StatusState
```
**Extends:** [StatusState](./x-components.statusstate.md)
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[config](./x-components.recommendationsstate.config.md)
</td><td>
</td><td>
[RecommendationsConfig](./x-components.recommendationsconfig.md)
</td><td>
Configuration for the `Recommendations` module.
</td></tr>
<tr><td>
[origin](./x-components.recommendationsstate.origin.md)
</td><td>
</td><td>
string
</td><td>
Param to be sent on the recommendations request.
</td></tr>
<tr><td>
[params](./x-components.recommendationsstate.params.md)
</td><td>
</td><td>
Dictionary<unknown>
</td><td>
The extra params property of the state.
</td></tr>
<tr><td>
[recommendations](./x-components.recommendationsstate.recommendations.md)
</td><td>
</td><td>
Result\[\]
</td><td>
The recommendations of the module.
</td></tr>
</tbody></table>