Interface PeliasProviderOptionsExperimental

Options for peliasGeocodingProvider.

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

Hierarchy (view full)

Properties

apiKey? attribution? baseUrl capabilityPolicy? fetchFn? timeoutMs? usagePolicyUrl?

Properties

Optional ExperimentalapiKey

apiKey?: string

API key forwarded as the api_key query parameter (hosted instances).

Optional Experimentalattribution

attribution?: string

Override the default attribution string to match your instance's datasets.

ExperimentalbaseUrl

baseUrl: string

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

Optional ExperimentalcapabilityPolicy

capabilityPolicy?: CapabilityPolicy

Capability policy; Pelias supports all declared operations.

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 (hosted/self-hosted instances).

Settings

Member Visibility

On This Page

Properties