Abstract base class representing a search provider. It builds upon the BaseGeocoder functionalities with provider-specific properties.

Hierarchy (view full)

Implements

  • NominatimProviderOptions

Constructors

Properties

label?: string

Label to represent the provider. Useful for user interfaces to display the source of search results.

options?: NominatimProviderOptions
searchUrl: string = 'https://nominatim.openstreetmap.org'

URL endpoint for the search service. This is where queries will be sent to obtain search results.

Methods

  • 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.