Type Alias Waypoint<T>

Waypoint: Feature<Point, WaypointProps & T>

GeoJSON Feature representing a route waypoint.

Waypoints are points that define the route path. The route will pass through each waypoint in the order they are specified.

Type Parameters

T extends Anything = Anything
Additional custom properties beyond the standard waypoint properties

Remarks

Regular waypoints (without radius) create route legs and generate arrival instructions
Circle waypoints (with radiusMeters) shape the route without creating legs

Example

// Regular waypoint
const waypoint: Waypoint = {
  type: 'Feature',
  geometry: { type: 'Point', coordinates: [4.9041, 52.3676] },
  properties: {}
};

// Circle waypoint with custom properties
const circleWaypoint: Waypoint<{ name: string }> = {
  type: 'Feature',
  geometry: { type: 'Point', coordinates: [4.9041, 52.3676] },
  properties: { radiusMeters: 1000, name: 'Via Amsterdam' }
};