Interface NominatimOptions

interface NominatimOptions {
    apiKey?: string;
    geocodingQueryParams?: Record<string, unknown>;
    htmlTemplate: (r: NominatimResult) => string;
    reverseQueryParams?: Record<string, unknown>;
    serviceUrl: string;
}

Hierarchy (View Summary)

Properties

apiKey? geocodingQueryParams? htmlTemplate reverseQueryParams? serviceUrl

Properties

OptionalapiKey

apiKey?: string

API key to use this service

OptionalgeocodingQueryParams

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

OptionalreverseQueryParams

reverseQueryParams?: Record<string, unknown>

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

serviceUrl

serviceUrl: string

URL of the service

Settings

Member Visibility

On This Page

Properties