IHubSearchResponse
Defines a generic search response interface with parameterized result type for different types of searches
total - total number of results results - potentially paginated list of results hasNext - boolean flag for if there are any more pages ofresults next - invokable function for obtaining next page of results
Properties
| Property | Type | Notes |
|---|---|---|
| boolean |
Can more results be fetched? |
|
| function(params: any) : Promise<IHubSearchResponse<>> |
Function that fetches the next page of results |
|
| [] |
Array if results |
|
| number |
Total number of matches for the query |
|
| Optional | IHubAggregation[] |
Array of requested aggregations |
| Optional | Kilobyte |
The length of the query string that was just executed in the search, measured in kilobytes |
| Optional | IMessage[] |
Array of messages / warnings |
Interface defined in common/src/search/types/IHubSearchResponse.ts:14