Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NominatimOptions

Hierarchy

Index

Properties

Optional apiKey

apiKey: string

API key to use this service

Optional geocodingQueryParams

geocodingQueryParams: Record<string, unknown>

Additional URL parameters (strings) that will be added to geocoding requests; can be used to restrict results to a specific country for example, by providing the countrycodes parameter to Nominatim

htmlTemplate

htmlTemplate: (r: NominatimResult) => string

A function that takes an GeocodingResult as argument and returns an HTML formatted string that represents the result. Default function breaks up address in parts from most to least specific, in attempt to increase readability compared to Nominatim's naming

Type declaration

Optional reverseQueryParams

reverseQueryParams: Record<string, unknown>

Additional URL parameters (strings) that will be added to reverse geocoding requests

serviceUrl

serviceUrl: string

URL of the service

Generated using TypeDoc