nearest-point-on-line Add back deprecated properties

Author: EmilJunker

packages/turf-nearest-point-on-line/index.ts

@@ -53,6 +53,12 @@ function nearestPointOnLine<G extends LineString | MultiLineString>(
     lineDistance: number;
     segmentDistance: number;
     pointDistance: number;
+    // deprecated properties START
+    multiFeatureIndex: number; // replaced by lineStringIndex
+    index: number; // replaced by segmentIndex
+    location: number; // replaced by totalDistance
+    dist: number; // replaced by pointDistance
+    // deprecated properties END
     [key: string]: any;
   }
 > {
@@ -69,6 +75,12 @@ function nearestPointOnLine<G extends LineString | MultiLineString>(
     lineDistance: -1,
     segmentDistance: -1,
     pointDistance: Infinity,
+    // deprecated properties START
+    multiFeatureIndex: -1,
+    index: -1,
+    location: -1,
+    dist: Infinity,
+    // deprecated properties END
   });
 
   let totalDistance = 0.0;
@@ -128,7 +140,20 @@ function nearestPointOnLine<G extends LineString | MultiLineString>(
             lineDistance: lineDistance + segmentDistance,
             segmentDistance: segmentDistance,
             pointDistance: pointDistance,
+            // deprecated properties START
+            multiFeatureIndex: -1,
+            index: -1,
+            location: -1,
+            dist: Infinity,
           });
+          closestPt.properties = {
+            ...closestPt.properties,
+            multiFeatureIndex: closestPt.properties.lineStringIndex,
+            index: closestPt.properties.segmentIndex,
+            location: closestPt.properties.totalDistance,
+            dist: closestPt.properties.pointDistance,
+            // deprecated properties END
+          };
         }
 
         // update totalDistance and lineDistance

packages/turf-nearest-point-on-line/test.ts

@@ -46,6 +46,10 @@ test("turf-nearest-point-on-line", (t) => {
       6
     );
     onLine.properties.pointDistance = round(onLine.properties.pointDistance, 6);
+    // deprecated properties START
+    onLine.properties.location = round(onLine.properties.location, 6);
+    onLine.properties.dist = round(onLine.properties.dist, 6);
+    // deprecated properties END
     onLine.properties["marker-color"] = "#F0F";
     const between = lineString(
       [onLine.geometry.coordinates, point.geometry.coordinates],

packages/turf-nearest-point-on-line/test/out/line-northern-latitude-#344.geojson

@@ -45,6 +45,10 @@
         "lineDistance": 19.748879,
         "segmentDistance": 1.771897,
         "pointDistance": 5.959562,
+        "dist": 5.959562,
+        "multiFeatureIndex": 0,
+        "location": 19.748879,
+        "index": 1,
         "marker-color": "#F0F"
       },
       "geometry": {

packages/turf-nearest-point-on-line/test/out/line1.geojson

@@ -45,6 +45,10 @@
         "lineDistance": 22.137494,
         "segmentDistance": 3.445915,
         "pointDistance": 2.556271,
+        "dist": 2.556271,
+        "multiFeatureIndex": 0,
+        "location": 22.137494,
+        "index": 1,
         "marker-color": "#F0F"
       },
       "geometry": {

packages/turf-nearest-point-on-line/test/out/multiLine1.geojson

@@ -73,6 +73,10 @@
         "lineDistance": 4800.716022,
         "segmentDistance": 173.221741,
         "pointDistance": 114.725451,
+        "dist": 114.725451,
+        "multiFeatureIndex": 1,
+        "location": 9479.011715,
+        "index": 21,
         "marker-color": "#F0F"
       },
       "geometry": {

packages/turf-nearest-point-on-line/test/out/multiLine2.geojson

@@ -54,6 +54,10 @@
         "lineDistance": 0,
         "segmentDistance": 0,
         "pointDistance": 390.942725,
+        "dist": 390.942725,
+        "multiFeatureIndex": 1,
+        "location": 1656.139708,
+        "index": 0,
         "marker-color": "#F0F"
       },
       "geometry": {

packages/turf-nearest-point-on-line/test/out/multiLine3.geojson

@@ -63,6 +63,10 @@
         "lineDistance": 214.735285,
         "segmentDistance": 214.735285,
         "pointDistance": 121.937841,
+        "dist": 121.937841,
+        "multiFeatureIndex": 0,
+        "location": 214.735285,
+        "index": 0,
         "marker-color": "#F0F"
       },
       "geometry": {

packages/turf-nearest-point-on-line/test/out/route1.geojson

@@ -4798,6 +4798,10 @@
         "lineDistance": 183.46844,
         "segmentDistance": 0.044741,
         "pointDistance": 7.876557,
+        "dist": 7.876557,
+        "multiFeatureIndex": 0,
+        "location": 183.46844,
+        "index": 3104,
         "marker-color": "#F0F"
       },
       "geometry": {

packages/turf-nearest-point-on-line/test/out/route2.geojson

@@ -3802,6 +3802,10 @@
         "lineDistance": 303.639629,
         "segmentDistance": 0.867249,
         "pointDistance": 19.22738,
+        "dist": 19.22738,
+        "multiFeatureIndex": 0,
+        "location": 303.639629,
+        "index": 1185,
         "marker-color": "#F0F"
       },
       "geometry": {