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<null | ProviderReverseMatch>;
    suggest(text: string, options?: ProviderSuggestOptions): Promise<ProviderSuggestion[]>;
}

Properties

attribution capabilities id usagePolicyUrl?

Methods

geocode reverse suggest

Properties

Readonly Experimentalattribution

attribution: string

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

Readonly Experimentalcapabilities

capabilities: readonly GeocodingCapability[]

Operations this provider supports.

Readonly Experimentalid

id: string

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

Optional Readonly ExperimentalusagePolicyUrl

usagePolicyUrl?: string

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

Methods

geocode

reverse

suggest

Settings

Member Visibility

On This Page

Properties
Methods