@turf/rhumb-destination 6.5.0 → 7.0.0-alpha.1

package/README.md

@@ -7,16 +7,17 @@
 Returns the destination [Point][1] having travelled the given distance along a Rhumb line from the
 origin Point with the (varant) given bearing.
 
-**Parameters**
+### Parameters
 
--   `origin` **[Coord][2]** starting point
--   `distance` **[number][3]** distance from the starting point
--   `bearing` **[number][3]** varant bearing angle ranging from -180 to 180 degrees from north
--   `options` **[Object][4]** Optional parameters (optional, default `{}`)
-    -   `options.units` **[string][5]** can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`)
-    -   `options.properties` **[Object][4]** translate properties to destination point (optional, default `{}`)
+*   `origin` **[Coord][2]** starting point
+*   `distance` **[number][3]** distance from the starting point
+*   `bearing` **[number][3]** varant bearing angle ranging from -180 to 180 degrees from north
+*   `options` **[Object][4]** Optional parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.units` **[string][5]** can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`)
+    *   `options.properties` **[Object][4]** translate properties to destination point (optional, default `{}`)
+
+### Examples
 
 ```javascript
 var pt = turf.point([-75.343, 39.984], {"marker-color": "F00"});
@@ -31,7 +32,7 @@ var addToMap = [pt, destination]
 destination.properties['marker-color'] = '#00F';
 ```
 
-Returns **[Feature][6]<[Point][7]>** Destination point.
+Returns **[Feature][6]<[Point][7]>** Destination point.
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2
 

package/dist/es/index.js

@@ -1,4 +1,3 @@
-// https://en.wikipedia.org/wiki/Rhumb_line
 import { convertLength, degreesToRadians, earthRadius, point, } from "@turf/helpers";
 import { getCoord } from "@turf/invariant";
 /**
@@ -25,14 +24,13 @@ import { getCoord } from "@turf/invariant";
  * var addToMap = [pt, destination]
  * destination.properties['marker-color'] = '#00F';
  */
-function rhumbDestination(origin, distance, bearing, options) {
-    if (options === void 0) { options = {}; }
-    var wasNegativeDistance = distance < 0;
-    var distanceInMeters = convertLength(Math.abs(distance), options.units, "meters");
+function rhumbDestination(origin, distance, bearing, options = {}) {
+    const wasNegativeDistance = distance < 0;
+    let distanceInMeters = convertLength(Math.abs(distance), options.units, "meters");
     if (wasNegativeDistance)
         distanceInMeters = -Math.abs(distanceInMeters);
-    var coords = getCoord(origin);
-    var destination = calculateRhumbDestination(coords, distanceInMeters, bearing);
+    const coords = getCoord(origin);
+    const destination = calculateRhumbDestination(coords, distanceInMeters, bearing);
     // 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] +=
@@ -63,21 +61,21 @@ function calculateRhumbDestination(origin, distance, bearing, radius) {
     // δ => delta
     // θ => theta
     radius = radius === undefined ? earthRadius : Number(radius);
-    var delta = distance / radius; // angular distance in radians
-    var lambda1 = (origin[0] * Math.PI) / 180; // to radians, but without normalize to 𝜋
-    var phi1 = degreesToRadians(origin[1]);
-    var theta = degreesToRadians(bearing);
-    var DeltaPhi = delta * Math.cos(theta);
-    var phi2 = phi1 + DeltaPhi;
+    const delta = distance / radius; // angular distance in radians
+    const lambda1 = (origin[0] * Math.PI) / 180; // to radians, but without normalize to 𝜋
+    const phi1 = degreesToRadians(origin[1]);
+    const theta = degreesToRadians(bearing);
+    const DeltaPhi = delta * Math.cos(theta);
+    let phi2 = phi1 + DeltaPhi;
     // check for some daft bugger going past the pole, normalise latitude if so
     if (Math.abs(phi2) > Math.PI / 2) {
         phi2 = phi2 > 0 ? Math.PI - phi2 : -Math.PI - phi2;
     }
-    var DeltaPsi = Math.log(Math.tan(phi2 / 2 + Math.PI / 4) / Math.tan(phi1 / 2 + Math.PI / 4));
+    const DeltaPsi = Math.log(Math.tan(phi2 / 2 + Math.PI / 4) / Math.tan(phi1 / 2 + Math.PI / 4));
     // E-W course becomes ill-conditioned with 0/0
-    var q = Math.abs(DeltaPsi) > 10e-12 ? DeltaPhi / DeltaPsi : Math.cos(phi1);
-    var DeltaLambda = (delta * Math.sin(theta)) / q;
-    var lambda2 = lambda1 + DeltaLambda;
+    const q = Math.abs(DeltaPsi) > 10e-12 ? DeltaPhi / DeltaPsi : Math.cos(phi1);
+    const DeltaLambda = (delta * Math.sin(theta)) / q;
+    const lambda2 = lambda1 + DeltaLambda;
     return [
         (((lambda2 * 180) / Math.PI + 540) % 360) - 180,
         (phi2 * 180) / Math.PI,

package/dist/js/index.d.ts

@@ -1,4 +1,5 @@
-import { Coord, Feature, Point, Properties, Units } from "@turf/helpers";
+import { Feature, Point, GeoJsonProperties } from "geojson";
+import { Coord, Units } from "@turf/helpers";
 /**
  * Returns the destination {@link Point} having travelled the given distance along a Rhumb line from the
  * origin Point with the (varant) given bearing.
@@ -23,7 +24,7 @@ import { Coord, Feature, Point, Properties, Units } from "@turf/helpers";
  * var addToMap = [pt, destination]
  * destination.properties['marker-color'] = '#00F';
  */
-declare function rhumbDestination<P = Properties>(origin: Coord, distance: number, bearing: number, options?: {
+declare function rhumbDestination<P = GeoJsonProperties>(origin: Coord, distance: number, bearing: number, options?: {
     units?: Units;
     properties?: P;
 }): Feature<Point, P>;

package/dist/js/index.js

@@ -1,8 +1,7 @@
 "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");
 /**
  * Returns the destination {@link Point} having travelled the given distance along a Rhumb line from the
  * origin Point with the (varant) given bearing.
@@ -27,14 +26,13 @@ var invariant_1 = require("@turf/invariant");
  * var addToMap = [pt, destination]
  * destination.properties['marker-color'] = '#00F';
  */
-function rhumbDestination(origin, distance, bearing, options) {
-    if (options === void 0) { options = {}; }
-    var wasNegativeDistance = distance < 0;
-    var distanceInMeters = helpers_1.convertLength(Math.abs(distance), options.units, "meters");
+function rhumbDestination(origin, distance, bearing, options = {}) {
+    const wasNegativeDistance = distance < 0;
+    let distanceInMeters = helpers_1.convertLength(Math.abs(distance), options.units, "meters");
     if (wasNegativeDistance)
         distanceInMeters = -Math.abs(distanceInMeters);
-    var coords = invariant_1.getCoord(origin);
-    var destination = calculateRhumbDestination(coords, distanceInMeters, bearing);
+    const coords = invariant_1.getCoord(origin);
+    const destination = calculateRhumbDestination(coords, distanceInMeters, bearing);
     // 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] +=
@@ -65,21 +63,21 @@ function calculateRhumbDestination(origin, distance, bearing, radius) {
     // δ => delta
     // θ => theta
     radius = radius === undefined ? helpers_1.earthRadius : Number(radius);
-    var delta = distance / radius; // angular distance in radians
-    var lambda1 = (origin[0] * Math.PI) / 180; // to radians, but without normalize to 𝜋
-    var phi1 = helpers_1.degreesToRadians(origin[1]);
-    var theta = helpers_1.degreesToRadians(bearing);
-    var DeltaPhi = delta * Math.cos(theta);
-    var phi2 = phi1 + DeltaPhi;
+    const delta = distance / radius; // angular distance in radians
+    const lambda1 = (origin[0] * Math.PI) / 180; // to radians, but without normalize to 𝜋
+    const phi1 = helpers_1.degreesToRadians(origin[1]);
+    const theta = helpers_1.degreesToRadians(bearing);
+    const DeltaPhi = delta * Math.cos(theta);
+    let phi2 = phi1 + DeltaPhi;
     // check for some daft bugger going past the pole, normalise latitude if so
     if (Math.abs(phi2) > Math.PI / 2) {
         phi2 = phi2 > 0 ? Math.PI - phi2 : -Math.PI - phi2;
     }
-    var DeltaPsi = Math.log(Math.tan(phi2 / 2 + Math.PI / 4) / Math.tan(phi1 / 2 + Math.PI / 4));
+    const DeltaPsi = Math.log(Math.tan(phi2 / 2 + Math.PI / 4) / Math.tan(phi1 / 2 + Math.PI / 4));
     // E-W course becomes ill-conditioned with 0/0
-    var q = Math.abs(DeltaPsi) > 10e-12 ? DeltaPhi / DeltaPsi : Math.cos(phi1);
-    var DeltaLambda = (delta * Math.sin(theta)) / q;
-    var lambda2 = lambda1 + DeltaLambda;
+    const q = Math.abs(DeltaPsi) > 10e-12 ? DeltaPhi / DeltaPsi : Math.cos(phi1);
+    const DeltaLambda = (delta * Math.sin(theta)) / q;
+    const lambda2 = lambda1 + DeltaLambda;
     return [
         (((lambda2 * 180) / Math.PI + 540) % 360) - 180,
         (phi2 * 180) / Math.PI,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/rhumb-destination",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf rhumb-destination module",
   "author": "Turf Authors",
   "contributors": [
@@ -37,6 +37,7 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "types": "./dist/js/index.d.ts",
       "import": "./dist/es/index.js",
       "require": "./dist/js/index.js"
     }
@@ -47,29 +48,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:tape": "tsx test.js"
   },
   "devDependencies": {
-    "@turf/truncate": "^6.5.0",
+    "@turf/truncate": "^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/helpers": "^6.5.0",
-    "@turf/invariant": "^6.5.0"
+    "@turf/helpers": "^7.0.0-alpha.1",
+    "@turf/invariant": "^7.0.0-alpha.1",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
 }