@honua/sdk-js
    Preparing search index...

    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 Summary)

    Index

    Properties

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

    Properties

    apiKey?: string

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

    attribution?: string

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

    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).

    capabilityPolicy?: CapabilityPolicy

    Capability policy; Pelias supports all declared operations.

    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: URL | RequestInfo, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | URL | Request, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

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

        Returns Promise<Response>

    timeoutMs?: number

    Per-request timeout in milliseconds.

    usagePolicyUrl?: string

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

    Settings

    Member Visibility

    On This Page

    Properties