Interface IGeoClient

Hierarchy

IGeoClient

Implemented by

GeoClient

Index

Methods

Methods

autocompleteSearch

autocompleteSearch(query: AutocompleteQuery, resolveResults?: boolean): Promise<EtomonLocation[]>

- Defined in api/client/IGeoClient.ts:21
Returns all matching Google Autocomplete entries, given an input keyword

Parameters
- query: AutocompleteQuery
  
  The autocomplete query
- Optional resolveResults: boolean
  
  Whether to return EtomonLocation objects fully resolved, or just basic info.
Returns Promise<EtomonLocation[]>

resolveLocations

resolveLocations(query: EtomonLocationQueryOrResult): Promise<EtomonLocation[]>

- Defined in api/client/IGeoClient.ts:10
Resolves EtomonLocation objects given a EtomonLocationQuery, returning all results found.

Parameters
- query: EtomonLocationQueryOrResult
Returns Promise<EtomonLocation[]>

resolveOneLocation

resolveOneLocation(query: EtomonLocationQueryOrResult): Promise<EtomonLocation>

- Defined in api/client/IGeoClient.ts:15
Resolves a single EtomonLocation object given a EtomonLocationQuery, returning the top result, as ordered be priority.

Parameters
- query: EtomonLocationQueryOrResult
Returns Promise<EtomonLocation>

Generated using TypeDoc