hubSearch
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 |
|---|---|---|
| boolean |
Can more results be fetched? |
|
| function() : Promise<IHubSearchResponse<>> |
Function that fetches the next page of results |
|
| [] |
Array if results |
|
| number |
Total number of matches for the query |
|
| Optional | IHubAggregation[] |
Array of requested aggregations |
| Optional | Kilobyte |
The length of the query string that was just executed in the search, measured in kilobytes |
| Optional | IMessage[] |
Array of messages / warnings |
Function defined in packages/common/src/search/hubSearch.ts:41