Hierarchy

Constructors

Properties

Methods

  • Optional method to abort any ongoing geocoding requests.

    Returns void

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

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

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

  • Search method to retrieve geocoding results.

    Parameters

    • query: string

      The search string to geocode.

    Returns AsyncGenerator<SearchItem, void, unknown>

    An async generator that yields search results.