Class BaseProvider<O>Abstract

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

Type Parameters

Hierarchy (view full)

Constructors

constructor

Properties

label? searchUrl?

Methods

abort? result reverse search

Constructors

constructor

Properties

Optionallabel

label?: string

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

OptionalsearchUrl

searchUrl?: string

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

Methods

Optional Abstractabort

  • abort(): void

  • Optional method to abort any ongoing geocoding requests.

    Returns void

Abstractresult

  • result(item): 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): AsyncGenerator<SearchItem, any, 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, any, unknown>

    An async generator that yields reverse geocoding results.

Abstractsearch

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

  • Search method to retrieve geocoding results.

    Parameters

    • query: string

      The search string to geocode.

    Returns AsyncGenerator<SearchItem, any, unknown>

    Yields

    An async generator that yields search results.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods