@empathyco/x-components
Version:
Empathy X Components
79 lines (36 loc) • 1.37 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
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[results](./x-types.partialresult.results.md)
</td><td>
</td><td>
[Result](./x-types.result.md)<!-- -->\[\] \| null
</td><td>
The results that the combination of `query` and `facets` properties return, or `null` if they have not been loaded yet.
</td></tr>
<tr><td>
[totalResults](./x-types.partialresult.totalresults.md)
</td><td>
</td><td>
number \| null
</td><td>
The number of results that the combination of `query` and `facets` properties return, or `null` if they have not been loaded yet.
</td></tr>
</tbody></table>