Class NgwProvider

constructor

• new NgwProvider(options): NgwProvider

• Parameters

  • options: NgwProviderOptions

  Returns NgwProvider

searchResources

Static limit

abort

• abort(): void

• Optional method to abort any ongoing geocoding requests.

  Returns void

  Abstract

result

• result(item): default<ResultItem>

• Method to retrieve detailed result for a specific search item.

  Parameters

  • item: NgwSearchItem

    The search item to get detailed result for.

  Returns default<ResultItem>

  A promise that resolves to the detailed result.

  Abstract

reverse

• reverse(coordinates): 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.

  Abstract

search

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

• Search method to retrieve geocoding results.

  Parameters

  • query: string

    The search string to geocode.

  Returns AsyncGenerator<NgwSearchItem, void, unknown>

  Abstract

  Yields

  An async generator that yields search results.