Type Alias RouteRequest

RouteRequest: RouteProfile & (
| { destination: Coordinates; origin: Coordinates }
| { locations: [Coordinates, Coordinates] }
)

Exactly two locations with a supported road profile and optional matching settings.

Type Declaration

{ destination: Coordinates; origin: Coordinates }
- destination: Coordinates
  
  End coordinate inside the dataset coverage.
- origin: Coordinates
  
  Start coordinate inside the dataset coverage.
{ locations: [Coordinates, Coordinates] }
- locations: [Coordinates, Coordinates]
  
  Ordered pair: start, then end. Intermediate stops are unsupported.

Remarks

Supply either origin/destination or an ordered locations tuple. The SDK fixes kilometers, English instructions, a 30 m correlation radius, and minimum reachability 0. Additional native request options are not exposed.

Type Alias RouteRequest

Type Declaration

destination: Coordinates

origin: Coordinates

locations: [Coordinates, Coordinates]

Remarks

Settings