@turf/nearest-point 7.0.0-alpha.1 → 7.0.0-alpha.111

package/README.md

@@ -50,26 +50,21 @@ Returns **[Feature][7]<[Point][4]>** the closest point in the set to the referen
 
 [7]: https://tools.ietf.org/html/rfc7946#section-3.2
 
-<!-- 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
 ```
 
-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,54 @@
+"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 _clone = require('@turf/clone');
+var _distance = require('@turf/distance');
+var _meta = require('@turf/meta');
+function nearestPoint(targetPoint, points, options = {}) {
+  if (!targetPoint)
+    throw new Error("targetPoint is required");
+  if (!points)
+    throw new Error("points is required");
+  let minDist = Infinity;
+  let bestFeatureIndex = 0;
+  _meta.featureEach.call(void 0, points, (pt, featureIndex) => {
+    const distanceToPoint = _distance.distance.call(void 0, targetPoint, pt, options);
+    if (distanceToPoint < minDist) {
+      bestFeatureIndex = featureIndex;
+      minDist = distanceToPoint;
+    }
+  });
+  const nearestPoint2 = _clone.clone.call(void 0, points.features[bestFeatureIndex]);
+  return __spreadProps(__spreadValues({}, nearestPoint2), {
+    properties: __spreadProps(__spreadValues({}, nearestPoint2.properties), {
+      featureIndex: bestFeatureIndex,
+      distanceToPoint: minDist
+    })
+  });
+}
+__name(nearestPoint, "nearestPoint");
+var turf_nearest_point_default = nearestPoint;
+
+
+
+exports.default = turf_nearest_point_default; exports.nearestPoint = nearestPoint;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"names":["nearestPoint"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAEA,SAAS,aAAa;AACtB,SAAS,gBAAgB;AACzB,SAAS,mBAAmB;AAoC5B,SAAS,aACP,aACA,QACA,UAEI,CAAC,GACS;AAEd,MAAI,CAAC;AAAa,UAAM,IAAI,MAAM,yBAAyB;AAC3D,MAAI,CAAC;AAAQ,UAAM,IAAI,MAAM,oBAAoB;AAEjD,MAAI,UAAU;AACd,MAAI,mBAAmB;AACvB,cAAY,QAAQ,CAAC,IAAI,iBAAiB;AACxC,UAAM,kBAAkB,SAAS,aAAa,IAAI,OAAO;AACzD,QAAI,kBAAkB,SAAS;AAC7B,yBAAmB;AACnB,gBAAU;AAAA,IACZ;AAAA,EACF,CAAC;AACD,QAAMA,gBAAe,MAAM,OAAO,SAAS,gBAAgB,CAAC;AAE5D,SAAO,iCACFA,gBADE;AAAA,IAEL,YAAY,iCACPA,cAAa,aADN;AAAA,MAEV,cAAc;AAAA,MACd,iBAAiB;AAAA,IACnB;AAAA,EACF;AACF;AA9BS;AAiCT,IAAO,6BAAQ","sourcesContent":["import { Feature, FeatureCollection, Point } from \"geojson\";\nimport { Coord, Units } from \"@turf/helpers\";\nimport { clone } from \"@turf/clone\";\nimport { distance } from \"@turf/distance\";\nimport { featureEach } from \"@turf/meta\";\n\ninterface NearestPoint extends Feature<Point> {\n  properties: {\n    featureIndex: number;\n    distanceToPoint: number;\n    [key: string]: any;\n  };\n}\n\n/**\n * Takes a reference {@link Point|point} and a FeatureCollection of Features\n * with Point geometries and returns the\n * point from the FeatureCollection closest to the reference. This calculation\n * is geodesic.\n *\n * @name nearestPoint\n * @param {Coord} targetPoint the reference point\n * @param {FeatureCollection<Point>} points against input point set\n * @param {Object} [options={}] Optional parameters\n * @param {string} [options.units='kilometers'] the units of the numeric result\n * @returns {Feature<Point>} the closest point in the set to the reference point\n * @example\n * var targetPoint = turf.point([28.965797, 41.010086], {\"marker-color\": \"#0F0\"});\n * var points = turf.featureCollection([\n *     turf.point([28.973865, 41.011122]),\n *     turf.point([28.948459, 41.024204]),\n *     turf.point([28.938674, 41.013324])\n * ]);\n *\n * var nearest = turf.nearestPoint(targetPoint, points);\n *\n * //addToMap\n * var addToMap = [targetPoint, points, nearest];\n * nearest.properties['marker-color'] = '#F00';\n */\nfunction nearestPoint(\n  targetPoint: Coord,\n  points: FeatureCollection<Point>,\n  options: {\n    units?: Units;\n  } = {}\n): NearestPoint {\n  // Input validation\n  if (!targetPoint) throw new Error(\"targetPoint is required\");\n  if (!points) throw new Error(\"points is required\");\n\n  let minDist = Infinity;\n  let bestFeatureIndex = 0;\n  featureEach(points, (pt, featureIndex) => {\n    const distanceToPoint = distance(targetPoint, pt, options);\n    if (distanceToPoint < minDist) {\n      bestFeatureIndex = featureIndex;\n      minDist = distanceToPoint;\n    }\n  });\n  const nearestPoint = clone(points.features[bestFeatureIndex]);\n\n  return {\n    ...nearestPoint,\n    properties: {\n      ...nearestPoint.properties,\n      featureIndex: bestFeatureIndex,\n      distanceToPoint: minDist,\n    },\n  };\n}\n\nexport { nearestPoint, NearestPoint };\nexport default nearestPoint;\n"]}

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

@@ -1,6 +1,7 @@
-import { Feature, FeatureCollection, Point } from "geojson";
-import { Coord, Units } from "@turf/helpers";
-export interface NearestPoint extends Feature<Point> {
+import { Feature, Point, FeatureCollection } from 'geojson';
+import { Coord, Units } from '@turf/helpers';
+
+interface NearestPoint extends Feature<Point> {
     properties: {
         featureIndex: number;
         distanceToPoint: number;
@@ -36,4 +37,5 @@ export interface NearestPoint extends Feature<Point> {
 declare function nearestPoint(targetPoint: Coord, points: FeatureCollection<Point>, options?: {
     units?: Units;
 }): NearestPoint;
-export default nearestPoint;
+
+export { type NearestPoint, nearestPoint as default, nearestPoint };

package/dist/{es/index.js → esm/index.d.mts}

@@ -1,6 +1,13 @@
-import clone from "@turf/clone";
-import distance from "@turf/distance";
-import { featureEach } from "@turf/meta";
+import { Feature, Point, FeatureCollection } from 'geojson';
+import { Coord, Units } from '@turf/helpers';
+
+interface NearestPoint extends Feature<Point> {
+    properties: {
+        featureIndex: number;
+        distanceToPoint: number;
+        [key: string]: any;
+    };
+}
 /**
  * Takes a reference {@link Point|point} and a FeatureCollection of Features
  * with Point geometries and returns the
@@ -27,22 +34,8 @@ import { featureEach } from "@turf/meta";
  * var addToMap = [targetPoint, points, nearest];
  * nearest.properties['marker-color'] = '#F00';
  */
-function nearestPoint(targetPoint, points, options = {}) {
-    // Input validation
-    if (!targetPoint)
-        throw new Error("targetPoint is required");
-    if (!points)
-        throw new Error("points is required");
-    let minDist = Infinity;
-    let bestFeatureIndex = 0;
-    featureEach(points, (pt, featureIndex) => {
-        const distanceToPoint = distance(targetPoint, pt, options);
-        if (distanceToPoint < minDist) {
-            bestFeatureIndex = featureIndex;
-            minDist = distanceToPoint;
-        }
-    });
-    const nearestPoint = clone(points.features[bestFeatureIndex]);
-    return Object.assign(Object.assign({}, nearestPoint), { properties: Object.assign(Object.assign({}, nearestPoint.properties), { featureIndex: bestFeatureIndex, distanceToPoint: minDist }) });
-}
-export default nearestPoint;
+declare function nearestPoint(targetPoint: Coord, points: FeatureCollection<Point>, options?: {
+    units?: Units;
+}): NearestPoint;
+
+export { type NearestPoint, nearestPoint as default, nearestPoint };

package/dist/esm/index.mjs

@@ -0,0 +1,54 @@
+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 { clone } from "@turf/clone";
+import { distance } from "@turf/distance";
+import { featureEach } from "@turf/meta";
+function nearestPoint(targetPoint, points, options = {}) {
+  if (!targetPoint)
+    throw new Error("targetPoint is required");
+  if (!points)
+    throw new Error("points is required");
+  let minDist = Infinity;
+  let bestFeatureIndex = 0;
+  featureEach(points, (pt, featureIndex) => {
+    const distanceToPoint = distance(targetPoint, pt, options);
+    if (distanceToPoint < minDist) {
+      bestFeatureIndex = featureIndex;
+      minDist = distanceToPoint;
+    }
+  });
+  const nearestPoint2 = clone(points.features[bestFeatureIndex]);
+  return __spreadProps(__spreadValues({}, nearestPoint2), {
+    properties: __spreadProps(__spreadValues({}, nearestPoint2.properties), {
+      featureIndex: bestFeatureIndex,
+      distanceToPoint: minDist
+    })
+  });
+}
+__name(nearestPoint, "nearestPoint");
+var turf_nearest_point_default = nearestPoint;
+export {
+  turf_nearest_point_default as default,
+  nearestPoint
+};
+//# sourceMappingURL=index.mjs.map

package/dist/esm/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"sourcesContent":["import { Feature, FeatureCollection, Point } from \"geojson\";\nimport { Coord, Units } from \"@turf/helpers\";\nimport { clone } from \"@turf/clone\";\nimport { distance } from \"@turf/distance\";\nimport { featureEach } from \"@turf/meta\";\n\ninterface NearestPoint extends Feature<Point> {\n  properties: {\n    featureIndex: number;\n    distanceToPoint: number;\n    [key: string]: any;\n  };\n}\n\n/**\n * Takes a reference {@link Point|point} and a FeatureCollection of Features\n * with Point geometries and returns the\n * point from the FeatureCollection closest to the reference. This calculation\n * is geodesic.\n *\n * @name nearestPoint\n * @param {Coord} targetPoint the reference point\n * @param {FeatureCollection<Point>} points against input point set\n * @param {Object} [options={}] Optional parameters\n * @param {string} [options.units='kilometers'] the units of the numeric result\n * @returns {Feature<Point>} the closest point in the set to the reference point\n * @example\n * var targetPoint = turf.point([28.965797, 41.010086], {\"marker-color\": \"#0F0\"});\n * var points = turf.featureCollection([\n *     turf.point([28.973865, 41.011122]),\n *     turf.point([28.948459, 41.024204]),\n *     turf.point([28.938674, 41.013324])\n * ]);\n *\n * var nearest = turf.nearestPoint(targetPoint, points);\n *\n * //addToMap\n * var addToMap = [targetPoint, points, nearest];\n * nearest.properties['marker-color'] = '#F00';\n */\nfunction nearestPoint(\n  targetPoint: Coord,\n  points: FeatureCollection<Point>,\n  options: {\n    units?: Units;\n  } = {}\n): NearestPoint {\n  // Input validation\n  if (!targetPoint) throw new Error(\"targetPoint is required\");\n  if (!points) throw new Error(\"points is required\");\n\n  let minDist = Infinity;\n  let bestFeatureIndex = 0;\n  featureEach(points, (pt, featureIndex) => {\n    const distanceToPoint = distance(targetPoint, pt, options);\n    if (distanceToPoint < minDist) {\n      bestFeatureIndex = featureIndex;\n      minDist = distanceToPoint;\n    }\n  });\n  const nearestPoint = clone(points.features[bestFeatureIndex]);\n\n  return {\n    ...nearestPoint,\n    properties: {\n      ...nearestPoint.properties,\n      featureIndex: bestFeatureIndex,\n      distanceToPoint: minDist,\n    },\n  };\n}\n\nexport { nearestPoint, NearestPoint };\nexport default nearestPoint;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAEA,SAAS,aAAa;AACtB,SAAS,gBAAgB;AACzB,SAAS,mBAAmB;AAoC5B,SAAS,aACP,aACA,QACA,UAEI,CAAC,GACS;AAEd,MAAI,CAAC;AAAa,UAAM,IAAI,MAAM,yBAAyB;AAC3D,MAAI,CAAC;AAAQ,UAAM,IAAI,MAAM,oBAAoB;AAEjD,MAAI,UAAU;AACd,MAAI,mBAAmB;AACvB,cAAY,QAAQ,CAAC,IAAI,iBAAiB;AACxC,UAAM,kBAAkB,SAAS,aAAa,IAAI,OAAO;AACzD,QAAI,kBAAkB,SAAS;AAC7B,yBAAmB;AACnB,gBAAU;AAAA,IACZ;AAAA,EACF,CAAC;AACD,QAAMA,gBAAe,MAAM,OAAO,SAAS,gBAAgB,CAAC;AAE5D,SAAO,iCACFA,gBADE;AAAA,IAEL,YAAY,iCACPA,cAAa,aADN;AAAA,MAEV,cAAc;AAAA,MACd,iBAAiB;AAAA,IACnB;AAAA,EACF;AACF;AA9BS;AAiCT,IAAO,6BAAQ;","names":["nearestPoint"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/nearest-point",
-  "version": "7.0.0-alpha.1",
+  "version": "7.0.0-alpha.111+08576cb50",
   "description": "turf nearest-point module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -24,46 +24,51 @@
     "nearest",
     "point"
   ],
-  "main": "dist/js/index.js",
-  "module": "dist/es/index.js",
+  "type": "commonjs",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.mjs",
+  "types": "dist/cjs/index.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "types": "./dist/js/index.d.ts",
-      "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": "tsx 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": "tsx ../../scripts/generate-readmes",
-    "test": "npm-run-all test:*",
-    "test:tape": "tsx 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": {
-    "@types/tape": "*",
-    "benchmark": "*",
-    "npm-run-all": "*",
-    "tape": "*",
-    "tslint": "*",
-    "tsx": "*",
-    "typescript": "*"
+    "@types/benchmark": "^2.1.5",
+    "@types/tape": "^4.2.32",
+    "benchmark": "^2.1.4",
+    "npm-run-all": "^4.1.5",
+    "tape": "^5.7.2",
+    "tsup": "^8.0.1",
+    "tsx": "^4.6.2",
+    "typescript": "^5.2.2"
   },
   "dependencies": {
-    "@turf/clone": "^7.0.0-alpha.1",
-    "@turf/distance": "^7.0.0-alpha.1",
-    "@turf/helpers": "^7.0.0-alpha.1",
-    "@turf/meta": "^7.0.0-alpha.1",
-    "tslib": "^2.3.0"
+    "@turf/clone": "^7.0.0-alpha.111+08576cb50",
+    "@turf/distance": "^7.0.0-alpha.111+08576cb50",
+    "@turf/helpers": "^7.0.0-alpha.111+08576cb50",
+    "@turf/meta": "^7.0.0-alpha.111+08576cb50",
+    "tslib": "^2.6.2"
   },
-  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
+  "gitHead": "08576cb50376e0199aea02dbd887e3af83672246"
 }

package/dist/es/package.json

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

package/dist/js/index.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const clone_1 = tslib_1.__importDefault(require("@turf/clone"));
-const distance_1 = tslib_1.__importDefault(require("@turf/distance"));
-const meta_1 = require("@turf/meta");
-/**
- * Takes a reference {@link Point|point} and a FeatureCollection of Features
- * with Point geometries and returns the
- * point from the FeatureCollection closest to the reference. This calculation
- * is geodesic.
- *
- * @name nearestPoint
- * @param {Coord} targetPoint the reference point
- * @param {FeatureCollection<Point>} points against input point set
- * @param {Object} [options={}] Optional parameters
- * @param {string} [options.units='kilometers'] the units of the numeric result
- * @returns {Feature<Point>} the closest point in the set to the reference point
- * @example
- * var targetPoint = turf.point([28.965797, 41.010086], {"marker-color": "#0F0"});
- * var points = turf.featureCollection([
- *     turf.point([28.973865, 41.011122]),
- *     turf.point([28.948459, 41.024204]),
- *     turf.point([28.938674, 41.013324])
- * ]);
- *
- * var nearest = turf.nearestPoint(targetPoint, points);
- *
- * //addToMap
- * var addToMap = [targetPoint, points, nearest];
- * nearest.properties['marker-color'] = '#F00';
- */
-function nearestPoint(targetPoint, points, options = {}) {
-    // Input validation
-    if (!targetPoint)
-        throw new Error("targetPoint is required");
-    if (!points)
-        throw new Error("points is required");
-    let minDist = Infinity;
-    let bestFeatureIndex = 0;
-    meta_1.featureEach(points, (pt, featureIndex) => {
-        const distanceToPoint = distance_1.default(targetPoint, pt, options);
-        if (distanceToPoint < minDist) {
-            bestFeatureIndex = featureIndex;
-            minDist = distanceToPoint;
-        }
-    });
-    const nearestPoint = clone_1.default(points.features[bestFeatureIndex]);
-    return Object.assign(Object.assign({}, nearestPoint), { properties: Object.assign(Object.assign({}, nearestPoint.properties), { featureIndex: bestFeatureIndex, distanceToPoint: minDist }) });
-}
-exports.default = nearestPoint;