@empathyco/x-components
Version:
Empathy X Components
23 lines (14 loc) • 782 B
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-types](./x-types.md) > [PreviewResults](./x-types.previewresults.md)
## PreviewResults interface
Interface to type the query preview objects.
**Signature:**
```typescript
export interface PreviewResults
```
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [items](./x-types.previewresults.items.md) | | [Result](./x-types.result.md)<!-- -->\[\] | The results to preview the search request. |
| [query](./x-types.previewresults.query.md) | | string | The searched query. |
| [totalResults](./x-types.previewresults.totalresults.md) | | number | The number of results of the query. |