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

package/README.md

@@ -13,6 +13,9 @@ is geodesic.
 
 *   `targetPoint` **[Coord][2]** the reference point
 *   `points` **[FeatureCollection][3]<[Point][4]>** against input point set
+*   `options` **[Object][5]** Optional parameters (optional, default `{}`)
+
+    *   `options.units` **[string][6]** the units of the numeric result (optional, default `'kilometers'`)
 
 ### Examples
 
@@ -31,7 +34,7 @@ var addToMap = [targetPoint, points, nearest];
 nearest.properties['marker-color'] = '#F00';
 ```
 
-Returns **[Feature][5]<[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]<[Point][4]>** the closest point in the set to the referen
 
 [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,7 +27,7 @@ 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");
@@ -34,7 +36,7 @@ function nearestPoint(targetPoint, points) {
     let minDist = Infinity;
     let bestFeatureIndex = 0;
     featureEach(points, (pt, featureIndex) => {
-        const distanceToPoint = distance(targetPoint, pt);
+        const distanceToPoint = distance(targetPoint, pt, options);
         if (distanceToPoint < minDist) {
             bestFeatureIndex = featureIndex;
             minDist = distanceToPoint;

package/dist/js/index.d.ts

@@ -1,5 +1,5 @@
 import { Feature, FeatureCollection, Point } from "geojson";
-import { Coord } from "@turf/helpers";
+import { Coord, Units } from "@turf/helpers";
 export interface NearestPoint extends Feature<Point> {
     properties: {
         featureIndex: number;
@@ -16,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"});
@@ -31,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

@@ -13,6 +13,8 @@ const 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"});
@@ -28,7 +30,7 @@ const 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");
@@ -37,7 +39,7 @@ function nearestPoint(targetPoint, points) {
     let minDist = Infinity;
     let bestFeatureIndex = 0;
     meta_1.featureEach(points, (pt, featureIndex) => {
-        const distanceToPoint = distance_1.default(targetPoint, pt);
+        const distanceToPoint = distance_1.default(targetPoint, pt, options);
         if (distanceToPoint < minDist) {
             bestFeatureIndex = featureIndex;
             minDist = distanceToPoint;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/nearest-point",
-  "version": "7.0.0-alpha.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,13 +40,13 @@
     "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:tape": "tsx test.js",
     "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
   },
   "devDependencies": {
@@ -53,16 +54,16 @@
     "benchmark": "*",
     "npm-run-all": "*",
     "tape": "*",
-    "ts-node": "*",
     "tslint": "*",
+    "tsx": "*",
     "typescript": "*"
   },
   "dependencies": {
-    "@turf/clone": "^7.0.0-alpha.0",
-    "@turf/distance": "^7.0.0-alpha.0",
-    "@turf/helpers": "^7.0.0-alpha.0",
-    "@turf/meta": "^7.0.0-alpha.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": "0edc4c491b999e5ace770a61e1cf549f7c004189"
+  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
 }