@esri/hub.js

@esri/hub.js

formatOgcItemsResponse

Function

formatOgcItemsResponse(response: IOgcItemsResponse, url: string, originalQuery: IQuery, originalOptions: ISearchOgcItemsOptions) : Promise<IHubSearchResponse<IHubSearchResult>>

Parameters

Parameter	Type	Default	Notes
response Required	IOgcItemsResponse
url Required	string
originalQuery Required	IQuery
originalOptions Required	ISearchOgcItemsOptions

Returns

Promise<IHubSearchResponse<IHubSearchResult>>

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
executedQuerySize Optional	Kilobyte	The length of the query string that was just executed in the search, measured in kilobytes
messages Optional	IMessage[]	Array of messages / warnings

Function defined in common/src/search/_internal/hubSearchItemsHelpers/formatOgcItemsResponse.ts:9