Interface NominatimProviderOptionsExperimental

Options for nominatimGeocodingProvider.

interface NominatimProviderOptions {
    attribution?: string;
    baseUrl: string;
    capabilityPolicy?: CapabilityPolicy;
    email?: string;
    fetchFn?: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    };
    timeoutMs?: number;
    usagePolicyUrl?: string;
    userAgent?: string;
}

Hierarchy (view full)

Properties

attribution? baseUrl capabilityPolicy? email? fetchFn? timeoutMs? usagePolicyUrl? userAgent?

Properties

Optional Experimentalattribution

attribution?: string

Override the default attribution string (self-hosted instances).

ExperimentalbaseUrl

baseUrl: string

Base URL of the Nominatim instance, e.g. https://nominatim.example.org. Required — no third-party default is baked in (usage-policy safety).

Optional ExperimentalcapabilityPolicy

capabilityPolicy?: CapabilityPolicy

Capability policy; "strict" (default) throws on suggest.

Optional Experimentalemail

email?: string

Contact email forwarded as the email query parameter (public-instance etiquette).

OptionalfetchFn

fetchFn?: {
    (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
    (input: string | URL | Request, init?: RequestInit): Promise<Response>;
}

Custom fetch implementation (testing, interception, auth bridges).

Type declaration

    • (input, init?): Promise<Response>

    • MDN Reference

      Parameters

      • input: URL | RequestInfo
      • Optionalinit: RequestInit

      Returns Promise<Response>

    • (input, init?): Promise<Response>

    • Parameters

      • input: string | URL | Request
      • Optionalinit: RequestInit

      Returns Promise<Response>

Optional ExperimentaltimeoutMs

timeoutMs?: number

Per-request timeout in milliseconds.

Optional ExperimentalusagePolicyUrl

usagePolicyUrl?: string

Override the default usage-policy URL (self-hosted instances).

Optional ExperimentaluserAgent

userAgent?: string

Value for the User-Agent header. The OSMF usage policy requires a real application identifier when using the public instance. Only settable in non-browser runtimes; browsers control their own User-Agent.

Settings

Member Visibility

On This Page

Properties