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


Property Type Notes
hasNext boolean

Can more results be fetched?

next function(params: any) : Promise<IHubSearchResponse<>>

Function that fetches the next page of results

results []

Array if results

total number

Total number of matches for the query

aggregations Optional IHubAggregation[]

Array of requested aggregations

messages Optional IMessage[]

Array of messages / warnings

Interface defined in common/src/search/types/IHubSearchResponse.ts:13