@turf/nearest-point-on-line 7.0.0-alpha.0 → 7.0.0-alpha.110

package/README.md

@@ -58,26 +58,21 @@ Returns **[Feature][4]<[Point][7]>** closest point on the `line` to `point`. The
 
 [11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
-<!-- This file is automatically generated. Please don't edit it directly:
-if you find an error, edit the source file (likely index.js), and re-run
-./scripts/generate-readmes in the turf project. -->
+<!-- This file is automatically generated. Please don't edit it directly. If you find an error, edit the source file of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->
 
 ---
 
-This module is part of the [Turfjs project](http://turfjs.org/), an open source
-module collection dedicated to geographic algorithms. It is maintained in the
-[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
-PRs and issues.
+This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.
 
 ### Installation
 
-Install this module individually:
+Install this single module individually:
 
 ```sh
 $ npm install @turf/nearest-point-on-line
 ```
 
-Or install the Turf module that includes it as a function:
+Or install the all-encompassing @turf/turf module that includes all modules as functions:
 
 ```sh
 $ npm install @turf/turf

package/dist/cjs/index.cjs

@@ -0,0 +1,110 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.ts
+var _bearing = require('@turf/bearing');
+var _distance = require('@turf/distance');
+var _destination = require('@turf/destination');
+var _lineintersect = require('@turf/line-intersect');
+var _meta = require('@turf/meta');
+var _helpers = require('@turf/helpers');
+var _invariant = require('@turf/invariant');
+function nearestPointOnLine(lines, pt, options = {}) {
+  if (!lines || !pt) {
+    throw new Error("lines and pt are required arguments");
+  }
+  let closestPt = _helpers.point.call(void 0, [Infinity, Infinity], {
+    dist: Infinity,
+    index: -1,
+    location: -1
+  });
+  let length = 0;
+  _meta.flattenEach.call(void 0, lines, function(line) {
+    const coords = _invariant.getCoords.call(void 0, line);
+    for (let i = 0; i < coords.length - 1; i++) {
+      const start = _helpers.point.call(void 0, coords[i]);
+      start.properties.dist = _distance.distance.call(void 0, pt, start, options);
+      const stop = _helpers.point.call(void 0, coords[i + 1]);
+      stop.properties.dist = _distance.distance.call(void 0, pt, stop, options);
+      const sectionLength = _distance.distance.call(void 0, start, stop, options);
+      const heightDistance = Math.max(
+        start.properties.dist,
+        stop.properties.dist
+      );
+      const direction = _bearing.bearing.call(void 0, start, stop);
+      const perpendicularPt1 = _destination.destination.call(void 0, 
+        pt,
+        heightDistance,
+        direction + 90,
+        options
+      );
+      const perpendicularPt2 = _destination.destination.call(void 0, 
+        pt,
+        heightDistance,
+        direction - 90,
+        options
+      );
+      const intersect = _lineintersect.lineIntersect.call(void 0, 
+        _helpers.lineString.call(void 0, [
+          perpendicularPt1.geometry.coordinates,
+          perpendicularPt2.geometry.coordinates
+        ]),
+        _helpers.lineString.call(void 0, [start.geometry.coordinates, stop.geometry.coordinates])
+      );
+      let intersectPt;
+      if (intersect.features.length > 0 && intersect.features[0]) {
+        intersectPt = __spreadProps(__spreadValues({}, intersect.features[0]), {
+          properties: {
+            dist: _distance.distance.call(void 0, pt, intersect.features[0], options),
+            location: length + _distance.distance.call(void 0, start, intersect.features[0], options)
+          }
+        });
+      }
+      if (start.properties.dist < closestPt.properties.dist) {
+        closestPt = __spreadProps(__spreadValues({}, start), {
+          properties: __spreadProps(__spreadValues({}, start.properties), { index: i, location: length })
+        });
+      }
+      if (stop.properties.dist < closestPt.properties.dist) {
+        closestPt = __spreadProps(__spreadValues({}, stop), {
+          properties: __spreadProps(__spreadValues({}, stop.properties), {
+            index: i + 1,
+            location: length + sectionLength
+          })
+        });
+      }
+      if (intersectPt && intersectPt.properties.dist < closestPt.properties.dist) {
+        closestPt = __spreadProps(__spreadValues({}, intersectPt), {
+          properties: __spreadProps(__spreadValues({}, intersectPt.properties), { index: i })
+        });
+      }
+      length += sectionLength;
+    }
+  });
+  return closestPt;
+}
+__name(nearestPointOnLine, "nearestPointOnLine");
+var turf_nearest_point_on_line_default = nearestPointOnLine;
+
+
+
+exports.default = turf_nearest_point_on_line_default; exports.nearestPointOnLine = nearestPointOnLine;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AACA,SAAS,eAAe;AACxB,SAAS,gBAAgB;AACzB,SAAS,mBAAmB;AAC5B,SAAS,iBAAiB,sBAAsB;AAChD,SAAS,mBAAmB;AAC5B,SAAS,OAAO,kBAAgC;AAChD,SAAS,iBAAiB;AA4B1B,SAAS,mBACP,OACA,IACA,UAA6B,CAAC,GAS9B;AACA,MAAI,CAAC,SAAS,CAAC,IAAI;AACjB,UAAM,IAAI,MAAM,qCAAqC;AAAA,EACvD;AAEA,MAAI,YAGA,MAAM,CAAC,UAAU,QAAQ,GAAG;AAAA,IAC9B,MAAM;AAAA,IACN,OAAO;AAAA,IACP,UAAU;AAAA,EACZ,CAAC;AAED,MAAI,SAAS;AACb,cAAY,OAAO,SAAU,MAAW;AACtC,UAAM,SAAc,UAAU,IAAI;AAElC,aAAS,IAAI,GAAG,IAAI,OAAO,SAAS,GAAG,KAAK;AAE1C,YAAM,QAA0C,MAAM,OAAO,CAAC,CAAC;AAC/D,YAAM,WAAW,OAAO,SAAS,IAAI,OAAO,OAAO;AAEnD,YAAM,OAAyC,MAAM,OAAO,IAAI,CAAC,CAAC;AAClE,WAAK,WAAW,OAAO,SAAS,IAAI,MAAM,OAAO;AAEjD,YAAM,gBAAgB,SAAS,OAAO,MAAM,OAAO;AAEnD,YAAM,iBAAiB,KAAK;AAAA,QAC1B,MAAM,WAAW;AAAA,QACjB,KAAK,WAAW;AAAA,MAClB;AACA,YAAM,YAAY,QAAQ,OAAO,IAAI;AACrC,YAAM,mBAAmB;AAAA,QACvB;AAAA,QACA;AAAA,QACA,YAAY;AAAA,QACZ;AAAA,MACF;AACA,YAAM,mBAAmB;AAAA,QACvB;AAAA,QACA;AAAA,QACA,YAAY;AAAA,QACZ;AAAA,MACF;AACA,YAAM,YAAY;AAAA,QAChB,WAAW;AAAA,UACT,iBAAiB,SAAS;AAAA,UAC1B,iBAAiB,SAAS;AAAA,QAC5B,CAAC;AAAA,QACD,WAAW,CAAC,MAAM,SAAS,aAAa,KAAK,SAAS,WAAW,CAAC;AAAA,MACpE;AACA,UAAI;AAIJ,UAAI,UAAU,SAAS,SAAS,KAAK,UAAU,SAAS,CAAC,GAAG;AAC1D,sBAAc,iCACT,UAAU,SAAS,CAAC,IADX;AAAA,UAEZ,YAAY;AAAA,YACV,MAAM,SAAS,IAAI,UAAU,SAAS,CAAC,GAAG,OAAO;AAAA,YACjD,UAAU,SAAS,SAAS,OAAO,UAAU,SAAS,CAAC,GAAG,OAAO;AAAA,UACnE;AAAA,QACF;AAAA,MACF;AAEA,UAAI,MAAM,WAAW,OAAO,UAAU,WAAW,MAAM;AACrD,oBAAY,iCACP,QADO;AAAA,UAEV,YAAY,iCAAK,MAAM,aAAX,EAAuB,OAAO,GAAG,UAAU,OAAO;AAAA,QAChE;AAAA,MACF;AAEA,UAAI,KAAK,WAAW,OAAO,UAAU,WAAW,MAAM;AACpD,oBAAY,iCACP,OADO;AAAA,UAEV,YAAY,iCACP,KAAK,aADE;AAAA,YAEV,OAAO,IAAI;AAAA,YACX,UAAU,SAAS;AAAA,UACrB;AAAA,QACF;AAAA,MACF;AAEA,UACE,eACA,YAAY,WAAW,OAAO,UAAU,WAAW,MACnD;AACA,oBAAY,iCACP,cADO;AAAA,UAEV,YAAY,iCAAK,YAAY,aAAjB,EAA6B,OAAO,EAAE;AAAA,QACpD;AAAA,MACF;AAEA,gBAAU;AAAA,IACZ;AAAA,EACF,CAAC;AAED,SAAO;AACT;AA/GS;AAkHT,IAAO,qCAAQ","sourcesContent":["import { Feature, Point, LineString, MultiLineString } from \"geojson\";\nimport { bearing } from \"@turf/bearing\";\nimport { distance } from \"@turf/distance\";\nimport { destination } from \"@turf/destination\";\nimport { lineIntersect as lineIntersects } from \"@turf/line-intersect\";\nimport { flattenEach } from \"@turf/meta\";\nimport { point, lineString, Coord, Units } from \"@turf/helpers\";\nimport { getCoords } from \"@turf/invariant\";\n\n/**\n * Takes a {@link Point} and a {@link LineString} and calculates the closest Point on the (Multi)LineString.\n *\n * @name nearestPointOnLine\n * @param {Geometry|Feature<LineString|MultiLineString>} lines lines to snap to\n * @param {Geometry|Feature<Point>|number[]} pt point to snap from\n * @param {Object} [options={}] Optional parameters\n * @param {string} [options.units='kilometers'] can be degrees, radians, miles, or kilometers\n * @returns {Feature<Point>} closest point on the `line` to `point`. The properties object will contain three values: `index`: closest point was found on nth line part, `dist`: distance between pt and the closest point, `location`: distance along the line between start and the closest point.\n * @example\n * var line = turf.lineString([\n *     [-77.031669, 38.878605],\n *     [-77.029609, 38.881946],\n *     [-77.020339, 38.884084],\n *     [-77.025661, 38.885821],\n *     [-77.021884, 38.889563],\n *     [-77.019824, 38.892368]\n * ]);\n * var pt = turf.point([-77.037076, 38.884017]);\n *\n * var snapped = turf.nearestPointOnLine(line, pt, {units: 'miles'});\n *\n * //addToMap\n * var addToMap = [line, pt, snapped];\n * snapped.properties['marker-color'] = '#00f';\n */\nfunction nearestPointOnLine<G extends LineString | MultiLineString>(\n  lines: Feature<G> | G,\n  pt: Coord,\n  options: { units?: Units } = {}\n): Feature<\n  Point,\n  {\n    dist: number;\n    index: number;\n    location: number;\n    [key: string]: any;\n  }\n> {\n  if (!lines || !pt) {\n    throw new Error(\"lines and pt are required arguments\");\n  }\n\n  let closestPt: Feature<\n    Point,\n    { dist: number; index: number; location: number }\n  > = point([Infinity, Infinity], {\n    dist: Infinity,\n    index: -1,\n    location: -1,\n  });\n\n  let length = 0.0;\n  flattenEach(lines, function (line: any) {\n    const coords: any = getCoords(line);\n\n    for (let i = 0; i < coords.length - 1; i++) {\n      //start\n      const start: Feature<Point, { dist: number }> = point(coords[i]);\n      start.properties.dist = distance(pt, start, options);\n      //stop\n      const stop: Feature<Point, { dist: number }> = point(coords[i + 1]);\n      stop.properties.dist = distance(pt, stop, options);\n      // sectionLength\n      const sectionLength = distance(start, stop, options);\n      //perpendicular\n      const heightDistance = Math.max(\n        start.properties.dist,\n        stop.properties.dist\n      );\n      const direction = bearing(start, stop);\n      const perpendicularPt1 = destination(\n        pt,\n        heightDistance,\n        direction + 90,\n        options\n      );\n      const perpendicularPt2 = destination(\n        pt,\n        heightDistance,\n        direction - 90,\n        options\n      );\n      const intersect = lineIntersects(\n        lineString([\n          perpendicularPt1.geometry.coordinates,\n          perpendicularPt2.geometry.coordinates,\n        ]),\n        lineString([start.geometry.coordinates, stop.geometry.coordinates])\n      );\n      let intersectPt:\n        | Feature<Point, { dist: number; location: number }>\n        | undefined;\n\n      if (intersect.features.length > 0 && intersect.features[0]) {\n        intersectPt = {\n          ...intersect.features[0],\n          properties: {\n            dist: distance(pt, intersect.features[0], options),\n            location: length + distance(start, intersect.features[0], options),\n          },\n        };\n      }\n\n      if (start.properties.dist < closestPt.properties.dist) {\n        closestPt = {\n          ...start,\n          properties: { ...start.properties, index: i, location: length },\n        };\n      }\n\n      if (stop.properties.dist < closestPt.properties.dist) {\n        closestPt = {\n          ...stop,\n          properties: {\n            ...stop.properties,\n            index: i + 1,\n            location: length + sectionLength,\n          },\n        };\n      }\n\n      if (\n        intersectPt &&\n        intersectPt.properties.dist < closestPt.properties.dist\n      ) {\n        closestPt = {\n          ...intersectPt,\n          properties: { ...intersectPt.properties, index: i },\n        };\n      }\n      // update length\n      length += sectionLength;\n    }\n  });\n\n  return closestPt;\n}\n\nexport { nearestPointOnLine };\nexport default nearestPointOnLine;\n"]}

package/dist/{js → cjs}/index.d.ts

@@ -1,5 +1,6 @@
-import { Feature, Point, LineString, MultiLineString } from "geojson";
-import { Coord, Units } from "@turf/helpers";
+import { LineString, MultiLineString, Feature, Point } from 'geojson';
+import { Coord, Units } from '@turf/helpers';
+
 /**
  * Takes a {@link Point} and a {@link LineString} and calculates the closest Point on the (Multi)LineString.
  *
@@ -34,4 +35,5 @@ declare function nearestPointOnLine<G extends LineString | MultiLineString>(line
     location: number;
     [key: string]: any;
 }>;
-export default nearestPointOnLine;
+
+export { nearestPointOnLine as default, nearestPointOnLine };

package/dist/esm/index.d.mts

@@ -0,0 +1,39 @@
+import { LineString, MultiLineString, Feature, Point } from 'geojson';
+import { Coord, Units } from '@turf/helpers';
+
+/**
+ * Takes a {@link Point} and a {@link LineString} and calculates the closest Point on the (Multi)LineString.
+ *
+ * @name nearestPointOnLine
+ * @param {Geometry|Feature<LineString|MultiLineString>} lines lines to snap to
+ * @param {Geometry|Feature<Point>|number[]} pt point to snap from
+ * @param {Object} [options={}] Optional parameters
+ * @param {string} [options.units='kilometers'] can be degrees, radians, miles, or kilometers
+ * @returns {Feature<Point>} closest point on the `line` to `point`. The properties object will contain three values: `index`: closest point was found on nth line part, `dist`: distance between pt and the closest point, `location`: distance along the line between start and the closest point.
+ * @example
+ * var line = turf.lineString([
+ *     [-77.031669, 38.878605],
+ *     [-77.029609, 38.881946],
+ *     [-77.020339, 38.884084],
+ *     [-77.025661, 38.885821],
+ *     [-77.021884, 38.889563],
+ *     [-77.019824, 38.892368]
+ * ]);
+ * var pt = turf.point([-77.037076, 38.884017]);
+ *
+ * var snapped = turf.nearestPointOnLine(line, pt, {units: 'miles'});
+ *
+ * //addToMap
+ * var addToMap = [line, pt, snapped];
+ * snapped.properties['marker-color'] = '#00f';
+ */
+declare function nearestPointOnLine<G extends LineString | MultiLineString>(lines: Feature<G> | G, pt: Coord, options?: {
+    units?: Units;
+}): Feature<Point, {
+    dist: number;
+    index: number;
+    location: number;
+    [key: string]: any;
+}>;
+
+export { nearestPointOnLine as default, nearestPointOnLine };

package/dist/esm/index.mjs

@@ -0,0 +1,110 @@
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.ts
+import { bearing } from "@turf/bearing";
+import { distance } from "@turf/distance";
+import { destination } from "@turf/destination";
+import { lineIntersect as lineIntersects } from "@turf/line-intersect";
+import { flattenEach } from "@turf/meta";
+import { point, lineString } from "@turf/helpers";
+import { getCoords } from "@turf/invariant";
+function nearestPointOnLine(lines, pt, options = {}) {
+  if (!lines || !pt) {
+    throw new Error("lines and pt are required arguments");
+  }
+  let closestPt = point([Infinity, Infinity], {
+    dist: Infinity,
+    index: -1,
+    location: -1
+  });
+  let length = 0;
+  flattenEach(lines, function(line) {
+    const coords = getCoords(line);
+    for (let i = 0; i < coords.length - 1; i++) {
+      const start = point(coords[i]);
+      start.properties.dist = distance(pt, start, options);
+      const stop = point(coords[i + 1]);
+      stop.properties.dist = distance(pt, stop, options);
+      const sectionLength = distance(start, stop, options);
+      const heightDistance = Math.max(
+        start.properties.dist,
+        stop.properties.dist
+      );
+      const direction = bearing(start, stop);
+      const perpendicularPt1 = destination(
+        pt,
+        heightDistance,
+        direction + 90,
+        options
+      );
+      const perpendicularPt2 = destination(
+        pt,
+        heightDistance,
+        direction - 90,
+        options
+      );
+      const intersect = lineIntersects(
+        lineString([
+          perpendicularPt1.geometry.coordinates,
+          perpendicularPt2.geometry.coordinates
+        ]),
+        lineString([start.geometry.coordinates, stop.geometry.coordinates])
+      );
+      let intersectPt;
+      if (intersect.features.length > 0 && intersect.features[0]) {
+        intersectPt = __spreadProps(__spreadValues({}, intersect.features[0]), {
+          properties: {
+            dist: distance(pt, intersect.features[0], options),
+            location: length + distance(start, intersect.features[0], options)
+          }
+        });
+      }
+      if (start.properties.dist < closestPt.properties.dist) {
+        closestPt = __spreadProps(__spreadValues({}, start), {
+          properties: __spreadProps(__spreadValues({}, start.properties), { index: i, location: length })
+        });
+      }
+      if (stop.properties.dist < closestPt.properties.dist) {
+        closestPt = __spreadProps(__spreadValues({}, stop), {
+          properties: __spreadProps(__spreadValues({}, stop.properties), {
+            index: i + 1,
+            location: length + sectionLength
+          })
+        });
+      }
+      if (intersectPt && intersectPt.properties.dist < closestPt.properties.dist) {
+        closestPt = __spreadProps(__spreadValues({}, intersectPt), {
+          properties: __spreadProps(__spreadValues({}, intersectPt.properties), { index: i })
+        });
+      }
+      length += sectionLength;
+    }
+  });
+  return closestPt;
+}
+__name(nearestPointOnLine, "nearestPointOnLine");
+var turf_nearest_point_on_line_default = nearestPointOnLine;
+export {
+  turf_nearest_point_on_line_default as default,
+  nearestPointOnLine
+};
+//# sourceMappingURL=index.mjs.map

package/dist/esm/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"sourcesContent":["import { Feature, Point, LineString, MultiLineString } from \"geojson\";\nimport { bearing } from \"@turf/bearing\";\nimport { distance } from \"@turf/distance\";\nimport { destination } from \"@turf/destination\";\nimport { lineIntersect as lineIntersects } from \"@turf/line-intersect\";\nimport { flattenEach } from \"@turf/meta\";\nimport { point, lineString, Coord, Units } from \"@turf/helpers\";\nimport { getCoords } from \"@turf/invariant\";\n\n/**\n * Takes a {@link Point} and a {@link LineString} and calculates the closest Point on the (Multi)LineString.\n *\n * @name nearestPointOnLine\n * @param {Geometry|Feature<LineString|MultiLineString>} lines lines to snap to\n * @param {Geometry|Feature<Point>|number[]} pt point to snap from\n * @param {Object} [options={}] Optional parameters\n * @param {string} [options.units='kilometers'] can be degrees, radians, miles, or kilometers\n * @returns {Feature<Point>} closest point on the `line` to `point`. The properties object will contain three values: `index`: closest point was found on nth line part, `dist`: distance between pt and the closest point, `location`: distance along the line between start and the closest point.\n * @example\n * var line = turf.lineString([\n *     [-77.031669, 38.878605],\n *     [-77.029609, 38.881946],\n *     [-77.020339, 38.884084],\n *     [-77.025661, 38.885821],\n *     [-77.021884, 38.889563],\n *     [-77.019824, 38.892368]\n * ]);\n * var pt = turf.point([-77.037076, 38.884017]);\n *\n * var snapped = turf.nearestPointOnLine(line, pt, {units: 'miles'});\n *\n * //addToMap\n * var addToMap = [line, pt, snapped];\n * snapped.properties['marker-color'] = '#00f';\n */\nfunction nearestPointOnLine<G extends LineString | MultiLineString>(\n  lines: Feature<G> | G,\n  pt: Coord,\n  options: { units?: Units } = {}\n): Feature<\n  Point,\n  {\n    dist: number;\n    index: number;\n    location: number;\n    [key: string]: any;\n  }\n> {\n  if (!lines || !pt) {\n    throw new Error(\"lines and pt are required arguments\");\n  }\n\n  let closestPt: Feature<\n    Point,\n    { dist: number; index: number; location: number }\n  > = point([Infinity, Infinity], {\n    dist: Infinity,\n    index: -1,\n    location: -1,\n  });\n\n  let length = 0.0;\n  flattenEach(lines, function (line: any) {\n    const coords: any = getCoords(line);\n\n    for (let i = 0; i < coords.length - 1; i++) {\n      //start\n      const start: Feature<Point, { dist: number }> = point(coords[i]);\n      start.properties.dist = distance(pt, start, options);\n      //stop\n      const stop: Feature<Point, { dist: number }> = point(coords[i + 1]);\n      stop.properties.dist = distance(pt, stop, options);\n      // sectionLength\n      const sectionLength = distance(start, stop, options);\n      //perpendicular\n      const heightDistance = Math.max(\n        start.properties.dist,\n        stop.properties.dist\n      );\n      const direction = bearing(start, stop);\n      const perpendicularPt1 = destination(\n        pt,\n        heightDistance,\n        direction + 90,\n        options\n      );\n      const perpendicularPt2 = destination(\n        pt,\n        heightDistance,\n        direction - 90,\n        options\n      );\n      const intersect = lineIntersects(\n        lineString([\n          perpendicularPt1.geometry.coordinates,\n          perpendicularPt2.geometry.coordinates,\n        ]),\n        lineString([start.geometry.coordinates, stop.geometry.coordinates])\n      );\n      let intersectPt:\n        | Feature<Point, { dist: number; location: number }>\n        | undefined;\n\n      if (intersect.features.length > 0 && intersect.features[0]) {\n        intersectPt = {\n          ...intersect.features[0],\n          properties: {\n            dist: distance(pt, intersect.features[0], options),\n            location: length + distance(start, intersect.features[0], options),\n          },\n        };\n      }\n\n      if (start.properties.dist < closestPt.properties.dist) {\n        closestPt = {\n          ...start,\n          properties: { ...start.properties, index: i, location: length },\n        };\n      }\n\n      if (stop.properties.dist < closestPt.properties.dist) {\n        closestPt = {\n          ...stop,\n          properties: {\n            ...stop.properties,\n            index: i + 1,\n            location: length + sectionLength,\n          },\n        };\n      }\n\n      if (\n        intersectPt &&\n        intersectPt.properties.dist < closestPt.properties.dist\n      ) {\n        closestPt = {\n          ...intersectPt,\n          properties: { ...intersectPt.properties, index: i },\n        };\n      }\n      // update length\n      length += sectionLength;\n    }\n  });\n\n  return closestPt;\n}\n\nexport { nearestPointOnLine };\nexport default nearestPointOnLine;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AACA,SAAS,eAAe;AACxB,SAAS,gBAAgB;AACzB,SAAS,mBAAmB;AAC5B,SAAS,iBAAiB,sBAAsB;AAChD,SAAS,mBAAmB;AAC5B,SAAS,OAAO,kBAAgC;AAChD,SAAS,iBAAiB;AA4B1B,SAAS,mBACP,OACA,IACA,UAA6B,CAAC,GAS9B;AACA,MAAI,CAAC,SAAS,CAAC,IAAI;AACjB,UAAM,IAAI,MAAM,qCAAqC;AAAA,EACvD;AAEA,MAAI,YAGA,MAAM,CAAC,UAAU,QAAQ,GAAG;AAAA,IAC9B,MAAM;AAAA,IACN,OAAO;AAAA,IACP,UAAU;AAAA,EACZ,CAAC;AAED,MAAI,SAAS;AACb,cAAY,OAAO,SAAU,MAAW;AACtC,UAAM,SAAc,UAAU,IAAI;AAElC,aAAS,IAAI,GAAG,IAAI,OAAO,SAAS,GAAG,KAAK;AAE1C,YAAM,QAA0C,MAAM,OAAO,CAAC,CAAC;AAC/D,YAAM,WAAW,OAAO,SAAS,IAAI,OAAO,OAAO;AAEnD,YAAM,OAAyC,MAAM,OAAO,IAAI,CAAC,CAAC;AAClE,WAAK,WAAW,OAAO,SAAS,IAAI,MAAM,OAAO;AAEjD,YAAM,gBAAgB,SAAS,OAAO,MAAM,OAAO;AAEnD,YAAM,iBAAiB,KAAK;AAAA,QAC1B,MAAM,WAAW;AAAA,QACjB,KAAK,WAAW;AAAA,MAClB;AACA,YAAM,YAAY,QAAQ,OAAO,IAAI;AACrC,YAAM,mBAAmB;AAAA,QACvB;AAAA,QACA;AAAA,QACA,YAAY;AAAA,QACZ;AAAA,MACF;AACA,YAAM,mBAAmB;AAAA,QACvB;AAAA,QACA;AAAA,QACA,YAAY;AAAA,QACZ;AAAA,MACF;AACA,YAAM,YAAY;AAAA,QAChB,WAAW;AAAA,UACT,iBAAiB,SAAS;AAAA,UAC1B,iBAAiB,SAAS;AAAA,QAC5B,CAAC;AAAA,QACD,WAAW,CAAC,MAAM,SAAS,aAAa,KAAK,SAAS,WAAW,CAAC;AAAA,MACpE;AACA,UAAI;AAIJ,UAAI,UAAU,SAAS,SAAS,KAAK,UAAU,SAAS,CAAC,GAAG;AAC1D,sBAAc,iCACT,UAAU,SAAS,CAAC,IADX;AAAA,UAEZ,YAAY;AAAA,YACV,MAAM,SAAS,IAAI,UAAU,SAAS,CAAC,GAAG,OAAO;AAAA,YACjD,UAAU,SAAS,SAAS,OAAO,UAAU,SAAS,CAAC,GAAG,OAAO;AAAA,UACnE;AAAA,QACF;AAAA,MACF;AAEA,UAAI,MAAM,WAAW,OAAO,UAAU,WAAW,MAAM;AACrD,oBAAY,iCACP,QADO;AAAA,UAEV,YAAY,iCAAK,MAAM,aAAX,EAAuB,OAAO,GAAG,UAAU,OAAO;AAAA,QAChE;AAAA,MACF;AAEA,UAAI,KAAK,WAAW,OAAO,UAAU,WAAW,MAAM;AACpD,oBAAY,iCACP,OADO;AAAA,UAEV,YAAY,iCACP,KAAK,aADE;AAAA,YAEV,OAAO,IAAI;AAAA,YACX,UAAU,SAAS;AAAA,UACrB;AAAA,QACF;AAAA,MACF;AAEA,UACE,eACA,YAAY,WAAW,OAAO,UAAU,WAAW,MACnD;AACA,oBAAY,iCACP,cADO;AAAA,UAEV,YAAY,iCAAK,YAAY,aAAjB,EAA6B,OAAO,EAAE;AAAA,QACpD;AAAA,MACF;AAEA,gBAAU;AAAA,IACZ;AAAA,EACF,CAAC;AAED,SAAO;AACT;AA/GS;AAkHT,IAAO,qCAAQ;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/nearest-point-on-line",
-  "version": "7.0.0-alpha.0",
+  "version": "7.0.0-alpha.110+1411d63a7",
   "description": "turf nearest-point-on-line module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -16,53 +16,58 @@
   "publishConfig": {
     "access": "public"
   },
-  "main": "dist/js/index.js",
-  "module": "dist/es/index.js",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.mjs",
+  "types": "dist/cjs/index.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "import": "./dist/es/index.js",
-      "require": "./dist/js/index.js"
+      "import": {
+        "types": "./dist/esm/index.d.mts",
+        "default": "./dist/esm/index.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.cjs"
+      }
     }
   },
-  "types": "dist/js/index.d.ts",
   "sideEffects": false,
   "files": [
     "dist"
   ],
   "scripts": {
-    "bench": "ts-node bench.js",
-    "build": "npm-run-all build:*",
-    "build:es": "tsc --outDir dist/es --module esnext --declaration false && echo '{\"type\":\"module\"}' > dist/es/package.json",
-    "build:js": "tsc",
-    "docs": "node ../../scripts/generate-readmes",
-    "test": "npm-run-all test:*",
-    "test:tape": "ts-node -r esm test.js",
+    "bench": "tsx bench.ts",
+    "build": "tsup --config ../../tsup.config.ts",
+    "docs": "tsx ../../scripts/generate-readmes.ts",
+    "test": "npm-run-all --npm-path npm test:*",
+    "test:tape": "tsx test.ts",
     "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
   },
   "devDependencies": {
-    "@turf/along": "^7.0.0-alpha.0",
-    "@turf/length": "^7.0.0-alpha.0",
-    "@turf/truncate": "^7.0.0-alpha.0",
-    "@types/tape": "*",
-    "benchmark": "*",
-    "load-json-file": "*",
-    "npm-run-all": "*",
-    "tape": "*",
-    "ts-node": "*",
-    "tslint": "*",
-    "typescript": "*",
-    "write-json-file": "*"
+    "@turf/along": "^7.0.0-alpha.110+1411d63a7",
+    "@turf/length": "^7.0.0-alpha.110+1411d63a7",
+    "@turf/truncate": "^7.0.0-alpha.110+1411d63a7",
+    "@types/benchmark": "^2.1.5",
+    "@types/tape": "^4.2.32",
+    "benchmark": "^2.1.4",
+    "load-json-file": "^7.0.1",
+    "npm-run-all": "^4.1.5",
+    "tape": "^5.7.2",
+    "tsup": "^8.0.1",
+    "tsx": "^4.6.2",
+    "typescript": "^5.2.2",
+    "write-json-file": "^5.0.0"
   },
   "dependencies": {
-    "@turf/bearing": "^7.0.0-alpha.0",
-    "@turf/destination": "^7.0.0-alpha.0",
-    "@turf/distance": "^7.0.0-alpha.0",
-    "@turf/helpers": "^7.0.0-alpha.0",
-    "@turf/invariant": "^7.0.0-alpha.0",
-    "@turf/line-intersect": "^7.0.0-alpha.0",
-    "@turf/meta": "^7.0.0-alpha.0",
-    "tslib": "^2.3.0"
+    "@turf/bearing": "^7.0.0-alpha.110+1411d63a7",
+    "@turf/destination": "^7.0.0-alpha.110+1411d63a7",
+    "@turf/distance": "^7.0.0-alpha.110+1411d63a7",
+    "@turf/helpers": "^7.0.0-alpha.110+1411d63a7",
+    "@turf/invariant": "^7.0.0-alpha.110+1411d63a7",
+    "@turf/line-intersect": "^7.0.0-alpha.110+1411d63a7",
+    "@turf/meta": "^7.0.0-alpha.110+1411d63a7",
+    "tslib": "^2.6.2"
   },
-  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
+  "gitHead": "1411d63a74c275c9216fe48e9d3cb2d48a359068"
 }

package/dist/es/index.js

@@ -1,87 +0,0 @@
-import bearing from "@turf/bearing";
-import distance from "@turf/distance";
-import destination from "@turf/destination";
-import lineIntersects from "@turf/line-intersect";
-import { flattenEach } from "@turf/meta";
-import { point, lineString } from "@turf/helpers";
-import { getCoords } from "@turf/invariant";
-/**
- * Takes a {@link Point} and a {@link LineString} and calculates the closest Point on the (Multi)LineString.
- *
- * @name nearestPointOnLine
- * @param {Geometry|Feature<LineString|MultiLineString>} lines lines to snap to
- * @param {Geometry|Feature<Point>|number[]} pt point to snap from
- * @param {Object} [options={}] Optional parameters
- * @param {string} [options.units='kilometers'] can be degrees, radians, miles, or kilometers
- * @returns {Feature<Point>} closest point on the `line` to `point`. The properties object will contain three values: `index`: closest point was found on nth line part, `dist`: distance between pt and the closest point, `location`: distance along the line between start and the closest point.
- * @example
- * var line = turf.lineString([
- *     [-77.031669, 38.878605],
- *     [-77.029609, 38.881946],
- *     [-77.020339, 38.884084],
- *     [-77.025661, 38.885821],
- *     [-77.021884, 38.889563],
- *     [-77.019824, 38.892368]
- * ]);
- * var pt = turf.point([-77.037076, 38.884017]);
- *
- * var snapped = turf.nearestPointOnLine(line, pt, {units: 'miles'});
- *
- * //addToMap
- * var addToMap = [line, pt, snapped];
- * snapped.properties['marker-color'] = '#00f';
- */
-function nearestPointOnLine(lines, pt, options = {}) {
-    if (!lines || !pt) {
-        throw new Error("lines and pt are required arguments");
-    }
-    let closestPt = point([Infinity, Infinity], {
-        dist: Infinity,
-        index: -1,
-        location: -1,
-    });
-    let length = 0.0;
-    flattenEach(lines, function (line) {
-        const coords = getCoords(line);
-        for (let i = 0; i < coords.length - 1; i++) {
-            //start
-            const start = point(coords[i]);
-            start.properties.dist = distance(pt, start, options);
-            //stop
-            const stop = point(coords[i + 1]);
-            stop.properties.dist = distance(pt, stop, options);
-            // sectionLength
-            const sectionLength = distance(start, stop, options);
-            //perpendicular
-            const heightDistance = Math.max(start.properties.dist, stop.properties.dist);
-            const direction = bearing(start, stop);
-            const perpendicularPt1 = destination(pt, heightDistance, direction + 90, options);
-            const perpendicularPt2 = destination(pt, heightDistance, direction - 90, options);
-            const intersect = lineIntersects(lineString([
-                perpendicularPt1.geometry.coordinates,
-                perpendicularPt2.geometry.coordinates,
-            ]), lineString([start.geometry.coordinates, stop.geometry.coordinates]));
-            let intersectPt;
-            if (intersect.features.length > 0 && intersect.features[0]) {
-                intersectPt = Object.assign(Object.assign({}, intersect.features[0]), { properties: {
-                        dist: distance(pt, intersect.features[0], options),
-                        location: length + distance(start, intersect.features[0], options),
-                    } });
-            }
-            if (start.properties.dist < closestPt.properties.dist) {
-                closestPt = Object.assign(Object.assign({}, start), { properties: Object.assign(Object.assign({}, start.properties), { index: i, location: length }) });
-            }
-            if (stop.properties.dist < closestPt.properties.dist) {
-                closestPt = Object.assign(Object.assign({}, stop), { properties: Object.assign(Object.assign({}, stop.properties), { index: i + 1, location: length + sectionLength }) });
-            }
-            if (intersectPt &&
-                intersectPt.properties.dist < closestPt.properties.dist) {
-                closestPt = Object.assign(Object.assign({}, intersectPt), { properties: Object.assign(Object.assign({}, intersectPt.properties), { index: i }) });
-            }
-            // update length
-            length += sectionLength;
-        }
-    });
-    return closestPt;
-}
-export default nearestPointOnLine;

package/dist/es/package.json

@@ -1 +0,0 @@
-{"type":"module"}

package/dist/js/index.js

@@ -1,90 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const bearing_1 = tslib_1.__importDefault(require("@turf/bearing"));
-const distance_1 = tslib_1.__importDefault(require("@turf/distance"));
-const destination_1 = tslib_1.__importDefault(require("@turf/destination"));
-const line_intersect_1 = tslib_1.__importDefault(require("@turf/line-intersect"));
-const meta_1 = require("@turf/meta");
-const helpers_1 = require("@turf/helpers");
-const invariant_1 = require("@turf/invariant");
-/**
- * Takes a {@link Point} and a {@link LineString} and calculates the closest Point on the (Multi)LineString.
- *
- * @name nearestPointOnLine
- * @param {Geometry|Feature<LineString|MultiLineString>} lines lines to snap to
- * @param {Geometry|Feature<Point>|number[]} pt point to snap from
- * @param {Object} [options={}] Optional parameters
- * @param {string} [options.units='kilometers'] can be degrees, radians, miles, or kilometers
- * @returns {Feature<Point>} closest point on the `line` to `point`. The properties object will contain three values: `index`: closest point was found on nth line part, `dist`: distance between pt and the closest point, `location`: distance along the line between start and the closest point.
- * @example
- * var line = turf.lineString([
- *     [-77.031669, 38.878605],
- *     [-77.029609, 38.881946],
- *     [-77.020339, 38.884084],
- *     [-77.025661, 38.885821],
- *     [-77.021884, 38.889563],
- *     [-77.019824, 38.892368]
- * ]);
- * var pt = turf.point([-77.037076, 38.884017]);
- *
- * var snapped = turf.nearestPointOnLine(line, pt, {units: 'miles'});
- *
- * //addToMap
- * var addToMap = [line, pt, snapped];
- * snapped.properties['marker-color'] = '#00f';
- */
-function nearestPointOnLine(lines, pt, options = {}) {
-    if (!lines || !pt) {
-        throw new Error("lines and pt are required arguments");
-    }
-    let closestPt = helpers_1.point([Infinity, Infinity], {
-        dist: Infinity,
-        index: -1,
-        location: -1,
-    });
-    let length = 0.0;
-    meta_1.flattenEach(lines, function (line) {
-        const coords = invariant_1.getCoords(line);
-        for (let i = 0; i < coords.length - 1; i++) {
-            //start
-            const start = helpers_1.point(coords[i]);
-            start.properties.dist = distance_1.default(pt, start, options);
-            //stop
-            const stop = helpers_1.point(coords[i + 1]);
-            stop.properties.dist = distance_1.default(pt, stop, options);
-            // sectionLength
-            const sectionLength = distance_1.default(start, stop, options);
-            //perpendicular
-            const heightDistance = Math.max(start.properties.dist, stop.properties.dist);
-            const direction = bearing_1.default(start, stop);
-            const perpendicularPt1 = destination_1.default(pt, heightDistance, direction + 90, options);
-            const perpendicularPt2 = destination_1.default(pt, heightDistance, direction - 90, options);
-            const intersect = line_intersect_1.default(helpers_1.lineString([
-                perpendicularPt1.geometry.coordinates,
-                perpendicularPt2.geometry.coordinates,
-            ]), helpers_1.lineString([start.geometry.coordinates, stop.geometry.coordinates]));
-            let intersectPt;
-            if (intersect.features.length > 0 && intersect.features[0]) {
-                intersectPt = Object.assign(Object.assign({}, intersect.features[0]), { properties: {
-                        dist: distance_1.default(pt, intersect.features[0], options),
-                        location: length + distance_1.default(start, intersect.features[0], options),
-                    } });
-            }
-            if (start.properties.dist < closestPt.properties.dist) {
-                closestPt = Object.assign(Object.assign({}, start), { properties: Object.assign(Object.assign({}, start.properties), { index: i, location: length }) });
-            }
-            if (stop.properties.dist < closestPt.properties.dist) {
-                closestPt = Object.assign(Object.assign({}, stop), { properties: Object.assign(Object.assign({}, stop.properties), { index: i + 1, location: length + sectionLength }) });
-            }
-            if (intersectPt &&
-                intersectPt.properties.dist < closestPt.properties.dist) {
-                closestPt = Object.assign(Object.assign({}, intersectPt), { properties: Object.assign(Object.assign({}, intersectPt.properties), { index: i }) });
-            }
-            // update length
-            length += sectionLength;
-        }
-    });
-    return closestPt;
-}
-exports.default = nearestPointOnLine;