Merge pull request #11 from juanpujol/develop

Release v0.1.3

.gitignore

@@ -7,4 +7,5 @@ node_modules/
 .eslintcache
 .env
 dist
+tests/output
 NOTES.md

.vscode/settings.json

@@ -5,6 +5,7 @@
 		"fbbox",
 		"geospatial",
 		"juanpujol",
+		"radiusInKm",
 		"mutipolygons",
 		"polyunion",
 		"rbush",

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 # PolyUnion Changelog
 
+## v0.1.3 (2024-03-25)
+
+### Fixes 🐞
+
+- Fixes bug were turf intersect will throw an error that should't break the function response. #10 - Thanks ♥️ https://github.com/AbraaoAlves and https://github.com/lamartinecabral
+
 ## v0.1.2 (2024-03-12)
 
 ### Fixes 🐞

README.md

@@ -1,8 +1,8 @@
 # PolyUnion
 
-A fast and efficient js utility function designed for merging multiple polygons within a GeoJSON FeatureCollection. It utilizes spatial indexing provided by **[rbush](https://github.com/mourner/rbush)** and the geospatial processing of **[Turfjs](https://github.com/Turfjs/turf)** to achieve high performance.
+A fast and efficient Javascript utility function designed to mergE multiple polygons into a GeoJSON FeatureCollection. It utilizes spatial indexing provided by **[rbush](https://github.com/mourner/rbush)** and the geospatial processing of **[Turfjs](https://github.com/Turfjs/turf)** to achieve high performance.
 
-## Performance
+## How fast?
 
 When attempting to merge approximately 1000 circle-shaped polygons using only @turf/union, it took approximately 25 seconds. In contrast, PolyUnion completed the same task in about 350 milliseconds.
 
@@ -45,14 +45,14 @@ const features = {
 };
 
 // Merge polygons
-const mergedFeatureCollection = polyunion(features);
+const mergedFeatureCollection = polyunion(features, 2);
 
 console.log(mergedFeatureCollection);
 ```
 
 The function has 2 parameters:
 
-- `featureCollection` (required): A GeoJSON FeatureCollection containing polygons to merge.
+- `fc` (required): A GeoJSON FeatureCollection containing polygons to merge (make sure the polygons are valid).
 - `totalPasses` (optional, defaults to 3): The total number of passes for recursive calls. Increasing the number of iterations can improve the results, but it will also prolong the execution time. It depends on the number of polygons being merged. For the case in the picture above, 4 passes worked great (350ms).
 
 ## Credits

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "polyunion",
-	"version": "0.1.2",
+	"version": "0.1.3",
 	"description": "A fast and efficient library for merging multiple polygons in a GeoJSON FeatureCollection",
 	"type": "module",
 	"main": "./dist/index.js",
@@ -37,6 +37,8 @@
 		"rbush": "^3.0.1"
 	},
 	"devDependencies": {
+		"@turf/circle": "^6.5.0",
+		"@types/node": "^20.11.30",
 		"@types/rbush": "^3.0.3",
 		"@typescript-eslint/eslint-plugin": "^7.2.0",
 		"eslint": "^8.57.0",
@@ -46,4 +48,4 @@
 		"typescript": "^5.3.3",
 		"vitest": "^1.3.1"
 	}
-}
+}

src/index.ts

@@ -82,16 +82,22 @@ function polyunionPass(
 
 			const targetFeature = fc.features[candidate.id];
 
-			if (
-				intersect(mergeCandidate, targetFeature) ||
-				booleanOverlap(mergeCandidate, targetFeature)
-			) {
-				mergeCandidate = union(mergeCandidate, targetFeature) as Feature<Polygon>;
-				processed.add(candidate.id);
+			// Attempt to merge the two features if they intersect or overlap
+			try {
+				if (
+					intersect(mergeCandidate, targetFeature) ||
+					booleanOverlap(mergeCandidate, targetFeature)
+				) {
+					mergeCandidate = union(mergeCandidate, targetFeature) as Feature<Polygon>;
+					processed.add(candidate.id);
+				}
+			} catch (err) {
+				console.error('Polyunion error =>', err);
 			}
 		});
 
 		mergedFeatures.push(mergeCandidate);
+
 		processed.add(index);
 	});