Converted turf-midpoint to Typescript

packages/turf-midpoint/README.md

@@ -4,36 +4,35 @@
 
 ## midpoint
 
-Takes two [points][1] and returns a point midway between them.
-The midpoint is calculated geodesically, meaning the curvature of the earth is taken into account.
+Takes two points and returns a point midway between them. The midpoint is
+calculated geodesically, meaning the curvature of the earth is taken into
+account.
 
 ### Parameters
 
-*   `point1` **[Coord][2]** first point
-*   `point2` **[Coord][2]** second point
+*   `point1` **[Coord][1]** first point
+*   `point2` **[Coord][1]** second point
 
 ### Examples
 
 ```javascript
-var point1 = turf.point([144.834823, -37.771257]);
-var point2 = turf.point([145.14244, -37.830937]);
+const point1 = turf.point([144.834823, -37.771257]);
+const point2 = turf.point([145.14244, -37.830937]);
 
-var midpoint = turf.midpoint(point1, point2);
+const midpoint = turf.midpoint(point1, point2);
 
 //addToMap
-var addToMap = [point1, point2, midpoint];
+const addToMap = [point1, point2, midpoint];
 midpoint.properties['marker-color'] = '#f00';
 ```
 
-Returns **[Feature][3]<[Point][4]>** a point midway between `pt1` and `pt2`
+Returns **[Feature][2]<[Point][3]>** a point midway between `pt1` and `pt2`
 
-[1]: https://tools.ietf.org/html/rfc7946#section-3.1.2
+[1]: https://tools.ietf.org/html/rfc7946#section-3.1.1
 
-[2]: https://tools.ietf.org/html/rfc7946#section-3.1.1
+[2]: https://tools.ietf.org/html/rfc7946#section-3.2
 
-[3]: https://tools.ietf.org/html/rfc7946#section-3.2
-
-[4]: https://tools.ietf.org/html/rfc7946#section-3.1.2
+[3]: 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 of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->
 

packages/turf-midpoint/bench.ts

@@ -1,4 +1,4 @@
-import Benchmark from "benchmark";
+import Benchmark, { Event } from "benchmark";
 import { point } from "@turf/helpers";
 import { midpoint } from "./index.js";
 
@@ -9,7 +9,7 @@ new Benchmark.Suite("turf-midpoint")
   .add("turf-midpoint", function () {
     midpoint(pt1, pt2);
   })
-  .on("cycle", function (event) {
+  .on("cycle", function (event: Event) {
     console.log(String(event.target));
   })
   .run();

packages/turf-midpoint/index.ts

@@ -0,0 +1,35 @@
+import { Feature, Point } from "geojson";
+import { bearing } from "@turf/bearing";
+import { destination } from "@turf/destination";
+import { distance } from "@turf/distance";
+import { Coord } from "@turf/helpers";
+
+/**
+ * Takes two points and returns a point midway between them. The midpoint is
+ * calculated geodesically, meaning the curvature of the earth is taken into
+ * account.
+ *
+ * @name midpoint
+ * @param {Coord} point1 first point
+ * @param {Coord} point2 second point
+ * @returns {Feature<Point>} a point midway between `pt1` and `pt2`
+ * @example
+ * const point1 = turf.point([144.834823, -37.771257]);
+ * const point2 = turf.point([145.14244, -37.830937]);
+ *
+ * const midpoint = turf.midpoint(point1, point2);
+ *
+ * //addToMap
+ * const addToMap = [point1, point2, midpoint];
+ * midpoint.properties['marker-color'] = '#f00';
+ */
+function midpoint(point1: Coord, point2: Coord): Feature<Point> {
+  const dist = distance(point1, point2);
+  const heading = bearing(point1, point2);
+  const midpoint = destination(point1, dist / 2, heading);
+
+  return midpoint;
+}
+
+export { midpoint };
+export default midpoint;

packages/turf-midpoint/package.json

@@ -53,16 +53,20 @@
   },
   "devDependencies": {
     "@types/benchmark": "^2.1.5",
+    "@types/tape": "^4.2.32",
     "benchmark": "^2.1.4",
     "npm-run-all": "^4.1.5",
     "tape": "^5.7.2",
     "tsup": "^8.0.1",
-    "tsx": "^4.6.2"
+    "tsx": "^4.6.2",
+    "typescript": "^5.2.2"
   },
   "dependencies": {
     "@turf/bearing": "workspace:^",
     "@turf/destination": "workspace:^",
     "@turf/distance": "workspace:^",
-    "@turf/helpers": "workspace:^"
+    "@turf/helpers": "workspace:^",
+    "@types/geojson": "7946.0.8",
+    "tslib": "^2.6.2"
   }
 }