hubSearch

Function

Main entrypoint for searching via Hub

Default's to search ArcGIS Portal but can delegate to Hub API when it's available.

Parameters

Parameter Type Default Notes
query Required IQuery
options Required IHubSearchOptions

Returns

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


Function defined in common/src/search/hubSearch.ts:31