Class NgwProvider

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

Hierarchy (View Summary)

BaseProvider<NgwProviderOptions>
- NgwProvider

Index

Constructors

Properties

label? searchResources searchUrl? limit

Methods

abort result reverse search

Constructors

constructor

new NgwProvider(options: NgwProviderOptions): NgwProvider
Parameters
- options: NgwProviderOptions
Returns NgwProvider
Overrides BaseProvider.constructor
- Defined in packages/geocoder/src/providers/NgwProvider.ts:73

Properties

`Optional`label

label?: string

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

searchResources

searchResources: SearchResource[] = []

`Optional`searchUrl

searchUrl?: string

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

`Static`limit

limit: number = 300

Methods

`Abstract`abort

abort(): void
Optional method to abort any ongoing geocoding requests.

Returns void
Overrides BaseProvider.abort
- Defined in packages/geocoder/src/providers/NgwProvider.ts:90

`Abstract`result

result(item: NgwSearchItem): Promise<ResultItem>
Method to retrieve detailed result for a specific search item.
Parameters
- item: NgwSearchItem
  The search item to get detailed result for.
Returns Promise<ResultItem>
A promise that resolves to the detailed result.
Overrides BaseProvider.result
- Defined in packages/geocoder/src/providers/NgwProvider.ts:152

`Abstract`reverse

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.
Overrides BaseProvider.reverse
- Defined in packages/geocoder/src/providers/NgwProvider.ts:175

`Abstract`search

search(query: string): AsyncGenerator<NgwSearchItem, void, unknown>
Search method to retrieve geocoding results.
Parameters
- query: string
  The search string to geocode.
Returns AsyncGenerator<NgwSearchItem, void, unknown>

Yields
An async generator that yields search results.
Overrides BaseProvider.search
- Defined in packages/geocoder/src/providers/NgwProvider.ts:97