SearchAddressResult interface

Package:

@azure/maps-search

This object is returned from a successful Search calls.

Properties

fuzzyLevel	The maximum fuzzy level required to provide Results.
geoBias	Indication when the internal search engine has applied a geospatial bias to improve the ranking of results.
numberResults	Number of results in the response.
query	The query parameter that was used to produce these search results.
queryTime	Time spent resolving the query, in milliseconds.
queryType	The type of query being returned: NEARBY or NON_NEAR.
results	A list of Search API results.
skip	The starting offset of the returned Results within the full Result set.
totalResults	The total number of Results found.

Property Details

fuzzyLevel

The maximum fuzzy level required to provide Results.

fuzzyLevel?: number

Property Value

number

geoBias

Indication when the internal search engine has applied a geospatial bias to improve the ranking of results.

geoBias?: LatLon

Property Value

LatLon

numberResults

Number of results in the response.

numberResults: number

Property Value

number

query

The query parameter that was used to produce these search results.

query?: string

Property Value

string

queryTime

Time spent resolving the query, in milliseconds.

queryTime: number

Property Value

number

queryType

The type of query being returned: NEARBY or NON_NEAR.

queryType?: string

Property Value

string

results

A list of Search API results.

results: SearchAddressResultItem[]

Property Value

SearchAddressResultItem[]

skip

The starting offset of the returned Results within the full Result set.

skip?: number

Property Value

number

totalResults

The total number of Results found.

totalResults?: number

Property Value

number