Interface IGeocoder

An interface implemented to respond to geocoding queries

interface IGeocoder {
    geocode(
        query: string,
        context?: GeocodingContext,
    ): Promise<GeocodingResult[]>;
    reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>;
    suggest(
        query: string,
        context?: GeocodingContext,
    ): Promise<GeocodingResult[]>;
}

Implemented by

Index

Methods

geocode reverse? suggest?

Methods

geocode

geocode(query: string, context?: GeocodingContext): Promise<GeocodingResult[]>
Performs a geocoding query and returns the results as promise
Parameters
- query: string
  the query
- Optionalcontext: GeocodingContext
  the context for the query
Returns Promise<GeocodingResult[]>
- Defined in src/geocoders/api.ts:52

`Optional`reverse

reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>
Performs a reverse geocoding query and returns the results as promise
Parameters
- location: LatLngLiteral
  the coordinate to reverse geocode
- scale: number
  the map scale possibly used for reverse geocoding
Returns Promise<GeocodingResult[]>
- Defined in src/geocoders/api.ts:64

`Optional`suggest

suggest(query: string, context?: GeocodingContext): Promise<GeocodingResult[]>
Performs a geocoding query suggestion (this happens while typing) and returns the results as promise
Parameters
- query: string
  the query
- Optionalcontext: GeocodingContext
  the context for the query
Returns Promise<GeocodingResult[]>
- Defined in src/geocoders/api.ts:58