documentation on IRoute interface incorrect

[noerw]

The docs say that a custom route should have the field waypoints. This is not correct, my router implementation only worked once i created routes with the following fields instead:

inputWaypoints,   // waypoints passed to route()
actualWaypoints,  // corresponding waypoints returned by the router
waypointIndices,  // indices of the waypoints in `coordinates[]`

[noerw]

related: #545

[curtisy1]

Nice catch! The properties were indeed undocumented before. I revamped the docs a bit for the upcoming v4 so this is now corrected. One thing to look out for however: The actualWaypoints will only be called waypoints in the next version