This is the documentation of version 1.0.0-rc.0. Go to the latest version, 1.0.0-rc.5.

Type Alias Route<P>

Route: Omit<Feature<LineString, P>, "id" | "bbox"> & { bbox: BBox; id: string }

A calculated route, as a GeoJSON Feature.

Its geometry is a LineString of the route path coordinates, and its properties hold all route information (summary, sections, guidance).

Type Parameters

P extends RouteProps = RouteProps
Type of the route properties (defaults to RouteProps)

Type Declaration

bbox: BBox

The bounding box of the entire route, or at least of its waypoints.
id: string

The unique identifier of this route, randomly generated to tell route alternatives apart.

Example

const route: Route = {
  type: 'Feature',
  geometry: {
    type: 'LineString',
    coordinates: [[4.9, 52.3], [4.91, 52.31], ...]
  },
  properties: {
    id: 'route-123',
    summary: { lengthInMeters: 5000, travelTimeInSeconds: 300, ... },
    sections: { ... },
    index: 0
  }
};