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

    Interface GeocodingProviderExperimental

    Provider-pluggable geocoding contract. All adapters normalize into the same typed result shapes; capability differences are declared, not discovered at runtime.

    Operations outside capabilities throw HonuaCapabilityNotSupportedError under the "strict" capability policy (the default) and resolve to an empty result under "degraded".

    interface GeocodingProvider {
        attribution: string;
        capabilities: readonly GeocodingCapability[];
        id: string;
        usagePolicyUrl?: string;
        geocode(
            query: string,
            options?: ProviderGeocodeOptions,
        ): Promise<ProviderGeocodeMatch[]>;
        reverse(
            latitude: number,
            longitude: number,
        ): Promise<ProviderReverseMatch | null>;
        suggest(
            text: string,
            options?: ProviderSuggestOptions,
        ): Promise<ProviderSuggestion[]>;
    }
    Index

    Properties

    attribution capabilities id usagePolicyUrl?

    Methods

    geocode reverse suggest

    Properties

    attribution: string

    Human-readable data attribution the host is obliged to display.

    capabilities: readonly GeocodingCapability[]

    Operations this provider supports.

    id: string

    Stable provider identifier, e.g. "nominatim".

    usagePolicyUrl?: string

    Usage/acceptable-use policy for the configured endpoint, when known.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods