IHubApiSearchRequest

Interface

Structure for making Hub API Search Requests

Properties

Property Type Notes
options IHubSearchOptions

Search options like the number of results to return, sorting, aggregations etc

q string | Filter<FilterType> | Array<IFilterGroup<FilterType>>

Can be a string like term:"water", a single filter like { filterType: "item", term: "water" } or an array of IFilterGroups, which allows for complex queries.


Interface defined in common/src/search/types/IHubApiSearchRequest.ts:7