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

package/README.md

@@ -9,12 +9,15 @@ with Point geometries and returns the
 point from the FeatureCollection closest to the reference. This calculation
 is geodesic.
 
-**Parameters**
+### Parameters
 
--   `targetPoint` **[Coord][2]** the reference point
--   `points` **[FeatureCollection][3]<[Point][4]>** against input point set
+*   `targetPoint` **[Coord][2]** the reference point
+*   `points` **[FeatureCollection][3]<[Point][4]>** against input point set
+*   `options` **[Object][5]** Optional parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.units` **[string][6]** the units of the numeric result (optional, default `'kilometers'`)
+
+### Examples
 
 ```javascript
 var targetPoint = turf.point([28.965797, 41.010086], {"marker-color": "#0F0"});
@@ -31,7 +34,7 @@ var addToMap = [targetPoint, points, nearest];
 nearest.properties['marker-color'] = '#F00';
 ```
 
-Returns **[Feature][5]&lt;[Point][4]>** the closest point in the set to the reference point
+Returns **[Feature][7]<[Point][4]>** the closest point in the set to the reference point
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2
 
@@ -41,7 +44,11 @@ Returns **[Feature][5]&lt;[Point][4]>** the closest point in the set to the refe
 
 [4]: https://tools.ietf.org/html/rfc7946#section-3.1.2
 
-[5]: https://tools.ietf.org/html/rfc7946#section-3.2
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[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

package/dist/es/index.js

@@ -10,6 +10,8 @@ import { featureEach } from "@turf/meta";
  * @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"});
@@ -25,25 +27,22 @@ import { featureEach } from "@turf/meta";
  * var addToMap = [targetPoint, points, nearest];
  * nearest.properties['marker-color'] = '#F00';
  */
-function nearestPoint(targetPoint, points) {
+function nearestPoint(targetPoint, points, options = {}) {
     // Input validation
     if (!targetPoint)
         throw new Error("targetPoint is required");
     if (!points)
         throw new Error("points is required");
-    var nearest;
-    var minDist = Infinity;
-    var bestFeatureIndex = 0;
-    featureEach(points, function (pt, featureIndex) {
-        var distanceToPoint = distance(targetPoint, pt);
+    let minDist = Infinity;
+    let bestFeatureIndex = 0;
+    featureEach(points, (pt, featureIndex) => {
+        const distanceToPoint = distance(targetPoint, pt, options);
         if (distanceToPoint < minDist) {
             bestFeatureIndex = featureIndex;
             minDist = distanceToPoint;
         }
     });
-    nearest = clone(points.features[bestFeatureIndex]);
-    nearest.properties.featureIndex = bestFeatureIndex;
-    nearest.properties.distanceToPoint = minDist;
-    return nearest;
+    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;

package/dist/js/index.d.ts

@@ -1,4 +1,5 @@
-import { Coord, Feature, FeatureCollection, Point } from "@turf/helpers";
+import { Feature, FeatureCollection, Point } from "geojson";
+import { Coord, Units } from "@turf/helpers";
 export interface NearestPoint extends Feature<Point> {
     properties: {
         featureIndex: number;
@@ -15,6 +16,8 @@ export interface NearestPoint extends Feature<Point> {
  * @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"});
@@ -30,5 +33,7 @@ export interface NearestPoint extends Feature<Point> {
  * var addToMap = [targetPoint, points, nearest];
  * nearest.properties['marker-color'] = '#F00';
  */
-declare function nearestPoint(targetPoint: Coord, points: FeatureCollection<Point>): NearestPoint;
+declare function nearestPoint(targetPoint: Coord, points: FeatureCollection<Point>, options?: {
+    units?: Units;
+}): NearestPoint;
 export default nearestPoint;

package/dist/js/index.js

@@ -1,11 +1,9 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var clone_1 = __importDefault(require("@turf/clone"));
-var distance_1 = __importDefault(require("@turf/distance"));
-var meta_1 = require("@turf/meta");
+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
@@ -15,6 +13,8 @@ var meta_1 = require("@turf/meta");
  * @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"});
@@ -30,25 +30,22 @@ var meta_1 = require("@turf/meta");
  * var addToMap = [targetPoint, points, nearest];
  * nearest.properties['marker-color'] = '#F00';
  */
-function nearestPoint(targetPoint, points) {
+function nearestPoint(targetPoint, points, options = {}) {
     // Input validation
     if (!targetPoint)
         throw new Error("targetPoint is required");
     if (!points)
         throw new Error("points is required");
-    var nearest;
-    var minDist = Infinity;
-    var bestFeatureIndex = 0;
-    meta_1.featureEach(points, function (pt, featureIndex) {
-        var distanceToPoint = distance_1.default(targetPoint, pt);
+    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;
         }
     });
-    nearest = clone_1.default(points.features[bestFeatureIndex]);
-    nearest.properties.featureIndex = bestFeatureIndex;
-    nearest.properties.distanceToPoint = minDist;
-    return nearest;
+    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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/nearest-point",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf nearest-point module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -29,6 +29,7 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "types": "./dist/js/index.d.ts",
       "import": "./dist/es/index.js",
       "require": "./dist/js/index.js"
     }
@@ -39,29 +40,30 @@
     "dist"
   ],
   "scripts": {
-    "bench": "ts-node bench.js",
+    "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": "node ../../scripts/generate-readmes",
+    "docs": "tsx ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
-    "test:tape": "ts-node -r esm test.js",
-    "test:types": "tsc --esModuleInterop --noEmit types.ts"
+    "test:tape": "tsx test.js",
+    "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
   },
   "devDependencies": {
     "@types/tape": "*",
     "benchmark": "*",
     "npm-run-all": "*",
     "tape": "*",
-    "ts-node": "*",
     "tslint": "*",
+    "tsx": "*",
     "typescript": "*"
   },
   "dependencies": {
-    "@turf/clone": "^6.5.0",
-    "@turf/distance": "^6.5.0",
-    "@turf/helpers": "^6.5.0",
-    "@turf/meta": "^6.5.0"
+    "@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"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
 }