@empathyco/x-components
Version:
Empathy X Components
23 lines (14 loc) • 1.21 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-types](./x-types.md) > [PartialResult](./x-types.partialresult.md)
## PartialResult interface
A partial result represents a sub-query of a user search term which normally has not enough results (or not results at all). It includes a preview of these results and the number of total results that match against the sub-query.
**Signature:**
```typescript
export interface PartialResult extends Previewable
```
**Extends:** [Previewable](./x-types.previewable.md)
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [results](./x-types.partialresult.results.md) | | [Result](./x-types.result.md)<!-- -->\[\] \| null | 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.partialresult.totalresults.md) | | number \| null | 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. |