remove deprecated properties in nearest-point-on-line

Author: EmilJunker

packages/turf-nearest-point-on-line/README.md

@@ -10,19 +10,6 @@ If any of the segments in the input line string are antipodal and therefore
 have an undefined arc, this function will instead return that the point lies
 on the line.
 
-⚠️ We have begun the process of migrating to different return properties for
-this function. The new properties we recommend using as of v7.4 are:
-
-*   lineStringIndex - point was found on the nth LineString of an input MultiLineString. Previously `multiFeatureIndex`
-*   segmentIndex - point was found on the nth segment of the above LineString. Previously `index`
-*   totalDistance - distance from the start of the overall MultiLineString. Previously `location`
-*   lineDistance - distance from the start of the relevant LineString
-*   segmentDistance - distance from the start of the relevant segment
-*   pointDistance - distance between found point is from input reference point. Previously `dist`
-
-multiFeatureIndex, index, location, and dist continue to work as previously
-until at least the next major release.
-
 ### Parameters
 
 *   `lines` **([Geometry][1] | [Feature][2]<([LineString][3] | [MultiLineString][4])>)** Lines to snap to

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

@@ -17,18 +17,6 @@ import { getCoord, getCoords } from "@turf/invariant";
  * have an undefined arc, this function will instead return that the point lies
  * on the line.
  *
- * ⚠️ We have begun the process of migrating to different return properties for
- * this function. The new properties we recommend using as of v7.4 are:
- * - lineStringIndex - point was found on the nth LineString of an input MultiLineString. Previously `multiFeatureIndex`
- * - segmentIndex - point was found on the nth segment of the above LineString. Previously `index`
- * - totalDistance - distance from the start of the overall MultiLineString. Previously `location`
- * - lineDistance - distance from the start of the relevant LineString
- * - segmentDistance - distance from the start of the relevant segment
- * - pointDistance - distance between found point is from input reference point. Previously `dist`
- *
- * multiFeatureIndex, index, location, and dist continue to work as previously
- * until at least the next major release.
- *
  * @function
  * @param {Geometry|Feature<LineString|MultiLineString>} lines Lines to snap to
  * @param {Geometry|Feature<Point>|number[]} inputPoint Point to snap from
@@ -65,10 +53,6 @@ function nearestPointOnLine<G extends LineString | MultiLineString>(
     lineDistance: number;
     segmentDistance: number;
     pointDistance: number;
-    multiFeatureIndex: number;
-    index: number;
-    location: number;
-    dist: number;
     [key: string]: any;
   }
 > {
@@ -85,12 +69,6 @@ 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;
@@ -153,21 +131,7 @@ function nearestPointOnLine<G extends LineString | MultiLineString>(
             lineDistance: lineDistance + segmentDistance,
             segmentDistance: segmentDistance,
             pointDistance: pointDistance,
-            // deprecated properties START
-            multiFeatureIndex: -1,
-            index: -1,
-            location: -1,
-            dist: Infinity,
-            // deprecated properties END
           });
-          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,10 +46,6 @@ test("turf-nearest-point-on-line", (t) => {
       6
     );
     onLine.properties.pointDistance = round(onLine.properties.pointDistance, 6);
-    // deprecated properties START
-    onLine.properties.dist = round(onLine.properties.dist, 6);
-    onLine.properties.location = round(onLine.properties.location, 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/end-point-1.geojson

@@ -35,10 +35,6 @@
     {
       "type": "Feature",
       "properties": {
-        "dist": 0.373652,
-        "location": 3.505821,
-        "index": 2,
-        "multiFeatureIndex": 0,
         "lineStringIndex": 0,
         "segmentIndex": 2,
         "totalDistance": 3.505821,

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

@@ -34,10 +34,6 @@
     {
       "type": "Feature",
       "properties": {
-        "dist": 0.373652,
-        "location": 3.505821,
-        "index": 1,
-        "multiFeatureIndex": 0,
         "lineStringIndex": 0,
         "segmentIndex": 1,
         "totalDistance": 3.505821,

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

@@ -45,10 +45,6 @@
         "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,10 +45,6 @@
         "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,10 +73,6 @@
         "lineDistance": 4800.716022,
         "segmentDistance": 173.221741,
         "pointDistance": 114.725451,
-        "dist": 114.725451,
-        "multiFeatureIndex": 1,
-        "location": 9479.011715,
-        "index": 20,
         "marker-color": "#F0F"
       },
       "geometry": {

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

@@ -54,10 +54,6 @@
         "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,10 +63,6 @@
         "lineDistance": 214.735285,
         "segmentDistance": 214.735285,
         "pointDistance": 121.937841,
-        "dist": 121.937841,
-        "multiFeatureIndex": 0,
-        "location": 214.735285,
-        "index": 0,
         "marker-color": "#F0F"
       },
       "geometry": {