UNPKG

@empathyco/x-components

Version:
212 lines (92 loc) 2.53 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [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)<!-- -->&lt;'Result'&gt;, [Identifiable](./x-types.identifiable.md)<!-- -->, [Taggable](./x-types.taggable.md) ## Properties <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td> [identifier?](./x-types.result.identifier.md) </td><td> </td><td> [ResultIdentifier](./x-types.resultidentifier.md) </td><td> _(Optional)_ [Result identifier](./x-types.resultidentifier.md)<!-- -->. </td></tr> <tr><td> [images?](./x-types.result.images.md) </td><td> </td><td> string\[\] </td><td> _(Optional)_ Images of the result. It should be the URLs. </td></tr> <tr><td> [isWishlisted?](./x-types.result.iswishlisted.md) </td><td> </td><td> boolean </td><td> _(Optional)_ Flag if the results has been added to the wishlist or not. </td></tr> <tr><td> [name?](./x-types.result.name.md) </td><td> </td><td> string </td><td> _(Optional)_ Result name. </td></tr> <tr><td> [price?](./x-types.result.price.md) </td><td> </td><td> [ResultPrice](./x-types.resultprice.md) </td><td> _(Optional)_ [Result price](./x-types.resultprice.md)<!-- -->. </td></tr> <tr><td> [rating?](./x-types.result.rating.md) </td><td> </td><td> [ResultRating](./x-types.resultrating.md) </td><td> _(Optional)_ [Result rating](./x-types.resultrating.md)<!-- -->. </td></tr> <tr><td> [type?](./x-types.result.type.md) </td><td> </td><td> string </td><td> _(Optional)_ The type of the result: product, article, pack, etc... </td></tr> <tr><td> [url?](./x-types.result.url.md) </td><td> </td><td> string </td><td> _(Optional)_ Result URL to redirect to PDP. </td></tr> <tr><td> [variants?](./x-types.result.variants.md) </td><td> </td><td> [ResultVariant](./x-types.resultvariant.md)<!-- -->\[\] </td><td> _(Optional)_ [Variants of the result](./x-types.resultvariant.md)<!-- -->. </td></tr> </tbody></table>