@turf/destination 6.5.0 → 7.0.0-alpha.1

package/README.md

@@ -4,18 +4,21 @@
 
 ## destination
 
-Takes a [Point][1] and calculates the location of a destination point given a distance in degrees, radians, miles, or kilometers; and bearing in degrees. This uses the [Haversine formula][2] to account for global curvature.
+Takes a [Point][1] and calculates the location of a destination point given a distance in
+degrees, radians, miles, or kilometers; and bearing in degrees.
+This uses the [Haversine formula][2] to account for global curvature.
 
-**Parameters**
+### Parameters
 
--   `origin` **[Coord][3]** starting point
--   `distance` **[number][4]** distance from the origin point
--   `bearing` **[number][4]** ranging from -180 to 180
--   `options` **[Object][5]** Optional parameters (optional, default `{}`)
-    -   `options.units` **[string][6]** miles, kilometers, degrees, or radians (optional, default `'kilometers'`)
-    -   `options.properties` **[Object][5]** Translate properties to Point (optional, default `{}`)
+*   `origin` **[Coord][3]** starting point
+*   `distance` **[number][4]** distance from the origin point
+*   `bearing` **[number][4]** ranging from -180 to 180
+*   `options` **[Object][5]** Optional parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.units` **[string][6]** miles, kilometers, degrees, or radians (optional, default `'kilometers'`)
+    *   `options.properties` **[Object][5]** Translate properties to Point (optional, default `{}`)
+
+### Examples
 
 ```javascript
 var point = turf.point([-75.343, 39.984]);
@@ -31,7 +34,7 @@ destination.properties['marker-color'] = '#f00';
 point.properties['marker-color'] = '#0f0';
 ```
 
-Returns **[Feature][7]<[Point][8]>** destination point
+Returns **[Feature][7]<[Point][8]>** destination point
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2
 

package/dist/es/index.js

@@ -1,5 +1,3 @@
-// http://en.wikipedia.org/wiki/Haversine_formula
-// http://www.movable-type.co.uk/scripts/latlong.html
 import { degreesToRadians, lengthToRadians, point, radiansToDegrees, } from "@turf/helpers";
 import { getCoord } from "@turf/invariant";
 /**
@@ -28,20 +26,19 @@ import { getCoord } from "@turf/invariant";
  * destination.properties['marker-color'] = '#f00';
  * point.properties['marker-color'] = '#0f0';
  */
-export default function destination(origin, distance, bearing, options) {
-    if (options === void 0) { options = {}; }
+export default function destination(origin, distance, bearing, options = {}) {
     // Handle input
-    var coordinates1 = getCoord(origin);
-    var longitude1 = degreesToRadians(coordinates1[0]);
-    var latitude1 = degreesToRadians(coordinates1[1]);
-    var bearingRad = degreesToRadians(bearing);
-    var radians = lengthToRadians(distance, options.units);
+    const coordinates1 = getCoord(origin);
+    const longitude1 = degreesToRadians(coordinates1[0]);
+    const latitude1 = degreesToRadians(coordinates1[1]);
+    const bearingRad = degreesToRadians(bearing);
+    const radians = lengthToRadians(distance, options.units);
     // Main
-    var latitude2 = Math.asin(Math.sin(latitude1) * Math.cos(radians) +
+    const latitude2 = Math.asin(Math.sin(latitude1) * Math.cos(radians) +
         Math.cos(latitude1) * Math.sin(radians) * Math.cos(bearingRad));
-    var longitude2 = longitude1 +
+    const longitude2 = longitude1 +
         Math.atan2(Math.sin(bearingRad) * Math.sin(radians) * Math.cos(latitude1), Math.cos(radians) - Math.sin(latitude1) * Math.sin(latitude2));
-    var lng = radiansToDegrees(longitude2);
-    var lat = radiansToDegrees(latitude2);
+    const lng = radiansToDegrees(longitude2);
+    const lat = radiansToDegrees(latitude2);
     return point([lng, lat], options.properties);
 }

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";
 /**
  * Takes a {@link Point} and calculates the location of a destination point given a distance in
  * degrees, radians, miles, or kilometers; and bearing in degrees.
@@ -25,7 +26,7 @@ import { Coord, Feature, Point, Properties, Units } from "@turf/helpers";
  * destination.properties['marker-color'] = '#f00';
  * point.properties['marker-color'] = '#0f0';
  */
-export default function destination<P = Properties>(origin: Coord, distance: number, bearing: number, options?: {
+export default function destination<P = GeoJsonProperties>(origin: Coord, distance: number, bearing: number, options?: {
     units?: Units;
     properties?: P;
 }): Feature<Point, P>;

package/dist/js/index.js

@@ -1,9 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-// http://en.wikipedia.org/wiki/Haversine_formula
-// http://www.movable-type.co.uk/scripts/latlong.html
-var helpers_1 = require("@turf/helpers");
-var invariant_1 = require("@turf/invariant");
+const helpers_1 = require("@turf/helpers");
+const invariant_1 = require("@turf/invariant");
 /**
  * Takes a {@link Point} and calculates the location of a destination point given a distance in
  * degrees, radians, miles, or kilometers; and bearing in degrees.
@@ -30,21 +28,20 @@ var invariant_1 = require("@turf/invariant");
  * destination.properties['marker-color'] = '#f00';
  * point.properties['marker-color'] = '#0f0';
  */
-function destination(origin, distance, bearing, options) {
-    if (options === void 0) { options = {}; }
+function destination(origin, distance, bearing, options = {}) {
     // Handle input
-    var coordinates1 = invariant_1.getCoord(origin);
-    var longitude1 = helpers_1.degreesToRadians(coordinates1[0]);
-    var latitude1 = helpers_1.degreesToRadians(coordinates1[1]);
-    var bearingRad = helpers_1.degreesToRadians(bearing);
-    var radians = helpers_1.lengthToRadians(distance, options.units);
+    const coordinates1 = invariant_1.getCoord(origin);
+    const longitude1 = helpers_1.degreesToRadians(coordinates1[0]);
+    const latitude1 = helpers_1.degreesToRadians(coordinates1[1]);
+    const bearingRad = helpers_1.degreesToRadians(bearing);
+    const radians = helpers_1.lengthToRadians(distance, options.units);
     // Main
-    var latitude2 = Math.asin(Math.sin(latitude1) * Math.cos(radians) +
+    const latitude2 = Math.asin(Math.sin(latitude1) * Math.cos(radians) +
         Math.cos(latitude1) * Math.sin(radians) * Math.cos(bearingRad));
-    var longitude2 = longitude1 +
+    const longitude2 = longitude1 +
         Math.atan2(Math.sin(bearingRad) * Math.sin(radians) * Math.cos(latitude1), Math.cos(radians) - Math.sin(latitude1) * Math.sin(latitude2));
-    var lng = helpers_1.radiansToDegrees(longitude2);
-    var lat = helpers_1.radiansToDegrees(latitude2);
+    const lng = helpers_1.radiansToDegrees(longitude2);
+    const lat = helpers_1.radiansToDegrees(latitude2);
     return helpers_1.point([lng, lat], options.properties);
 }
 exports.default = destination;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/destination",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf destination 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,30 +40,31 @@
     "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": "*",
     "glob": "*",
     "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"
 }