@empathyco/x-components
Version:
Empathy X Components
30 lines (21 loc) • 1.84 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-types](./x-types.md) > [Result](./x-types.result.md)
## Result interface
A search result.
**Signature:**
```typescript
export interface Result extends NamedModel<'Result'>, Identifiable, Taggable
```
**Extends:** [NamedModel](./x-types.namedmodel.md)<!-- --><'Result'>, [Identifiable](./x-types.identifiable.md)<!-- -->, [Taggable](./x-types.taggable.md)
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [identifier?](./x-types.result.identifier.md) | | [ResultIdentifier](./x-types.resultidentifier.md) | _(Optional)_ [Result identifier](./x-types.resultidentifier.md)<!-- -->. |
| [images?](./x-types.result.images.md) | | string\[\] | _(Optional)_ Images of the result. It should be the URLs. |
| [isWishlisted?](./x-types.result.iswishlisted.md) | | boolean | _(Optional)_ Flag if the results has been added to the wishlist or not. |
| [name?](./x-types.result.name.md) | | string | _(Optional)_ Result name. |
| [price?](./x-types.result.price.md) | | [ResultPrice](./x-types.resultprice.md) | _(Optional)_ [Result price](./x-types.resultprice.md)<!-- -->. |
| [rating?](./x-types.result.rating.md) | | [ResultRating](./x-types.resultrating.md) | _(Optional)_ [Result rating](./x-types.resultrating.md)<!-- -->. |
| [type?](./x-types.result.type.md) | | string | _(Optional)_ The type of the result: product, article, pack, etc... |
| [url?](./x-types.result.url.md) | | string | _(Optional)_ Result URL to redirect to PDP. |
| [variants?](./x-types.result.variants.md) | | [ResultVariant](./x-types.resultvariant.md)<!-- -->\[\] | _(Optional)_ [Variants of the result](./x-types.resultvariant.md)<!-- -->. |