@turf/union 6.5.0 → 7.0.0-alpha.0

package/README.md

@@ -4,16 +4,16 @@
 
 ## union
 
-Takes two [(Multi)Polygon(s)][1] and returns a combined polygon. If the input polygons are not contiguous, this function returns a [MultiPolygon][2] feature.
+Takes input [(Multi)Polygon(s)][1] and returns a combined polygon. If the input polygons are not contiguous, this function returns a [MultiPolygon][2] feature.
 
-**Parameters**
+### Parameters
 
--   `polygon1` **[Feature][3]<([Polygon][4] \| [MultiPolygon][5])>** input Polygon feature
--   `polygon2` **[Feature][3]<([Polygon][4] \| [MultiPolygon][5])>** Polygon feature to difference from polygon1
--   `options` **[Object][6]** Optional Parameters (optional, default `{}`)
-    -   `options.properties` **[Object][6]** Translate Properties to output Feature (optional, default `{}`)
+*   `polygon1` **[Feature][3]<([Polygon][4] | [MultiPolygon][5])>** input Polygon features
+*   `options` **[Object][6]** Optional Parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.properties` **[Object][6]** Translate Properties to output Feature (optional, default `{}`)
+
+### Examples
 
 ```javascript
 var poly1 = turf.polygon([[
@@ -31,13 +31,13 @@ var poly2 = turf.polygon([[
     [-82.560024, 35.585153]
 ]], {"fill": "#00f"});
 
-var union = turf.union(poly1, poly2);
+var union = turf.union(turf.featureCollection([poly1, poly2]));
 
 //addToMap
 var addToMap = [poly1, poly2, union];
 ```
 
-Returns **[Feature][3]&lt;([Polygon][4] \| [MultiPolygon][5])>** a combined [Polygon][1] or [MultiPolygon][2] feature
+Returns **[Feature][3]<([Polygon][4] | [MultiPolygon][5])>** a combined [Polygon][1] or [MultiPolygon][2] feature, or null if the inputs are empty
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.1.6
 

package/dist/es/index.js

@@ -1,12 +1,11 @@
 import polygonClipping from "polygon-clipping";
-import { getGeom } from "@turf/invariant";
 import { multiPolygon, polygon } from "@turf/helpers";
+import { geomEach } from "@turf/meta";
 /**
- * Takes two {@link (Multi)Polygon(s)} and returns a combined polygon. If the input polygons are not contiguous, this function returns a {@link MultiPolygon} feature.
+ * Takes input {@link (Multi)Polygon(s)} and returns a combined polygon. If the input polygons are not contiguous, this function returns a {@link MultiPolygon} feature.
  *
  * @name union
- * @param {Feature<Polygon|MultiPolygon>} polygon1 input Polygon feature
- * @param {Feature<Polygon|MultiPolygon>} polygon2 Polygon feature to difference from polygon1
+ * @param {Feature<Polygon|MultiPolygon>} polygon1 input Polygon features
  * @param {Object} [options={}] Optional Parameters
  * @param {Object} [options.properties={}] Translate Properties to output Feature
  * @returns {Feature<(Polygon|MultiPolygon)>} a combined {@link Polygon} or {@link MultiPolygon} feature, or null if the inputs are empty
@@ -26,16 +25,20 @@ import { multiPolygon, polygon } from "@turf/helpers";
  *     [-82.560024, 35.585153]
  * ]], {"fill": "#00f"});
  *
- * var union = turf.union(poly1, poly2);
+ * var union = turf.union(turf.featureCollection([poly1, poly2]));
  *
  * //addToMap
  * var addToMap = [poly1, poly2, union];
  */
-function union(poly1, poly2, options) {
-    if (options === void 0) { options = {}; }
-    var geom1 = getGeom(poly1);
-    var geom2 = getGeom(poly2);
-    var unioned = polygonClipping.union(geom1.coordinates, geom2.coordinates);
+function union(features, options = {}) {
+    const geoms = [];
+    geomEach(features, (geom) => {
+        geoms.push(geom.coordinates);
+    });
+    if (geoms.length < 2) {
+        throw new Error("Must have at least 2 geometries");
+    }
+    const unioned = polygonClipping.union(geoms[0], ...geoms.slice(1));
     if (unioned.length === 0)
         return null;
     if (unioned.length === 1)

package/dist/js/index.d.ts

@@ -1,10 +1,9 @@
-import { Feature, Polygon, MultiPolygon, Properties } from "@turf/helpers";
+import { FeatureCollection, Feature, Polygon, MultiPolygon, GeoJsonProperties } from "geojson";
 /**
- * Takes two {@link (Multi)Polygon(s)} and returns a combined polygon. If the input polygons are not contiguous, this function returns a {@link MultiPolygon} feature.
+ * Takes input {@link (Multi)Polygon(s)} and returns a combined polygon. If the input polygons are not contiguous, this function returns a {@link MultiPolygon} feature.
  *
  * @name union
- * @param {Feature<Polygon|MultiPolygon>} polygon1 input Polygon feature
- * @param {Feature<Polygon|MultiPolygon>} polygon2 Polygon feature to difference from polygon1
+ * @param {Feature<Polygon|MultiPolygon>} polygon1 input Polygon features
  * @param {Object} [options={}] Optional Parameters
  * @param {Object} [options.properties={}] Translate Properties to output Feature
  * @returns {Feature<(Polygon|MultiPolygon)>} a combined {@link Polygon} or {@link MultiPolygon} feature, or null if the inputs are empty
@@ -24,12 +23,12 @@ import { Feature, Polygon, MultiPolygon, Properties } from "@turf/helpers";
  *     [-82.560024, 35.585153]
  * ]], {"fill": "#00f"});
  *
- * var union = turf.union(poly1, poly2);
+ * var union = turf.union(turf.featureCollection([poly1, poly2]));
  *
  * //addToMap
  * var addToMap = [poly1, poly2, union];
  */
-declare function union<P = Properties>(poly1: Feature<Polygon | MultiPolygon> | Polygon | MultiPolygon, poly2: Feature<Polygon | MultiPolygon> | Polygon | MultiPolygon, options?: {
+declare function union<P = GeoJsonProperties>(features: FeatureCollection<Polygon | MultiPolygon>, options?: {
     properties?: P;
 }): Feature<Polygon | MultiPolygon, P> | null;
 export default union;

package/dist/js/index.js

@@ -1,17 +1,14 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var polygon_clipping_1 = __importDefault(require("polygon-clipping"));
-var invariant_1 = require("@turf/invariant");
-var helpers_1 = require("@turf/helpers");
+const tslib_1 = require("tslib");
+const polygon_clipping_1 = tslib_1.__importDefault(require("polygon-clipping"));
+const helpers_1 = require("@turf/helpers");
+const meta_1 = require("@turf/meta");
 /**
- * Takes two {@link (Multi)Polygon(s)} and returns a combined polygon. If the input polygons are not contiguous, this function returns a {@link MultiPolygon} feature.
+ * Takes input {@link (Multi)Polygon(s)} and returns a combined polygon. If the input polygons are not contiguous, this function returns a {@link MultiPolygon} feature.
  *
  * @name union
- * @param {Feature<Polygon|MultiPolygon>} polygon1 input Polygon feature
- * @param {Feature<Polygon|MultiPolygon>} polygon2 Polygon feature to difference from polygon1
+ * @param {Feature<Polygon|MultiPolygon>} polygon1 input Polygon features
  * @param {Object} [options={}] Optional Parameters
  * @param {Object} [options.properties={}] Translate Properties to output Feature
  * @returns {Feature<(Polygon|MultiPolygon)>} a combined {@link Polygon} or {@link MultiPolygon} feature, or null if the inputs are empty
@@ -31,16 +28,20 @@ var helpers_1 = require("@turf/helpers");
  *     [-82.560024, 35.585153]
  * ]], {"fill": "#00f"});
  *
- * var union = turf.union(poly1, poly2);
+ * var union = turf.union(turf.featureCollection([poly1, poly2]));
  *
  * //addToMap
  * var addToMap = [poly1, poly2, union];
  */
-function union(poly1, poly2, options) {
-    if (options === void 0) { options = {}; }
-    var geom1 = invariant_1.getGeom(poly1);
-    var geom2 = invariant_1.getGeom(poly2);
-    var unioned = polygon_clipping_1.default.union(geom1.coordinates, geom2.coordinates);
+function union(features, options = {}) {
+    const geoms = [];
+    meta_1.geomEach(features, (geom) => {
+        geoms.push(geom.coordinates);
+    });
+    if (geoms.length < 2) {
+        throw new Error("Must have at least 2 geometries");
+    }
+    const unioned = polygon_clipping_1.default.union(geoms[0], ...geoms.slice(1));
     if (unioned.length === 0)
         return null;
     if (unioned.length === 1)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/union",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf union module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -42,10 +42,9 @@
     "docs": "node ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
     "test:tape": "ts-node -r esm test.js",
-    "test:types": "tsc --esModuleInterop --noEmit types.ts"
+    "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
   },
   "devDependencies": {
-    "@turf/combine": "^6.5.0",
     "@types/tape": "*",
     "benchmark": "*",
     "glob": "*",
@@ -58,9 +57,10 @@
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/helpers": "^6.5.0",
-    "@turf/invariant": "^6.5.0",
-    "polygon-clipping": "^0.15.3"
+    "@turf/helpers": "^7.0.0-alpha.0",
+    "@turf/meta": "^7.0.0-alpha.0",
+    "polygon-clipping": "^0.15.3",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
 }