Type Alias UseRouteParams

Parameters for the useRoute hook

type UseRouteParams = {
    destination: Coordinate | Coordinate[];
    options?: RouteConfiguration;
    origin: Coordinate | null;
}

Index

Properties

destination options? origin

Properties

destination

destination: Coordinate | Coordinate[]

The destination(s). If an array is provided, routes to the closest destination

`Optional`options

options?: RouteConfiguration

Optional configuration for route calculation

origin

origin: Coordinate | null

The starting point of the route. Set to null to clear the route