IQuery is the fundamental unit used to execute a search. By composing Filter's and IPredicates, we can express very complex queries

The Hub Search Guide contains many examples.


Property Type Notes
filters IFilter[]

Filters that make up the query

targetEntity EntityType

What entity is this query targeting. This is used internally to ensure we query the correct API

collection Optional WellKnownCollection

An id for a well known collection that the query should use.

properties Optional Record<stringany>

Additional properties. Useful for groupMember queries where we need to send in the groupId to construct the url

Interface defined in common/src/search/types/IHubCatalog.ts:86