@turf/rhumb-distance 6.4.0 → 7.0.0-alpha.0

package/README.md

@@ -7,14 +7,15 @@
 Calculates the distance along a rhumb line between two [points][1] in degrees, radians,
 miles, or kilometers.
 
-**Parameters**
+### Parameters
 
--   `from` **[Coord][2]** origin point
--   `to` **[Coord][2]** destination point
--   `options` **[Object][3]?** Optional parameters
-    -   `options.units` **[string][4]** can be degrees, radians, miles, or kilometers (optional, default `"kilometers"`)
+*   `from` **[Coord][2]** origin point
+*   `to` **[Coord][2]** destination point
+*   `options` **[Object][3]?** Optional parameters
 
-**Examples**
+    *   `options.units` **[string][4]** can be degrees, radians, miles, or kilometers (optional, default `"kilometers"`)
+
+### Examples
 
 ```javascript
 var from = turf.point([-75.343, 39.984]);

package/dist/es/index.js

@@ -23,10 +23,9 @@ import { getCoord } from "@turf/invariant";
  * from.properties.distance = distance;
  * to.properties.distance = distance;
  */
-function rhumbDistance(from, to, options) {
-    if (options === void 0) { options = {}; }
-    var origin = getCoord(from);
-    var destination = getCoord(to);
+function rhumbDistance(from, to, options = {}) {
+    const origin = getCoord(from);
+    const destination = getCoord(to);
     // compensate the crossing of the 180th meridian (https://macwright.org/2016/09/26/the-180th-meridian.html)
     // solution from https://github.com/mapbox/mapbox-gl-js/issues/3250#issuecomment-294887678
     destination[0] +=
@@ -35,8 +34,8 @@ function rhumbDistance(from, to, options) {
             : origin[0] - destination[0] > 180
                 ? 360
                 : 0;
-    var distanceInMeters = calculateRhumbDistance(origin, destination);
-    var distance = convertLength(distanceInMeters, "meters", options.units);
+    const distanceInMeters = calculateRhumbDistance(origin, destination);
+    const distance = convertLength(distanceInMeters, "meters", options.units);
     return distance;
 }
 /**
@@ -63,22 +62,22 @@ function calculateRhumbDistance(origin, destination, radius) {
     // θ => theta
     radius = radius === undefined ? earthRadius : Number(radius);
     // see www.edwilliams.org/avform.htm#Rhumb
-    var R = radius;
-    var phi1 = (origin[1] * Math.PI) / 180;
-    var phi2 = (destination[1] * Math.PI) / 180;
-    var DeltaPhi = phi2 - phi1;
-    var DeltaLambda = (Math.abs(destination[0] - origin[0]) * Math.PI) / 180;
+    const R = radius;
+    const phi1 = (origin[1] * Math.PI) / 180;
+    const phi2 = (destination[1] * Math.PI) / 180;
+    const DeltaPhi = phi2 - phi1;
+    let DeltaLambda = (Math.abs(destination[0] - origin[0]) * Math.PI) / 180;
     // if dLon over 180° take shorter rhumb line across the anti-meridian:
     if (DeltaLambda > Math.PI) {
         DeltaLambda -= 2 * Math.PI;
     }
     // on Mercator projection, longitude distances shrink by latitude; q is the 'stretch factor'
     // q becomes ill-conditioned along E-W line (0/0); use empirical tolerance to avoid it
-    var DeltaPsi = Math.log(Math.tan(phi2 / 2 + Math.PI / 4) / Math.tan(phi1 / 2 + Math.PI / 4));
-    var q = Math.abs(DeltaPsi) > 10e-12 ? DeltaPhi / DeltaPsi : Math.cos(phi1);
+    const DeltaPsi = Math.log(Math.tan(phi2 / 2 + Math.PI / 4) / Math.tan(phi1 / 2 + Math.PI / 4));
+    const q = Math.abs(DeltaPsi) > 10e-12 ? DeltaPhi / DeltaPsi : Math.cos(phi1);
     // distance is pythagoras on 'stretched' Mercator projection
-    var delta = Math.sqrt(DeltaPhi * DeltaPhi + q * q * DeltaLambda * DeltaLambda); // angular distance in radians
-    var dist = delta * R;
+    const delta = Math.sqrt(DeltaPhi * DeltaPhi + q * q * DeltaLambda * DeltaLambda); // angular distance in radians
+    const dist = delta * R;
     return dist;
 }
 export default rhumbDistance;

package/dist/js/index.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 // https://en.wikipedia.org/wiki/Rhumb_line
-var helpers_1 = require("@turf/helpers");
-var invariant_1 = require("@turf/invariant");
+const helpers_1 = require("@turf/helpers");
+const invariant_1 = require("@turf/invariant");
 /**
  * Calculates the distance along a rhumb line between two {@link Point|points} in degrees, radians,
  * miles, or kilometers.
@@ -25,10 +25,9 @@ var invariant_1 = require("@turf/invariant");
  * from.properties.distance = distance;
  * to.properties.distance = distance;
  */
-function rhumbDistance(from, to, options) {
-    if (options === void 0) { options = {}; }
-    var origin = invariant_1.getCoord(from);
-    var destination = invariant_1.getCoord(to);
+function rhumbDistance(from, to, options = {}) {
+    const origin = invariant_1.getCoord(from);
+    const destination = invariant_1.getCoord(to);
     // compensate the crossing of the 180th meridian (https://macwright.org/2016/09/26/the-180th-meridian.html)
     // solution from https://github.com/mapbox/mapbox-gl-js/issues/3250#issuecomment-294887678
     destination[0] +=
@@ -37,8 +36,8 @@ function rhumbDistance(from, to, options) {
             : origin[0] - destination[0] > 180
                 ? 360
                 : 0;
-    var distanceInMeters = calculateRhumbDistance(origin, destination);
-    var distance = helpers_1.convertLength(distanceInMeters, "meters", options.units);
+    const distanceInMeters = calculateRhumbDistance(origin, destination);
+    const distance = helpers_1.convertLength(distanceInMeters, "meters", options.units);
     return distance;
 }
 /**
@@ -65,22 +64,22 @@ function calculateRhumbDistance(origin, destination, radius) {
     // θ => theta
     radius = radius === undefined ? helpers_1.earthRadius : Number(radius);
     // see www.edwilliams.org/avform.htm#Rhumb
-    var R = radius;
-    var phi1 = (origin[1] * Math.PI) / 180;
-    var phi2 = (destination[1] * Math.PI) / 180;
-    var DeltaPhi = phi2 - phi1;
-    var DeltaLambda = (Math.abs(destination[0] - origin[0]) * Math.PI) / 180;
+    const R = radius;
+    const phi1 = (origin[1] * Math.PI) / 180;
+    const phi2 = (destination[1] * Math.PI) / 180;
+    const DeltaPhi = phi2 - phi1;
+    let DeltaLambda = (Math.abs(destination[0] - origin[0]) * Math.PI) / 180;
     // if dLon over 180° take shorter rhumb line across the anti-meridian:
     if (DeltaLambda > Math.PI) {
         DeltaLambda -= 2 * Math.PI;
     }
     // on Mercator projection, longitude distances shrink by latitude; q is the 'stretch factor'
     // q becomes ill-conditioned along E-W line (0/0); use empirical tolerance to avoid it
-    var DeltaPsi = Math.log(Math.tan(phi2 / 2 + Math.PI / 4) / Math.tan(phi1 / 2 + Math.PI / 4));
-    var q = Math.abs(DeltaPsi) > 10e-12 ? DeltaPhi / DeltaPsi : Math.cos(phi1);
+    const DeltaPsi = Math.log(Math.tan(phi2 / 2 + Math.PI / 4) / Math.tan(phi1 / 2 + Math.PI / 4));
+    const q = Math.abs(DeltaPsi) > 10e-12 ? DeltaPhi / DeltaPsi : Math.cos(phi1);
     // distance is pythagoras on 'stretched' Mercator projection
-    var delta = Math.sqrt(DeltaPhi * DeltaPhi + q * q * DeltaLambda * DeltaLambda); // angular distance in radians
-    var dist = delta * R;
+    const delta = Math.sqrt(DeltaPhi * DeltaPhi + q * q * DeltaLambda * DeltaLambda); // angular distance in radians
+    const dist = delta * R;
     return dist;
 }
 exports.default = rhumbDistance;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/rhumb-distance",
-  "version": "6.4.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf rhumb-distance module",
   "author": "Turf Authors",
   "contributors": [
@@ -17,6 +17,7 @@
     "type": "git",
     "url": "git://github.com/Turfjs/turf.git"
   },
+  "funding": "https://opencollective.com/turf",
   "publishConfig": {
     "access": "public"
   },
@@ -53,7 +54,7 @@
     "test:tape": "ts-node -r esm test.js"
   },
   "devDependencies": {
-    "@turf/distance": "^6.4.0",
+    "@turf/distance": "^7.0.0-alpha.0",
     "@types/tape": "*",
     "benchmark": "*",
     "load-json-file": "*",
@@ -65,8 +66,9 @@
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/helpers": "^6.4.0",
-    "@turf/invariant": "^6.4.0"
+    "@turf/helpers": "^7.0.0-alpha.0",
+    "@turf/invariant": "^7.0.0-alpha.0",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "1e62773cfc88c627cca8effcb5c14cfb65a905ac"
+  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
 }