Class Geocoder

constructor

• new Geocoder(options: GeocoderOptions): Geocoder

  Parameters

  • options: GeocoderOptions

  Returns Geocoder

providers

Abstractabort

• abort(): void

  Optional method to abort any ongoing geocoding requests.

  Returns void

Abstractresult

• result(item: SearchItem): Promise<any>

  Method to retrieve detailed result for a specific search item.

  Parameters

  • item: SearchItem

    The search item to get detailed result for.

  Returns Promise<any>

  A promise that resolves to the detailed result.

Abstractreverse

• reverse(coordinates: LngLatArray): AsyncGenerator<SearchItem, void, unknown>

  Method for reverse geocoding. Takes coordinates and returns the corresponding address or location information.

  Parameters

  • coordinates: LngLatArray

    The longitude and latitude values.

  Returns AsyncGenerator<SearchItem, void, unknown>

  An async generator that yields reverse geocoding results.

reverseGeocodeFirstResult

• reverseGeocodeFirstResult(
      coordinates: LngLatArray,
  ): Promise<undefined | SearchItem>

  Returns the first reverse geocoding result for given coordinates from any provider.

  Parameters

  • coordinates: LngLatArray

    The longitude and latitude values.

  Returns Promise<undefined | SearchItem>

  A promise that resolves to the first reverse geocoding result, or undefined if no results are found.

Abstractsearch

• search(query: string): AsyncGenerator<SearchItem, void, unknown>

  Search method to retrieve geocoding results.

  Parameters

  • query: string

    The search string to geocode.

  Returns AsyncGenerator<SearchItem, void, unknown>

  Yields

  An async generator that yields search results.