Module geocoding

@honua/sdk-js/geocoding — HonuaGeocodingClient for forward / reverse geocoding and typeahead suggestions over a Honua-hosted GeocodeServer.

Example

import { HonuaGeocodingClient } from "@honua/sdk-js/geocoding";

const geo = new HonuaGeocodingClient({
  baseUrl: "https://your-honua-server.example",
  locatorName: "world-geocoder",
});

const results = await geo.forwardGeocode("1 Honolulu Pl, HI");
// reverseGeocode is latitude-first, then longitude.
const here = await geo.reverseGeocode(21.30, -157.85);
const hints = await geo.suggest("honol");

Example: Debounced typeahead

let timer: ReturnType<typeof setTimeout> | undefined;
input.addEventListener("input", (event) => {
  clearTimeout(timer);
  const text = (event.target as HTMLInputElement).value;
  timer = setTimeout(async () => {
    render(await geo.suggest(text));
  }, 200);
});

References

CapabilityPolicy

Classes

HonuaGeocodingClient

Interfaces

ForwardGeocodeOptions GeocodeResult GeocodeSuggestion GeocodingClientOptions GeocodingProvenance GeocodingProvider HonuaGeocodingProviderOptions NominatimProviderOptions PeliasProviderOptions PhotonProviderOptions ProviderGeocodeMatch ProviderGeocodeOptions ProviderReverseMatch ProviderSuggestion ProviderSuggestOptions ProviderTransportOptions ReverseGeocodeOptions ReverseGeocodeResult SuggestOptions

Type Aliases

GeocodingCapability

Functions

assertGeocodingCapability honuaGeocodingProvider nominatimGeocodingProvider peliasGeocodingProvider photonGeocodingProvider supportsGeocodingCapability

References

CapabilityPolicy

Re-exports CapabilityPolicy

Settings

Member Visibility

On This Page

References