@turf/along 7.0.0-alpha.2 → 7.0.0

package/README.md

@@ -44,26 +44,21 @@ Returns **[Feature][3]<[Point][8]>** Point `distance` `units` along the line
 
 [8]: https://tools.ietf.org/html/rfc7946#section-3.1.2
 
-<!-- This file is automatically generated. Please don't edit it directly:
-if you find an error, edit the source file (likely index.js), and re-run
-./scripts/generate-readmes in the turf project. -->
+<!-- This file is automatically generated. Please don't edit it directly. If you find an error, edit the source file of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->
 
 ---
 
-This module is part of the [Turfjs project](http://turfjs.org/), an open source
-module collection dedicated to geographic algorithms. It is maintained in the
-[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
-PRs and issues.
+This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.
 
 ### Installation
 
-Install this module individually:
+Install this single module individually:
 
 ```sh
 $ npm install @turf/along
 ```
 
-Or install the Turf module that includes it as a function:
+Or install the all-encompassing @turf/turf module that includes all modules as functions:
 
 ```sh
 $ npm install @turf/turf

package/dist/cjs/index.cjs

@@ -0,0 +1,43 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.ts
+var _bearing = require('@turf/bearing');
+var _destination = require('@turf/destination');
+var _distance = require('@turf/distance');
+var _helpers = require('@turf/helpers');
+var _invariant = require('@turf/invariant');
+function along(line, distance, options = {}) {
+  const geom = _invariant.getGeom.call(void 0, 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) {
+      const overshot = distance - travelled;
+      if (!overshot) {
+        return _helpers.point.call(void 0, coords[i]);
+      } else {
+        const direction = _bearing.bearing.call(void 0, coords[i], coords[i - 1]) - 180;
+        const interpolated = _destination.destination.call(void 0, 
+          coords[i],
+          overshot,
+          direction,
+          options
+        );
+        return interpolated;
+      }
+    } else {
+      travelled += _distance.distance.call(void 0, coords[i], coords[i + 1], options);
+    }
+  }
+  return _helpers.point.call(void 0, coords[coords.length - 1]);
+}
+__name(along, "along");
+var turf_along_default = along;
+
+
+
+exports.along = along; exports.default = turf_along_default;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"names":[],"mappings":";;;;AACA,SAAS,eAAe;AACxB,SAAS,mBAAmB;AAC5B,SAAS,YAAY,uBAAuB;AAC5C,SAAS,aAAoB;AAC7B,SAAS,eAAe;AAoBxB,SAAS,MACP,MACA,UACA,UAA6B,CAAC,GACd;AAEhB,QAAM,OAAO,QAAQ,IAAI;AACzB,QAAM,SAAS,KAAK;AACpB,MAAI,YAAY;AAChB,WAAS,IAAI,GAAG,IAAI,OAAO,QAAQ,KAAK;AACtC,QAAI,YAAY,aAAa,MAAM,OAAO,SAAS,GAAG;AACpD;AAAA,IACF,WAAW,aAAa,UAAU;AAChC,YAAM,WAAW,WAAW;AAC5B,UAAI,CAAC,UAAU;AACb,eAAO,MAAM,OAAO,CAAC,CAAC;AAAA,MACxB,OAAO;AACL,cAAM,YAAY,QAAQ,OAAO,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC,IAAI;AACtD,cAAM,eAAe;AAAA,UACnB,OAAO,CAAC;AAAA,UACR;AAAA,UACA;AAAA,UACA;AAAA,QACF;AACA,eAAO;AAAA,MACT;AAAA,IACF,OAAO;AACL,mBAAa,gBAAgB,OAAO,CAAC,GAAG,OAAO,IAAI,CAAC,GAAG,OAAO;AAAA,IAChE;AAAA,EACF;AACA,SAAO,MAAM,OAAO,OAAO,SAAS,CAAC,CAAC;AACxC;AA/BS;AAkCT,IAAO,qBAAQ","sourcesContent":["import { Feature, LineString, Point } from \"geojson\";\nimport { bearing } from \"@turf/bearing\";\nimport { destination } from \"@turf/destination\";\nimport { distance as measureDistance } from \"@turf/distance\";\nimport { point, Units } from \"@turf/helpers\";\nimport { getGeom } from \"@turf/invariant\";\n\n/**\n * Takes a {@link LineString} and returns a {@link Point} at a specified distance along the line.\n *\n * @name along\n * @param {Feature<LineString>} line input line\n * @param {number} distance distance along the line\n * @param {Object} [options] Optional parameters\n * @param {string} [options.units=\"kilometers\"] can be degrees, radians, miles, or kilometers\n * @returns {Feature<Point>} Point `distance` `units` along the line\n * @example\n * var line = turf.lineString([[-83, 30], [-84, 36], [-78, 41]]);\n * var options = {units: 'miles'};\n *\n * var along = turf.along(line, 200, options);\n *\n * //addToMap\n * var addToMap = [along, line]\n */\nfunction along(\n  line: Feature<LineString> | LineString,\n  distance: number,\n  options: { units?: Units } = {}\n): Feature<Point> {\n  // Get Coords\n  const geom = getGeom(line);\n  const coords = geom.coordinates;\n  let travelled = 0;\n  for (let i = 0; i < coords.length; i++) {\n    if (distance >= travelled && i === coords.length - 1) {\n      break;\n    } else if (travelled >= distance) {\n      const overshot = distance - travelled;\n      if (!overshot) {\n        return point(coords[i]);\n      } else {\n        const direction = bearing(coords[i], coords[i - 1]) - 180;\n        const interpolated = destination(\n          coords[i],\n          overshot,\n          direction,\n          options\n        );\n        return interpolated;\n      }\n    } else {\n      travelled += measureDistance(coords[i], coords[i + 1], options);\n    }\n  }\n  return point(coords[coords.length - 1]);\n}\n\nexport { along };\nexport default along;\n"]}

package/dist/cjs/index.d.cts

@@ -0,0 +1,26 @@
+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.
+ *
+ * @name along
+ * @param {Feature<LineString>} line input line
+ * @param {number} distance distance along the line
+ * @param {Object} [options] Optional parameters
+ * @param {string} [options.units="kilometers"] can be degrees, radians, miles, or kilometers
+ * @returns {Feature<Point>} Point `distance` `units` along the line
+ * @example
+ * var line = turf.lineString([[-83, 30], [-84, 36], [-78, 41]]);
+ * var options = {units: 'miles'};
+ *
+ * var along = turf.along(line, 200, options);
+ *
+ * //addToMap
+ * var addToMap = [along, line]
+ */
+declare function along(line: Feature<LineString> | LineString, distance: number, options?: {
+    units?: Units;
+}): Feature<Point>;
+
+export { along, along as default };

package/dist/{js → esm}/index.d.ts

@@ -1,5 +1,6 @@
-import { Feature, LineString, Point } from "geojson";
-import { 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.
  *
@@ -18,6 +19,8 @@ import { Units } from "@turf/helpers";
  * //addToMap
  * var addToMap = [along, line]
  */
-export default function along(line: Feature<LineString> | LineString, distance: number, options?: {
+declare function along(line: Feature<LineString> | LineString, distance: number, options?: {
     units?: Units;
 }): Feature<Point>;
+
+export { along, along as default };

package/dist/esm/index.js

@@ -0,0 +1,43 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.ts
+import { bearing } from "@turf/bearing";
+import { destination } from "@turf/destination";
+import { distance as measureDistance } from "@turf/distance";
+import { point } from "@turf/helpers";
+import { getGeom } from "@turf/invariant";
+function along(line, distance, options = {}) {
+  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) {
+      const overshot = distance - travelled;
+      if (!overshot) {
+        return point(coords[i]);
+      } else {
+        const direction = bearing(coords[i], coords[i - 1]) - 180;
+        const interpolated = destination(
+          coords[i],
+          overshot,
+          direction,
+          options
+        );
+        return interpolated;
+      }
+    } else {
+      travelled += measureDistance(coords[i], coords[i + 1], options);
+    }
+  }
+  return point(coords[coords.length - 1]);
+}
+__name(along, "along");
+var turf_along_default = along;
+export {
+  along,
+  turf_along_default as default
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"sourcesContent":["import { Feature, LineString, Point } from \"geojson\";\nimport { bearing } from \"@turf/bearing\";\nimport { destination } from \"@turf/destination\";\nimport { distance as measureDistance } from \"@turf/distance\";\nimport { point, Units } from \"@turf/helpers\";\nimport { getGeom } from \"@turf/invariant\";\n\n/**\n * Takes a {@link LineString} and returns a {@link Point} at a specified distance along the line.\n *\n * @name along\n * @param {Feature<LineString>} line input line\n * @param {number} distance distance along the line\n * @param {Object} [options] Optional parameters\n * @param {string} [options.units=\"kilometers\"] can be degrees, radians, miles, or kilometers\n * @returns {Feature<Point>} Point `distance` `units` along the line\n * @example\n * var line = turf.lineString([[-83, 30], [-84, 36], [-78, 41]]);\n * var options = {units: 'miles'};\n *\n * var along = turf.along(line, 200, options);\n *\n * //addToMap\n * var addToMap = [along, line]\n */\nfunction along(\n  line: Feature<LineString> | LineString,\n  distance: number,\n  options: { units?: Units } = {}\n): Feature<Point> {\n  // Get Coords\n  const geom = getGeom(line);\n  const coords = geom.coordinates;\n  let travelled = 0;\n  for (let i = 0; i < coords.length; i++) {\n    if (distance >= travelled && i === coords.length - 1) {\n      break;\n    } else if (travelled >= distance) {\n      const overshot = distance - travelled;\n      if (!overshot) {\n        return point(coords[i]);\n      } else {\n        const direction = bearing(coords[i], coords[i - 1]) - 180;\n        const interpolated = destination(\n          coords[i],\n          overshot,\n          direction,\n          options\n        );\n        return interpolated;\n      }\n    } else {\n      travelled += measureDistance(coords[i], coords[i + 1], options);\n    }\n  }\n  return point(coords[coords.length - 1]);\n}\n\nexport { along };\nexport default along;\n"],"mappings":";;;;AACA,SAAS,eAAe;AACxB,SAAS,mBAAmB;AAC5B,SAAS,YAAY,uBAAuB;AAC5C,SAAS,aAAoB;AAC7B,SAAS,eAAe;AAoBxB,SAAS,MACP,MACA,UACA,UAA6B,CAAC,GACd;AAEhB,QAAM,OAAO,QAAQ,IAAI;AACzB,QAAM,SAAS,KAAK;AACpB,MAAI,YAAY;AAChB,WAAS,IAAI,GAAG,IAAI,OAAO,QAAQ,KAAK;AACtC,QAAI,YAAY,aAAa,MAAM,OAAO,SAAS,GAAG;AACpD;AAAA,IACF,WAAW,aAAa,UAAU;AAChC,YAAM,WAAW,WAAW;AAC5B,UAAI,CAAC,UAAU;AACb,eAAO,MAAM,OAAO,CAAC,CAAC;AAAA,MACxB,OAAO;AACL,cAAM,YAAY,QAAQ,OAAO,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC,IAAI;AACtD,cAAM,eAAe;AAAA,UACnB,OAAO,CAAC;AAAA,UACR;AAAA,UACA;AAAA,UACA;AAAA,QACF;AACA,eAAO;AAAA,MACT;AAAA,IACF,OAAO;AACL,mBAAa,gBAAgB,OAAO,CAAC,GAAG,OAAO,IAAI,CAAC,GAAG,OAAO;AAAA,IAChE;AAAA,EACF;AACA,SAAO,MAAM,OAAO,OAAO,SAAS,CAAC,CAAC;AACxC;AA/BS;AAkCT,IAAO,qBAAQ;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/along",
-  "version": "7.0.0-alpha.2",
+  "version": "7.0.0",
   "description": "turf along module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -23,47 +23,52 @@
     "turf",
     "distance"
   ],
-  "main": "dist/js/index.js",
-  "module": "dist/es/index.js",
+  "type": "module",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "types": "./dist/js/index.d.ts",
-      "import": "./dist/es/index.js",
-      "require": "./dist/js/index.js"
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.cts",
+        "default": "./dist/cjs/index.cjs"
+      }
     }
   },
-  "types": "dist/js/index.d.ts",
   "sideEffects": false,
   "files": [
     "dist"
   ],
   "scripts": {
-    "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": "tsx ../../scripts/generate-readmes",
-    "test": "npm-run-all test:*",
-    "test:tape": "tsx test.js"
+    "bench": "tsx bench.ts",
+    "build": "tsup --config ../../tsup.config.ts",
+    "docs": "tsx ../../scripts/generate-readmes.ts",
+    "test": "npm-run-all --npm-path npm test:*",
+    "test:tape": "tsx test.ts"
   },
   "devDependencies": {
-    "@types/tape": "*",
-    "benchmark": "*",
-    "load-json-file": "*",
-    "npm-run-all": "*",
-    "tape": "*",
-    "tslint": "*",
-    "tsx": "*",
-    "typescript": "*"
+    "@types/benchmark": "^2.1.5",
+    "@types/tape": "^4.2.32",
+    "benchmark": "^2.1.4",
+    "load-json-file": "^7.0.1",
+    "npm-run-all": "^4.1.5",
+    "tape": "^5.7.2",
+    "tsup": "^8.0.1",
+    "tsx": "^4.6.2",
+    "typescript": "^5.2.2"
   },
   "dependencies": {
-    "@turf/bearing": "^7.0.0-alpha.2",
-    "@turf/destination": "^7.0.0-alpha.2",
-    "@turf/distance": "^7.0.0-alpha.2",
-    "@turf/helpers": "^7.0.0-alpha.2",
-    "@turf/invariant": "^7.0.0-alpha.2",
-    "tslib": "^2.3.0"
+    "@turf/bearing": "^7.0.0",
+    "@turf/destination": "^7.0.0",
+    "@turf/distance": "^7.0.0",
+    "@turf/helpers": "^7.0.0",
+    "@turf/invariant": "^7.0.0",
+    "tslib": "^2.6.2"
   },
-  "gitHead": "dd35b52725945b4fa29a98d9a550733e06cc222e"
+  "gitHead": "3d3a7917025fbabe191dbddbc89754b86f9c7739"
 }

package/dist/es/index.js

@@ -1,49 +0,0 @@
-import bearing from "@turf/bearing";
-import destination from "@turf/destination";
-import measureDistance from "@turf/distance";
-import { point } from "@turf/helpers";
-import { getGeom } from "@turf/invariant";
-/**
- * Takes a {@link LineString} and returns a {@link Point} at a specified distance along the line.
- *
- * @name along
- * @param {Feature<LineString>} line input line
- * @param {number} distance distance along the line
- * @param {Object} [options] Optional parameters
- * @param {string} [options.units="kilometers"] can be degrees, radians, miles, or kilometers
- * @returns {Feature<Point>} Point `distance` `units` along the line
- * @example
- * var line = turf.lineString([[-83, 30], [-84, 36], [-78, 41]]);
- * var options = {units: 'miles'};
- *
- * var along = turf.along(line, 200, options);
- *
- * //addToMap
- * var addToMap = [along, line]
- */
-export default function along(line, distance, options = {}) {
-    // Get Coords
-    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) {
-            const overshot = distance - travelled;
-            if (!overshot) {
-                return point(coords[i]);
-            }
-            else {
-                const direction = bearing(coords[i], coords[i - 1]) - 180;
-                const interpolated = destination(coords[i], overshot, direction, options);
-                return interpolated;
-            }
-        }
-        else {
-            travelled += measureDistance(coords[i], coords[i + 1], options);
-        }
-    }
-    return point(coords[coords.length - 1]);
-}

package/dist/es/package.json

@@ -1 +0,0 @@
-{"type":"module"}

package/dist/js/index.js

@@ -1,53 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-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.
- *
- * @name along
- * @param {Feature<LineString>} line input line
- * @param {number} distance distance along the line
- * @param {Object} [options] Optional parameters
- * @param {string} [options.units="kilometers"] can be degrees, radians, miles, or kilometers
- * @returns {Feature<Point>} Point `distance` `units` along the line
- * @example
- * var line = turf.lineString([[-83, 30], [-84, 36], [-78, 41]]);
- * var options = {units: 'miles'};
- *
- * var along = turf.along(line, 200, options);
- *
- * //addToMap
- * var addToMap = [along, line]
- */
-function along(line, distance, options = {}) {
-    // Get Coords
-    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) {
-            const overshot = distance - travelled;
-            if (!overshot) {
-                return helpers_1.point(coords[i]);
-            }
-            else {
-                const direction = bearing_1.default(coords[i], coords[i - 1]) - 180;
-                const interpolated = destination_1.default(coords[i], overshot, direction, options);
-                return interpolated;
-            }
-        }
-        else {
-            travelled += distance_1.default(coords[i], coords[i + 1], options);
-        }
-    }
-    return helpers_1.point(coords[coords.length - 1]);
-}
-exports.default = along;