Migrate @turf/line-chunk to TypeScript

packages/turf-line-chunk/index.js → packages/turf-line-chunk/index.ts

@@ -1,7 +1,14 @@
 import { length } from "@turf/length";
 import { lineSliceAlong } from "@turf/line-slice-along";
 import { flattenEach } from "@turf/meta";
-import { featureCollection, isObject } from "@turf/helpers";
+import { featureCollection, isObject, Units } from "@turf/helpers";
+import {
+  Feature,
+  FeatureCollection,
+  GeometryCollection,
+  LineString,
+  MultiLineString,
+} from "geojson";
 
 /**
  * Divides a {@link LineString} into chunks of a specified length.
@@ -22,30 +29,47 @@ import { featureCollection, isObject } from "@turf/helpers";
  * //addToMap
  * var addToMap = [chunk];
  */
-function lineChunk(geojson, segmentLength, options) {
+function lineChunk<T extends LineString | MultiLineString>(
+  geojson:
+    | Feature<T>
+    | FeatureCollection<T>
+    | T
+    | GeometryCollection
+    | Feature<GeometryCollection>,
+  segmentLength: number,
+  options: {
+    units?: Units;
+    reverse?: boolean;
+  } = {}
+): FeatureCollection<LineString> {
   // Optional parameters
-  options = options || {};
   if (!isObject(options)) throw new Error("options is invalid");
-  var units = options.units;
-  var reverse = options.reverse;
+  const { units = "kilometers", reverse = false } = options;
 
   // Validation
   if (!geojson) throw new Error("geojson is required");
-  if (segmentLength <= 0)
+  if (segmentLength <= 0) {
     throw new Error("segmentLength must be greater than 0");
+  }
 
   // Container
-  var results = [];
+  const results: Feature<LineString>[] = [];
 
   // Flatten each feature to simple LineString
-  flattenEach(geojson, function (feature) {
+  flattenEach(geojson, (feature: Feature<T>) => {
     // reverses coordinates to start the first chunked segment at the end
-    if (reverse)
+    if (reverse) {
       feature.geometry.coordinates = feature.geometry.coordinates.reverse();
+    }
 
-    sliceLineSegments(feature, segmentLength, units, function (segment) {
-      results.push(segment);
-    });
+    sliceLineSegments(
+      feature as Feature<LineString>,
+      segmentLength,
+      units,
+      (segment) => {
+        results.push(segment);
+      }
+    );
   });
   return featureCollection(results);
 }
@@ -60,11 +84,18 @@ function lineChunk(geojson, segmentLength, options) {
  * @param {Function} callback iterate over sliced line segments
  * @returns {void}
  */
-function sliceLineSegments(line, segmentLength, units, callback) {
+function sliceLineSegments(
+  line: Feature<LineString>,
+  segmentLength: number,
+  units: Units,
+  callback: (feature: Feature<LineString>) => void
+): void {
   var lineLength = length(line, { units: units });
 
   // If the line is shorter than the segment length then the orginal line is returned.
-  if (lineLength <= segmentLength) return callback(line);
+  if (lineLength <= segmentLength) {
+    return callback(line);
+  }
 
   var numberOfSegments = lineLength / segmentLength;
 
@@ -80,7 +111,7 @@ function sliceLineSegments(line, segmentLength, units, callback) {
       segmentLength * (i + 1),
       { units: units }
     );
-    callback(outline, i);
+    callback(outline);
   }
 }
 

packages/turf-line-chunk/package.json

@@ -67,13 +67,15 @@
     "tape": "^5.9.0",
     "tsup": "^8.4.0",
     "tsx": "^4.19.4",
+    "typescript": "^5.8.3",
     "write-json-file": "^6.0.0"
   },
   "dependencies": {
     "@turf/helpers": "workspace:*",
     "@turf/length": "workspace:*",
     "@turf/line-slice-along": "workspace:*",
     "@turf/meta": "workspace:*",
-    "@types/geojson": "^7946.0.10"
+    "@types/geojson": "^7946.0.10",
+    "tslib": "^2.8.1"
   }
 }

packages/turf-line-chunk/test.ts

@@ -6,8 +6,14 @@ import { loadJsonFileSync } from "load-json-file";
 import { writeJsonFileSync } from "write-json-file";
 import { truncate } from "@turf/truncate";
 import { featureEach } from "@turf/meta";
-import { lineString, featureCollection } from "@turf/helpers";
+import {
+  lineString,
+  featureCollection,
+  point,
+  geometryCollection,
+} from "@turf/helpers";
 import { lineChunk } from "./index.js";
+import { Feature } from "geojson";
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
@@ -17,7 +23,10 @@ const directories = {
 };
 
 const fixtures = fs.readdirSync(directories.in).map((filename) => {
-  return { filename, geojson: loadJsonFileSync(directories.in + filename) };
+  return {
+    filename,
+    geojson: loadJsonFileSync(directories.in + filename) as any,
+  };
 });
 
 test("turf-line-chunk: shorter", (t) => {
@@ -103,8 +112,8 @@ test("turf-line-chunk: Prevent input mutation", (t) => {
  * @param {FeatureCollection|Feature<any>} geojson Feature or FeatureCollection
  * @returns {FeatureCollection<any>} colorized FeatureCollection
  */
-function colorize(geojson) {
-  const results = [];
+function colorize(geojson: any) {
+  const results: Feature[] = [];
   featureEach(geojson, (feature, index) => {
     const r = index % 2 === 0 ? "F" : "0";
     const g = index % 2 === 0 ? "0" : "0";