@turf/angle 7.0.0-alpha.2 → 7.0.0

package/README.md

@@ -34,26 +34,21 @@ Returns **[number][4]** Angle between the provided points, or its explementary.
 
 [4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
 
-<!-- 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/angle
 ```
 
-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,42 @@
+"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 _helpers = require('@turf/helpers');
+var _rhumbbearing = require('@turf/rhumb-bearing');
+function angle(startPoint, midPoint, endPoint, options = {}) {
+  if (!_helpers.isObject.call(void 0, options)) {
+    throw new Error("options is invalid");
+  }
+  if (!startPoint) {
+    throw new Error("startPoint is required");
+  }
+  if (!midPoint) {
+    throw new Error("midPoint is required");
+  }
+  if (!endPoint) {
+    throw new Error("endPoint is required");
+  }
+  const A = startPoint;
+  const O = midPoint;
+  const B = endPoint;
+  const azimuthAO = _helpers.bearingToAzimuth.call(void 0, 
+    options.mercator !== true ? _bearing.bearing.call(void 0, A, O) : _rhumbbearing.rhumbBearing.call(void 0, A, O)
+  );
+  const azimuthBO = _helpers.bearingToAzimuth.call(void 0, 
+    options.mercator !== true ? _bearing.bearing.call(void 0, B, O) : _rhumbbearing.rhumbBearing.call(void 0, B, O)
+  );
+  const angleAO = Math.abs(azimuthAO - azimuthBO);
+  if (options.explementary === true) {
+    return 360 - angleAO;
+  }
+  return angleAO;
+}
+__name(angle, "angle");
+var turf_angle_default = angle;
+
+
+
+exports.angle = angle; exports.default = turf_angle_default;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"names":[],"mappings":";;;;AAAA,SAAS,eAAe;AACxB,SAAS,kBAAyB,gBAAgB;AAClD,SAAS,oBAAoB;AAkB7B,SAAS,MACP,YACA,UACA,UACA,UAGI,CAAC,GACG;AAER,MAAI,CAAC,SAAS,OAAO,GAAG;AACtB,UAAM,IAAI,MAAM,oBAAoB;AAAA,EACtC;AAGA,MAAI,CAAC,YAAY;AACf,UAAM,IAAI,MAAM,wBAAwB;AAAA,EAC1C;AACA,MAAI,CAAC,UAAU;AACb,UAAM,IAAI,MAAM,sBAAsB;AAAA,EACxC;AACA,MAAI,CAAC,UAAU;AACb,UAAM,IAAI,MAAM,sBAAsB;AAAA,EACxC;AAGA,QAAM,IAAI;AACV,QAAM,IAAI;AACV,QAAM,IAAI;AAGV,QAAM,YAAY;AAAA,IAChB,QAAQ,aAAa,OAAO,QAAQ,GAAG,CAAC,IAAI,aAAa,GAAG,CAAC;AAAA,EAC/D;AACA,QAAM,YAAY;AAAA,IAChB,QAAQ,aAAa,OAAO,QAAQ,GAAG,CAAC,IAAI,aAAa,GAAG,CAAC;AAAA,EAC/D;AACA,QAAM,UAAU,KAAK,IAAI,YAAY,SAAS;AAG9C,MAAI,QAAQ,iBAAiB,MAAM;AACjC,WAAO,MAAM;AAAA,EACf;AACA,SAAO;AACT;AA5CS;AA+CT,IAAO,qBAAQ","sourcesContent":["import { bearing } from \"@turf/bearing\";\nimport { bearingToAzimuth, Coord, isObject } from \"@turf/helpers\";\nimport { rhumbBearing } from \"@turf/rhumb-bearing\";\n\n/**\n * Finds the angle formed by two adjacent segments defined by 3 points. The result will be the (positive clockwise)\n * angle with origin on the `startPoint-midPoint` segment, or its explementary angle if required.\n *\n * @name angle\n * @param {Coord} startPoint Start Point Coordinates\n * @param {Coord} midPoint Mid Point Coordinates\n * @param {Coord} endPoint End Point Coordinates\n * @param {Object} [options={}] Optional parameters\n * @param {boolean} [options.explementary=false] Returns the explementary angle instead (360 - angle)\n * @param {boolean} [options.mercator=false] if calculations should be performed over Mercator or WGS84 projection\n * @returns {number} Angle between the provided points, or its explementary.\n * @example\n * turf.angle([5, 5], [5, 6], [3, 4]);\n * //=45\n */\nfunction angle(\n  startPoint: Coord,\n  midPoint: Coord,\n  endPoint: Coord,\n  options: {\n    explementary?: boolean;\n    mercator?: boolean;\n  } = {}\n): number {\n  // Optional Parameters\n  if (!isObject(options)) {\n    throw new Error(\"options is invalid\");\n  }\n\n  // Validation\n  if (!startPoint) {\n    throw new Error(\"startPoint is required\");\n  }\n  if (!midPoint) {\n    throw new Error(\"midPoint is required\");\n  }\n  if (!endPoint) {\n    throw new Error(\"endPoint is required\");\n  }\n\n  // Rename to shorter variables\n  const A = startPoint;\n  const O = midPoint;\n  const B = endPoint;\n\n  // Main\n  const azimuthAO = bearingToAzimuth(\n    options.mercator !== true ? bearing(A, O) : rhumbBearing(A, O)\n  );\n  const azimuthBO = bearingToAzimuth(\n    options.mercator !== true ? bearing(B, O) : rhumbBearing(B, O)\n  );\n  const angleAO = Math.abs(azimuthAO - azimuthBO);\n\n  // Explementary angle\n  if (options.explementary === true) {\n    return 360 - angleAO;\n  }\n  return angleAO;\n}\n\nexport { angle };\nexport default angle;\n"]}

package/dist/cjs/index.d.cts

@@ -0,0 +1,24 @@
+import { Coord } from '@turf/helpers';
+
+/**
+ * Finds the angle formed by two adjacent segments defined by 3 points. The result will be the (positive clockwise)
+ * angle with origin on the `startPoint-midPoint` segment, or its explementary angle if required.
+ *
+ * @name angle
+ * @param {Coord} startPoint Start Point Coordinates
+ * @param {Coord} midPoint Mid Point Coordinates
+ * @param {Coord} endPoint End Point Coordinates
+ * @param {Object} [options={}] Optional parameters
+ * @param {boolean} [options.explementary=false] Returns the explementary angle instead (360 - angle)
+ * @param {boolean} [options.mercator=false] if calculations should be performed over Mercator or WGS84 projection
+ * @returns {number} Angle between the provided points, or its explementary.
+ * @example
+ * turf.angle([5, 5], [5, 6], [3, 4]);
+ * //=45
+ */
+declare function angle(startPoint: Coord, midPoint: Coord, endPoint: Coord, options?: {
+    explementary?: boolean;
+    mercator?: boolean;
+}): number;
+
+export { angle, angle as default };

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

@@ -1,4 +1,5 @@
-import { Coord } from "@turf/helpers";
+import { Coord } from '@turf/helpers';
+
 /**
  * Finds the angle formed by two adjacent segments defined by 3 points. The result will be the (positive clockwise)
  * angle with origin on the `startPoint-midPoint` segment, or its explementary angle if required.
@@ -19,4 +20,5 @@ declare function angle(startPoint: Coord, midPoint: Coord, endPoint: Coord, opti
     explementary?: boolean;
     mercator?: boolean;
 }): number;
-export default angle;
+
+export { angle, angle as default };

package/dist/esm/index.js

@@ -0,0 +1,42 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.ts
+import { bearing } from "@turf/bearing";
+import { bearingToAzimuth, isObject } from "@turf/helpers";
+import { rhumbBearing } from "@turf/rhumb-bearing";
+function angle(startPoint, midPoint, endPoint, options = {}) {
+  if (!isObject(options)) {
+    throw new Error("options is invalid");
+  }
+  if (!startPoint) {
+    throw new Error("startPoint is required");
+  }
+  if (!midPoint) {
+    throw new Error("midPoint is required");
+  }
+  if (!endPoint) {
+    throw new Error("endPoint is required");
+  }
+  const A = startPoint;
+  const O = midPoint;
+  const B = endPoint;
+  const azimuthAO = bearingToAzimuth(
+    options.mercator !== true ? bearing(A, O) : rhumbBearing(A, O)
+  );
+  const azimuthBO = bearingToAzimuth(
+    options.mercator !== true ? bearing(B, O) : rhumbBearing(B, O)
+  );
+  const angleAO = Math.abs(azimuthAO - azimuthBO);
+  if (options.explementary === true) {
+    return 360 - angleAO;
+  }
+  return angleAO;
+}
+__name(angle, "angle");
+var turf_angle_default = angle;
+export {
+  angle,
+  turf_angle_default as default
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"sourcesContent":["import { bearing } from \"@turf/bearing\";\nimport { bearingToAzimuth, Coord, isObject } from \"@turf/helpers\";\nimport { rhumbBearing } from \"@turf/rhumb-bearing\";\n\n/**\n * Finds the angle formed by two adjacent segments defined by 3 points. The result will be the (positive clockwise)\n * angle with origin on the `startPoint-midPoint` segment, or its explementary angle if required.\n *\n * @name angle\n * @param {Coord} startPoint Start Point Coordinates\n * @param {Coord} midPoint Mid Point Coordinates\n * @param {Coord} endPoint End Point Coordinates\n * @param {Object} [options={}] Optional parameters\n * @param {boolean} [options.explementary=false] Returns the explementary angle instead (360 - angle)\n * @param {boolean} [options.mercator=false] if calculations should be performed over Mercator or WGS84 projection\n * @returns {number} Angle between the provided points, or its explementary.\n * @example\n * turf.angle([5, 5], [5, 6], [3, 4]);\n * //=45\n */\nfunction angle(\n  startPoint: Coord,\n  midPoint: Coord,\n  endPoint: Coord,\n  options: {\n    explementary?: boolean;\n    mercator?: boolean;\n  } = {}\n): number {\n  // Optional Parameters\n  if (!isObject(options)) {\n    throw new Error(\"options is invalid\");\n  }\n\n  // Validation\n  if (!startPoint) {\n    throw new Error(\"startPoint is required\");\n  }\n  if (!midPoint) {\n    throw new Error(\"midPoint is required\");\n  }\n  if (!endPoint) {\n    throw new Error(\"endPoint is required\");\n  }\n\n  // Rename to shorter variables\n  const A = startPoint;\n  const O = midPoint;\n  const B = endPoint;\n\n  // Main\n  const azimuthAO = bearingToAzimuth(\n    options.mercator !== true ? bearing(A, O) : rhumbBearing(A, O)\n  );\n  const azimuthBO = bearingToAzimuth(\n    options.mercator !== true ? bearing(B, O) : rhumbBearing(B, O)\n  );\n  const angleAO = Math.abs(azimuthAO - azimuthBO);\n\n  // Explementary angle\n  if (options.explementary === true) {\n    return 360 - angleAO;\n  }\n  return angleAO;\n}\n\nexport { angle };\nexport default angle;\n"],"mappings":";;;;AAAA,SAAS,eAAe;AACxB,SAAS,kBAAyB,gBAAgB;AAClD,SAAS,oBAAoB;AAkB7B,SAAS,MACP,YACA,UACA,UACA,UAGI,CAAC,GACG;AAER,MAAI,CAAC,SAAS,OAAO,GAAG;AACtB,UAAM,IAAI,MAAM,oBAAoB;AAAA,EACtC;AAGA,MAAI,CAAC,YAAY;AACf,UAAM,IAAI,MAAM,wBAAwB;AAAA,EAC1C;AACA,MAAI,CAAC,UAAU;AACb,UAAM,IAAI,MAAM,sBAAsB;AAAA,EACxC;AACA,MAAI,CAAC,UAAU;AACb,UAAM,IAAI,MAAM,sBAAsB;AAAA,EACxC;AAGA,QAAM,IAAI;AACV,QAAM,IAAI;AACV,QAAM,IAAI;AAGV,QAAM,YAAY;AAAA,IAChB,QAAQ,aAAa,OAAO,QAAQ,GAAG,CAAC,IAAI,aAAa,GAAG,CAAC;AAAA,EAC/D;AACA,QAAM,YAAY;AAAA,IAChB,QAAQ,aAAa,OAAO,QAAQ,GAAG,CAAC,IAAI,aAAa,GAAG,CAAC;AAAA,EAC/D;AACA,QAAM,UAAU,KAAK,IAAI,YAAY,SAAS;AAG9C,MAAI,QAAQ,iBAAiB,MAAM;AACjC,WAAO,MAAM;AAAA,EACf;AACA,SAAO;AACT;AA5CS;AA+CT,IAAO,qBAAQ;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/angle",
-  "version": "7.0.0-alpha.2",
+  "version": "7.0.0",
   "description": "turf angle module",
   "author": "Turf Authors",
   "contributors": [
@@ -23,51 +23,56 @@
     "turf",
     "angle"
   ],
-  "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": {
-    "@turf/distance": "^7.0.0-alpha.2",
-    "@turf/sector": "^7.0.0-alpha.2",
-    "@turf/truncate": "^7.0.0-alpha.2",
-    "@types/tape": "*",
-    "benchmark": "*",
-    "glob": "*",
-    "load-json-file": "*",
-    "npm-run-all": "*",
-    "tape": "*",
-    "tslint": "*",
-    "tsx": "*",
-    "typescript": "*",
-    "write-json-file": "*"
+    "@turf/distance": "^7.0.0",
+    "@turf/sector": "^7.0.0",
+    "@turf/truncate": "^7.0.0",
+    "@types/benchmark": "^2.1.5",
+    "@types/tape": "^4.2.32",
+    "benchmark": "^2.1.4",
+    "glob": "^10.3.10",
+    "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",
+    "write-json-file": "^5.0.0"
   },
   "dependencies": {
-    "@turf/bearing": "^7.0.0-alpha.2",
-    "@turf/helpers": "^7.0.0-alpha.2",
-    "@turf/invariant": "^7.0.0-alpha.2",
-    "@turf/rhumb-bearing": "^7.0.0-alpha.2",
-    "tslib": "^2.3.0"
+    "@turf/bearing": "^7.0.0",
+    "@turf/helpers": "^7.0.0",
+    "@turf/invariant": "^7.0.0",
+    "@turf/rhumb-bearing": "^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 { bearingToAzimuth, isObject } from "@turf/helpers";
-import rhumbBearing from "@turf/rhumb-bearing";
-/**
- * Finds the angle formed by two adjacent segments defined by 3 points. The result will be the (positive clockwise)
- * angle with origin on the `startPoint-midPoint` segment, or its explementary angle if required.
- *
- * @name angle
- * @param {Coord} startPoint Start Point Coordinates
- * @param {Coord} midPoint Mid Point Coordinates
- * @param {Coord} endPoint End Point Coordinates
- * @param {Object} [options={}] Optional parameters
- * @param {boolean} [options.explementary=false] Returns the explementary angle instead (360 - angle)
- * @param {boolean} [options.mercator=false] if calculations should be performed over Mercator or WGS84 projection
- * @returns {number} Angle between the provided points, or its explementary.
- * @example
- * turf.angle([5, 5], [5, 6], [3, 4]);
- * //=45
- */
-function angle(startPoint, midPoint, endPoint, options = {}) {
-    // Optional Parameters
-    if (!isObject(options)) {
-        throw new Error("options is invalid");
-    }
-    // Validation
-    if (!startPoint) {
-        throw new Error("startPoint is required");
-    }
-    if (!midPoint) {
-        throw new Error("midPoint is required");
-    }
-    if (!endPoint) {
-        throw new Error("endPoint is required");
-    }
-    // Rename to shorter variables
-    const A = startPoint;
-    const O = midPoint;
-    const B = endPoint;
-    // Main
-    const azimuthAO = bearingToAzimuth(options.mercator !== true ? bearing(A, O) : rhumbBearing(A, O));
-    const azimuthBO = bearingToAzimuth(options.mercator !== true ? bearing(B, O) : rhumbBearing(B, O));
-    const angleAO = Math.abs(azimuthAO - azimuthBO);
-    // Explementary angle
-    if (options.explementary === true) {
-        return 360 - angleAO;
-    }
-    return angleAO;
-}
-export default angle;

package/dist/es/package.json

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

package/dist/js/index.js

@@ -1,52 +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 helpers_1 = require("@turf/helpers");
-const rhumb_bearing_1 = tslib_1.__importDefault(require("@turf/rhumb-bearing"));
-/**
- * Finds the angle formed by two adjacent segments defined by 3 points. The result will be the (positive clockwise)
- * angle with origin on the `startPoint-midPoint` segment, or its explementary angle if required.
- *
- * @name angle
- * @param {Coord} startPoint Start Point Coordinates
- * @param {Coord} midPoint Mid Point Coordinates
- * @param {Coord} endPoint End Point Coordinates
- * @param {Object} [options={}] Optional parameters
- * @param {boolean} [options.explementary=false] Returns the explementary angle instead (360 - angle)
- * @param {boolean} [options.mercator=false] if calculations should be performed over Mercator or WGS84 projection
- * @returns {number} Angle between the provided points, or its explementary.
- * @example
- * turf.angle([5, 5], [5, 6], [3, 4]);
- * //=45
- */
-function angle(startPoint, midPoint, endPoint, options = {}) {
-    // Optional Parameters
-    if (!helpers_1.isObject(options)) {
-        throw new Error("options is invalid");
-    }
-    // Validation
-    if (!startPoint) {
-        throw new Error("startPoint is required");
-    }
-    if (!midPoint) {
-        throw new Error("midPoint is required");
-    }
-    if (!endPoint) {
-        throw new Error("endPoint is required");
-    }
-    // Rename to shorter variables
-    const A = startPoint;
-    const O = midPoint;
-    const B = endPoint;
-    // Main
-    const azimuthAO = helpers_1.bearingToAzimuth(options.mercator !== true ? bearing_1.default(A, O) : rhumb_bearing_1.default(A, O));
-    const azimuthBO = helpers_1.bearingToAzimuth(options.mercator !== true ? bearing_1.default(B, O) : rhumb_bearing_1.default(B, O));
-    const angleAO = Math.abs(azimuthAO - azimuthBO);
-    // Explementary angle
-    if (options.explementary === true) {
-        return 360 - angleAO;
-    }
-    return angleAO;
-}
-exports.default = angle;