@turf/along 6.4.0 → 7.0.0-alpha.0

package/README.md

@@ -6,14 +6,15 @@
 
 Takes a [LineString][1] and returns a [Point][2] at a specified distance along the line.
 
-**Parameters**
+### Parameters
 
--   `line` **[Feature][3]<[LineString][4]>** input line
--   `distance` **[number][5]** distance along the line
--   `options` **[Object][6]?** Optional parameters
-    -   `options.units` **[string][7]** can be degrees, radians, miles, or kilometers (optional, default `"kilometers"`)
+*   `line` **[Feature][3]<[LineString][4]>** input line
+*   `distance` **[number][5]** distance along the line
+*   `options` **[Object][6]?** Optional parameters
 
-**Examples**
+    *   `options.units` **[string][7]** can be degrees, radians, miles, or kilometers (optional, default `"kilometers"`)
+
+### Examples
 
 ```javascript
 var line = turf.lineString([[-83, 30], [-84, 36], [-78, 41]]);
@@ -25,7 +26,7 @@ var along = turf.along(line, 200, options);
 var addToMap = [along, line]
 ```
 
-Returns **[Feature][3]&lt;[Point][8]>** Point `distance` `units` along the line
+Returns **[Feature][3]<[Point][8]>** Point `distance` `units` along the line
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.1.4
 

package/dist/es/index.js

@@ -21,24 +21,23 @@ import { getGeom } from "@turf/invariant";
  * //addToMap
  * var addToMap = [along, line]
  */
-export default function along(line, distance, options) {
-    if (options === void 0) { options = {}; }
+export default function along(line, distance, options = {}) {
     // Get Coords
-    var geom = getGeom(line);
-    var coords = geom.coordinates;
-    var travelled = 0;
-    for (var i = 0; i < coords.length; i++) {
+    const geom = getGeom(line);
+    const coords = geom.coordinates;
+    let travelled = 0;
+    for (let i = 0; i < coords.length; i++) {
         if (distance >= travelled && i === coords.length - 1) {
             break;
         }
         else if (travelled >= distance) {
-            var overshot = distance - travelled;
+            const overshot = distance - travelled;
             if (!overshot) {
                 return point(coords[i]);
             }
             else {
-                var direction = bearing(coords[i], coords[i - 1]) - 180;
-                var interpolated = destination(coords[i], overshot, direction, options);
+                const direction = bearing(coords[i], coords[i - 1]) - 180;
+                const interpolated = destination(coords[i], overshot, direction, options);
                 return interpolated;
             }
         }

package/dist/js/index.d.ts

@@ -1,4 +1,5 @@
-import { Feature, LineString, Point, Units } from "@turf/helpers";
+import { Feature, LineString, Point } from "geojson";
+import { Units } from "@turf/helpers";
 /**
  * Takes a {@link LineString} and returns a {@link Point} at a specified distance along the line.
  *

package/dist/js/index.js

@@ -1,13 +1,11 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var bearing_1 = __importDefault(require("@turf/bearing"));
-var destination_1 = __importDefault(require("@turf/destination"));
-var distance_1 = __importDefault(require("@turf/distance"));
-var helpers_1 = require("@turf/helpers");
-var invariant_1 = require("@turf/invariant");
+const tslib_1 = require("tslib");
+const bearing_1 = tslib_1.__importDefault(require("@turf/bearing"));
+const destination_1 = tslib_1.__importDefault(require("@turf/destination"));
+const distance_1 = tslib_1.__importDefault(require("@turf/distance"));
+const helpers_1 = require("@turf/helpers");
+const invariant_1 = require("@turf/invariant");
 /**
  * Takes a {@link LineString} and returns a {@link Point} at a specified distance along the line.
  *
@@ -26,24 +24,23 @@ var invariant_1 = require("@turf/invariant");
  * //addToMap
  * var addToMap = [along, line]
  */
-function along(line, distance, options) {
-    if (options === void 0) { options = {}; }
+function along(line, distance, options = {}) {
     // Get Coords
-    var geom = invariant_1.getGeom(line);
-    var coords = geom.coordinates;
-    var travelled = 0;
-    for (var i = 0; i < coords.length; i++) {
+    const geom = invariant_1.getGeom(line);
+    const coords = geom.coordinates;
+    let travelled = 0;
+    for (let i = 0; i < coords.length; i++) {
         if (distance >= travelled && i === coords.length - 1) {
             break;
         }
         else if (travelled >= distance) {
-            var overshot = distance - travelled;
+            const overshot = distance - travelled;
             if (!overshot) {
                 return helpers_1.point(coords[i]);
             }
             else {
-                var direction = bearing_1.default(coords[i], coords[i - 1]) - 180;
-                var interpolated = destination_1.default(coords[i], overshot, direction, options);
+                const direction = bearing_1.default(coords[i], coords[i - 1]) - 180;
+                const interpolated = destination_1.default(coords[i], overshot, direction, options);
                 return interpolated;
             }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/along",
-  "version": "6.4.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf along module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -12,6 +12,7 @@
     "type": "git",
     "url": "git://github.com/Turfjs/turf.git"
   },
+  "funding": "https://opencollective.com/turf",
   "publishConfig": {
     "access": "public"
   },
@@ -56,11 +57,12 @@
     "typescript": "*"
   },
   "dependencies": {
-    "@turf/bearing": "^6.4.0",
-    "@turf/destination": "^6.4.0",
-    "@turf/distance": "^6.4.0",
-    "@turf/helpers": "^6.4.0",
-    "@turf/invariant": "^6.4.0"
+    "@turf/bearing": "^7.0.0-alpha.0",
+    "@turf/destination": "^7.0.0-alpha.0",
+    "@turf/distance": "^7.0.0-alpha.0",
+    "@turf/helpers": "^7.0.0-alpha.0",
+    "@turf/invariant": "^7.0.0-alpha.0",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "1e62773cfc88c627cca8effcb5c14cfb65a905ac"
+  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
 }