Module routingExperimental

@honua/sdk-js/routing — provider-pluggable routing: the typed RoutingProvider contract plus first-party OSRM and Valhalla adapters and the Honua facade bridge. No Honua server is required; provider selection is explicit configuration and no third-party endpoint is baked in.

Example

import { osrmRoutingProvider } from "@honua/sdk-js/routing";

const router = osrmRoutingProvider({ baseUrl: "https://osrm.example.org" });
const route = await router.route([
  { longitude: -157.858, latitude: 21.306 },
  { longitude: -157.802, latitude: 21.262 },
]);
console.log(route.distanceMeters, route.provenance.attribution);

Example: Back an esri-compat `RouteTaskCompat` with OSRM

import { osrmRoutingProvider, routingProviderToCompatRouteProvider } from "@honua/sdk-js/routing";
import { RouteTaskCompat } from "@honua/sdk-js/esri-compat";

const task = new RouteTaskCompat({
  routeProvider: routingProviderToCompatRouteProvider(
    osrmRoutingProvider({ baseUrl: "https://osrm.example.org" }),
  ),
});

The /routing subpath is experimental: useful today, but the shape may change in any minor release prior to 1.0.0.

References

CapabilityPolicy ProviderTransportOptions

Interfaces

CompatRouteSolveResult CompatRouteStop HonuaRoutingProviderOptions OsrmProviderOptions ProviderRouteLeg ProviderRouteResult RouteWaypoint RoutingProvenance RoutingProvider ValhallaProviderOptions

Type Aliases

CompatRouteSolver RoutingCapability

Functions

assertRoutingCapability decodePolyline honuaRoutingProvider osrmRoutingProvider routingProviderToCompatRouteProvider supportsRoutingCapability valhallaRoutingProvider

References

ExperimentalCapabilityPolicy

Re-exports CapabilityPolicy

ExperimentalProviderTransportOptions

Re-exports ProviderTransportOptions

Settings

Member Visibility

On This Page

References