@empathyco/x-components
Version:
Empathy X Components
24 lines (15 loc) • 1.25 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-types](./x-types.md) > [Previewable](./x-types.previewable.md)
## Previewable interface
Represents an item that is searchable, and the results associated to it.
**Signature:**
```typescript
export interface Previewable
```
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [facets?](./x-types.previewable.facets.md) | | [Facet](./x-types.facet.md)<!-- -->\[\] | _(Optional)_ Facets to apply to the <code>query</code> property when searching. |
| [query](./x-types.previewable.query.md) | | string | The query to search for. |
| [results?](./x-types.previewable.results.md) | | [Result](./x-types.result.md)<!-- -->\[\] \| null | _(Optional)_ The results that the combination of <code>query</code> and <code>facets</code> properties return, or <code>null</code> if they have not been loaded yet. |
| [totalResults?](./x-types.previewable.totalresults.md) | | number \| null | _(Optional)_ The number of results that the combination of <code>query</code> and <code>facets</code> properties return, or <code>null</code> if they have not been loaded yet. |