@tomtom-org/maps-sdk 0.62.1 → 0.62.2

package/core/dist/index.d.ts

@@ -5245,8 +5245,8 @@ export declare const withInsertedWaypoints: (route: Route, existingWaypoints: Wa
 /**
  * Interpolates the cumulative traveled distance and time at an arbitrary point on the route path.
  *
- * Uses the route's `progress` array to linearly interpolate between the two bracketing
- * {@link RouteProgressPoint} entries that surround the requested `pathIndex`.
+ * Between the two {@link RouteProgressPoint} entries bracketing `pathIndex`, values follow the line's
+ * length rather than its vertex count: vertices crowd into bends and thin out on straights.
  *
  * @param route The route whose `properties.progress` will be used for interpolation.
  *              The progress array must cover the requested index (i.e. the first entry's
@@ -5267,6 +5267,7 @@ export declare const withInsertedWaypoints: (route: Route, existingWaypoints: Wa
  * //   { pointIndex: 100,distanceInMeters: 5000,  travelTimeInSeconds: 300 }
  * // ]
  *
+ * // With vertex 25 halfway along the line from vertex 0 to vertex 50:
  * const result = calculateProgressAtRoutePoint(route, 25);
  * // result = { distanceInMeters: 1250, travelTimeInSeconds: 60 }
  * ```
@@ -5383,7 +5384,8 @@ export type RouteProgressQuery = {
 };
 /**
  * Returns the geographic coordinate and cumulative progress values at the point along a route
- * identified by a {@link RouteProgressQuery}.
+ * identified by a {@link RouteProgressQuery}. Between `progress` entries, positions follow the
+ * line's length, so equal steps of distance cover equal ground.
  *
  * @param route The route to query. Must contain `properties.progress` data.
  * @param query A discriminated union — provide exactly one of: