Package version:

Interface SearchAddressResult

This object is returned from a successful Search calls.

Hierarchy

  • SearchAddressResult

Properties

fuzzyLevel? geoBias? numberResults query? queryTime queryType? results skip? totalResults?

Properties

Optional Readonly fuzzyLevel

fuzzyLevel?: number

The maximum fuzzy level required to provide Results.

Optional Readonly geoBias

geoBias?: any

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

Readonly numberResults

numberResults: number

Number of results in the response.

Optional Readonly query

query?: string

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

Readonly queryTime

queryTime: number

Time spent resolving the query, in milliseconds.

Optional Readonly queryType

queryType?: string

The type of query being returned: NEARBY or NON_NEAR.

Readonly results

results: Object

A list of Search API results.

Optional Readonly skip

skip?: number

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

Optional Readonly totalResults

totalResults?: number

The total number of Results found.

Settings

Member Visibility

Theme

Generated using TypeDoc