An IPredicate is a set of key/value pairs that can be evaluated into a boolean value in a search system.

For example, a predicate like

const p = { type: "Web Map"}

equates to a search where type = "Web Map"

Properties can be string, string[], IMatchOption, IDateRange<number> or IRelativeDate. Some properties are booleans and other properties have a limited set of values that can be passed.

The Hub Search Guide contains a list of properties that can be sent to the ArcGIS Portal API.

Index Signatures

Key Type Value Type Notes
string any

This is intentionally loosely typed to allow flexibility in implementation without constantly updates to this interface

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