@turf/point-to-line-distance 6.5.0 → 7.0.0-alpha.1

package/README.md

@@ -7,15 +7,18 @@
 Returns the minimum distance between a [Point][1] and a [LineString][2], being the distance from a line the
 minimum distance between the point and any segment of the `LineString`.
 
-**Parameters**
+### Parameters
 
--   `pt` **([Feature][3]<[Point][4]> | [Array][5]<[number][6]>)** Feature or Geometry
--   `line` **[Feature][3]<[LineString][7]>** GeoJSON Feature or Geometry
--   `options` **[Object][8]** Optional parameters (optional, default `{}`)
-    -   `options.units` **[string][9]** can be anything supported by turf/convertLength, eg degrees, radians, miles, or kilometers (optional, default `'kilometers'`)
-    -   `options.method` **[string][9]** wehther to calculate the distance based on geodesic (spheroid) or planar (flat) method. Valid options are 'geodesic' or 'planar'. (optional, default `'geodesic'`)
+*   `pt` **([Feature][3]<[Point][4]> | [Array][5]<[number][6]>)** Feature or Geometry
+*   `line` **[Feature][3]<[LineString][7]>** GeoJSON Feature or Geometry
+*   `options` **[Object][8]** Optional parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.units` **[string][9]** can be anything supported by turf/convertLength
+        (ex: degrees, radians, miles, or kilometers) (optional, default `"kilometers"`)
+    *   `options.method` **[string][9]** wether to calculate the distance based on geodesic (spheroid) or
+        planar (flat) method. Valid options are 'geodesic' or 'planar'. (optional, default `"geodesic"`)
+
+### Examples
 
 ```javascript
 var pt = turf.point([0, 0]);

package/dist/es/index.js

@@ -1,4 +1,3 @@
-// Taken from http://geomalgorithms.com/a02-_lines.html
 import getDistance from "@turf/distance";
 import { convertLength, feature, lineString, point, } from "@turf/helpers";
 import { featureOf } from "@turf/invariant";
@@ -24,8 +23,7 @@ import getPlanarDistance from "@turf/rhumb-distance";
  * var distance = turf.pointToLineDistance(pt, line, {units: 'miles'});
  * //=69.11854715938406
  */
-function pointToLineDistance(pt, line, options) {
-    if (options === void 0) { options = {}; }
+function pointToLineDistance(pt, line, options = {}) {
     // Optional parameters
     if (!options.method) {
         options.method = "geodesic";
@@ -58,12 +56,12 @@ function pointToLineDistance(pt, line, options) {
     else {
         featureOf(line, "LineString", "line");
     }
-    var distance = Infinity;
-    var p = pt.geometry.coordinates;
-    segmentEach(line, function (segment) {
-        var a = segment.geometry.coordinates[0];
-        var b = segment.geometry.coordinates[1];
-        var d = distanceToSegment(p, a, b, options);
+    let distance = Infinity;
+    const p = pt.geometry.coordinates;
+    segmentEach(line, (segment) => {
+        const a = segment.geometry.coordinates[0];
+        const b = segment.geometry.coordinates[1];
+        const d = distanceToSegment(p, a, b, options);
         if (d < distance) {
             distance = d;
         }
@@ -81,18 +79,18 @@ function pointToLineDistance(pt, line, options) {
  * @returns {number} distance
  */
 function distanceToSegment(p, a, b, options) {
-    var v = [b[0] - a[0], b[1] - a[1]];
-    var w = [p[0] - a[0], p[1] - a[1]];
-    var c1 = dot(w, v);
+    const v = [b[0] - a[0], b[1] - a[1]];
+    const w = [p[0] - a[0], p[1] - a[1]];
+    const c1 = dot(w, v);
     if (c1 <= 0) {
         return calcDistance(p, a, { method: options.method, units: "degrees" });
     }
-    var c2 = dot(v, v);
+    const c2 = dot(v, v);
     if (c2 <= c1) {
         return calcDistance(p, b, { method: options.method, units: "degrees" });
     }
-    var b2 = c1 / c2;
-    var Pb = [a[0] + b2 * v[0], a[1] + b2 * v[1]];
+    const b2 = c1 / c2;
+    const Pb = [a[0] + b2 * v[0], a[1] + b2 * v[1]];
     return calcDistance(p, Pb, { method: options.method, units: "degrees" });
 }
 function dot(u, v) {

package/dist/js/index.d.ts

@@ -1,4 +1,5 @@
-import { Coord, Feature, LineString, Units } from "@turf/helpers";
+import { Feature, LineString } from "geojson";
+import { Coord, Units } from "@turf/helpers";
 /**
  * Returns the minimum distance between a {@link Point} and a {@link LineString}, being the distance from a line the
  * minimum distance between the point and any segment of the `LineString`.

package/dist/js/index.js

@@ -1,14 +1,11 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-// Taken from http://geomalgorithms.com/a02-_lines.html
-var distance_1 = __importDefault(require("@turf/distance"));
-var helpers_1 = require("@turf/helpers");
-var invariant_1 = require("@turf/invariant");
-var meta_1 = require("@turf/meta");
-var rhumb_distance_1 = __importDefault(require("@turf/rhumb-distance"));
+const tslib_1 = require("tslib");
+const distance_1 = tslib_1.__importDefault(require("@turf/distance"));
+const helpers_1 = require("@turf/helpers");
+const invariant_1 = require("@turf/invariant");
+const meta_1 = require("@turf/meta");
+const rhumb_distance_1 = tslib_1.__importDefault(require("@turf/rhumb-distance"));
 /**
  * Returns the minimum distance between a {@link Point} and a {@link LineString}, being the distance from a line the
  * minimum distance between the point and any segment of the `LineString`.
@@ -29,8 +26,7 @@ var rhumb_distance_1 = __importDefault(require("@turf/rhumb-distance"));
  * var distance = turf.pointToLineDistance(pt, line, {units: 'miles'});
  * //=69.11854715938406
  */
-function pointToLineDistance(pt, line, options) {
-    if (options === void 0) { options = {}; }
+function pointToLineDistance(pt, line, options = {}) {
     // Optional parameters
     if (!options.method) {
         options.method = "geodesic";
@@ -63,12 +59,12 @@ function pointToLineDistance(pt, line, options) {
     else {
         invariant_1.featureOf(line, "LineString", "line");
     }
-    var distance = Infinity;
-    var p = pt.geometry.coordinates;
-    meta_1.segmentEach(line, function (segment) {
-        var a = segment.geometry.coordinates[0];
-        var b = segment.geometry.coordinates[1];
-        var d = distanceToSegment(p, a, b, options);
+    let distance = Infinity;
+    const p = pt.geometry.coordinates;
+    meta_1.segmentEach(line, (segment) => {
+        const a = segment.geometry.coordinates[0];
+        const b = segment.geometry.coordinates[1];
+        const d = distanceToSegment(p, a, b, options);
         if (d < distance) {
             distance = d;
         }
@@ -86,18 +82,18 @@ function pointToLineDistance(pt, line, options) {
  * @returns {number} distance
  */
 function distanceToSegment(p, a, b, options) {
-    var v = [b[0] - a[0], b[1] - a[1]];
-    var w = [p[0] - a[0], p[1] - a[1]];
-    var c1 = dot(w, v);
+    const v = [b[0] - a[0], b[1] - a[1]];
+    const w = [p[0] - a[0], p[1] - a[1]];
+    const c1 = dot(w, v);
     if (c1 <= 0) {
         return calcDistance(p, a, { method: options.method, units: "degrees" });
     }
-    var c2 = dot(v, v);
+    const c2 = dot(v, v);
     if (c2 <= c1) {
         return calcDistance(p, b, { method: options.method, units: "degrees" });
     }
-    var b2 = c1 / c2;
-    var Pb = [a[0] + b2 * v[0], a[1] + b2 * v[1]];
+    const b2 = c1 / c2;
+    const Pb = [a[0] + b2 * v[0], a[1] + b2 * v[1]];
     return calcDistance(p, Pb, { method: options.method, units: "degrees" });
 }
 function dot(u, v) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/point-to-line-distance",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf point-to-line-distance module",
   "author": "Turf Authors",
   "contributors": [
@@ -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,36 +40,37 @@
     "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": {
-    "@turf/circle": "^6.5.0",
+    "@turf/circle": "^7.0.0-alpha.1",
     "@types/tape": "*",
     "benchmark": "*",
     "load-json-file": "*",
     "npm-run-all": "*",
     "tape": "*",
-    "ts-node": "*",
     "tslint": "*",
+    "tsx": "*",
     "typescript": "*",
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/bearing": "^6.5.0",
-    "@turf/distance": "^6.5.0",
-    "@turf/helpers": "^6.5.0",
-    "@turf/invariant": "^6.5.0",
-    "@turf/meta": "^6.5.0",
-    "@turf/projection": "^6.5.0",
-    "@turf/rhumb-bearing": "^6.5.0",
-    "@turf/rhumb-distance": "^6.5.0"
+    "@turf/bearing": "^7.0.0-alpha.1",
+    "@turf/distance": "^7.0.0-alpha.1",
+    "@turf/helpers": "^7.0.0-alpha.1",
+    "@turf/invariant": "^7.0.0-alpha.1",
+    "@turf/meta": "^7.0.0-alpha.1",
+    "@turf/projection": "^7.0.0-alpha.1",
+    "@turf/rhumb-bearing": "^7.0.0-alpha.1",
+    "@turf/rhumb-distance": "^7.0.0-alpha.1",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
 }