@empathyco/x-components
Version:
Empathy X Components
97 lines (43 loc) • 1.07 kB
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
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[items](./x-types.previewresults.items.md)
</td><td>
</td><td>
[Result](./x-types.result.md)<!-- -->\[\]
</td><td>
The results to preview the search request.
</td></tr>
<tr><td>
[query](./x-types.previewresults.query.md)
</td><td>
</td><td>
string
</td><td>
The searched query.
</td></tr>
<tr><td>
[totalResults](./x-types.previewresults.totalresults.md)
</td><td>
</td><td>
number
</td><td>
The number of results of the query.
</td></tr>
</tbody></table>