@turf/intersect 6.4.0 → 7.0.0-alpha.0

package/README.md

@@ -4,16 +4,17 @@
 
 ## intersect
 
-Takes two [polygon][1] or [multi-polygon][2] geometries and finds their polygonal intersection. If they don't intersect, returns null.
+Takes [polygon][1] or [multi-polygon][2] geometries and
+finds their polygonal intersection. If they don't intersect, returns null.
 
-**Parameters**
+### Parameters
 
--   `poly1` **[Feature][3]<([Polygon][4] \| [MultiPolygon][5])>** the first polygon or multipolygon
--   `poly2` **[Feature][3]<([Polygon][4] \| [MultiPolygon][5])>** the second polygon or multipolygon
--   `options` **[Object][6]** Optional Parameters (optional, default `{}`)
-    -   `options.properties` **[Object][6]** Translate GeoJSON Properties to Feature (optional, default `{}`)
+*   `features` **[FeatureCollection][3]<([Polygon][4] | [MultiPolygon][5])>** the features to intersect
+*   `options` **[Object][6]** Optional Parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.properties` **[Object][6]** Translate GeoJSON Properties to Feature (optional, default `{}`)
+
+### Examples
 
 ```javascript
 var poly1 = turf.polygon([[
@@ -35,19 +36,20 @@ var poly2 = turf.polygon([[
   [-122.520217, 45.535693]
 ]]);
 
-var intersection = turf.intersect(poly1, poly2);
+var intersection = turf.intersect(turf.featureCollection([poly1, poly2]));
 
 //addToMap
 var addToMap = [poly1, poly2, intersection];
 ```
 
-Returns **([Feature][3] | null)** returns a feature representing the area they share (either a [Polygon][1] or [MultiPolygon][2]). If they do not share any area, returns `null`.
+Returns **([Feature][7] | null)** returns a feature representing the area they share (either a [Polygon][1] or
+[MultiPolygon][2]). If they do not share any area, returns `null`.
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.1.6
 
 [2]: https://tools.ietf.org/html/rfc7946#section-3.1.7
 
-[3]: https://tools.ietf.org/html/rfc7946#section-3.2
+[3]: https://tools.ietf.org/html/rfc7946#section-3.3
 
 [4]: https://tools.ietf.org/html/rfc7946#section-3.1.6
 
@@ -55,6 +57,8 @@ Returns **([Feature][3] | null)** returns a feature representing the area they s
 
 [6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
 
+[7]: https://tools.ietf.org/html/rfc7946#section-3.2
+
 <!-- 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. -->

package/dist/es/index.js

@@ -1,13 +1,12 @@
-import { multiPolygon, polygon, } from "@turf/helpers";
-import { getGeom } from "@turf/invariant";
+import { multiPolygon, polygon } from "@turf/helpers";
+import { geomEach } from "@turf/meta";
 import polygonClipping from "polygon-clipping";
 /**
- * Takes two {@link Polygon|polygon} or {@link MultiPolygon|multi-polygon} geometries and
+ * Takes {@link Polygon|polygon} or {@link MultiPolygon|multi-polygon} geometries and
  * finds their polygonal intersection. If they don't intersect, returns null.
  *
  * @name intersect
- * @param {Feature<Polygon | MultiPolygon>} poly1 the first polygon or multipolygon
- * @param {Feature<Polygon | MultiPolygon>} poly2 the second polygon or multipolygon
+ * @param {FeatureCollection<Polygon | MultiPolygon>} features the features to intersect
  * @param {Object} [options={}] Optional Parameters
  * @param {Object} [options.properties={}] Translate GeoJSON Properties to Feature
  * @returns {Feature|null} returns a feature representing the area they share (either a {@link Polygon} or
@@ -32,16 +31,20 @@ import polygonClipping from "polygon-clipping";
  *   [-122.520217, 45.535693]
  * ]]);
  *
- * var intersection = turf.intersect(poly1, poly2);
+ * var intersection = turf.intersect(turf.featureCollection([poly1, poly2]));
  *
  * //addToMap
  * var addToMap = [poly1, poly2, intersection];
  */
-export default function intersect(poly1, poly2, options) {
-    if (options === void 0) { options = {}; }
-    var geom1 = getGeom(poly1);
-    var geom2 = getGeom(poly2);
-    var intersection = polygonClipping.intersection(geom1.coordinates, geom2.coordinates);
+export default function intersect(features, options = {}) {
+    const geoms = [];
+    geomEach(features, (geom) => {
+        geoms.push(geom.coordinates);
+    });
+    if (geoms.length < 2) {
+        throw new Error("Must specify at least 2 geometries");
+    }
+    const intersection = polygonClipping.intersection(geoms[0], ...geoms.slice(1));
     if (intersection.length === 0)
         return null;
     if (intersection.length === 1)

package/dist/js/index.d.ts

@@ -1,11 +1,10 @@
-import { Feature, MultiPolygon, Polygon, Properties } from "@turf/helpers";
+import { Feature, GeoJsonProperties, MultiPolygon, Polygon, FeatureCollection } from "geojson";
 /**
- * Takes two {@link Polygon|polygon} or {@link MultiPolygon|multi-polygon} geometries and
+ * Takes {@link Polygon|polygon} or {@link MultiPolygon|multi-polygon} geometries and
  * finds their polygonal intersection. If they don't intersect, returns null.
  *
  * @name intersect
- * @param {Feature<Polygon | MultiPolygon>} poly1 the first polygon or multipolygon
- * @param {Feature<Polygon | MultiPolygon>} poly2 the second polygon or multipolygon
+ * @param {FeatureCollection<Polygon | MultiPolygon>} features the features to intersect
  * @param {Object} [options={}] Optional Parameters
  * @param {Object} [options.properties={}] Translate GeoJSON Properties to Feature
  * @returns {Feature|null} returns a feature representing the area they share (either a {@link Polygon} or
@@ -30,11 +29,11 @@ import { Feature, MultiPolygon, Polygon, Properties } from "@turf/helpers";
  *   [-122.520217, 45.535693]
  * ]]);
  *
- * var intersection = turf.intersect(poly1, poly2);
+ * var intersection = turf.intersect(turf.featureCollection([poly1, poly2]));
  *
  * //addToMap
  * var addToMap = [poly1, poly2, intersection];
  */
-export default function intersect<P = Properties>(poly1: Feature<Polygon | MultiPolygon> | Polygon | MultiPolygon, poly2: Feature<Polygon | MultiPolygon> | Polygon | MultiPolygon, options?: {
+export default function intersect<P = GeoJsonProperties>(features: FeatureCollection<Polygon | MultiPolygon>, options?: {
     properties?: P;
 }): Feature<Polygon | MultiPolygon, P> | null;

package/dist/js/index.js

@@ -1,18 +1,15 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var helpers_1 = require("@turf/helpers");
-var invariant_1 = require("@turf/invariant");
-var polygon_clipping_1 = __importDefault(require("polygon-clipping"));
+const tslib_1 = require("tslib");
+const helpers_1 = require("@turf/helpers");
+const meta_1 = require("@turf/meta");
+const polygon_clipping_1 = tslib_1.__importDefault(require("polygon-clipping"));
 /**
- * Takes two {@link Polygon|polygon} or {@link MultiPolygon|multi-polygon} geometries and
+ * Takes {@link Polygon|polygon} or {@link MultiPolygon|multi-polygon} geometries and
  * finds their polygonal intersection. If they don't intersect, returns null.
  *
  * @name intersect
- * @param {Feature<Polygon | MultiPolygon>} poly1 the first polygon or multipolygon
- * @param {Feature<Polygon | MultiPolygon>} poly2 the second polygon or multipolygon
+ * @param {FeatureCollection<Polygon | MultiPolygon>} features the features to intersect
  * @param {Object} [options={}] Optional Parameters
  * @param {Object} [options.properties={}] Translate GeoJSON Properties to Feature
  * @returns {Feature|null} returns a feature representing the area they share (either a {@link Polygon} or
@@ -37,16 +34,20 @@ var polygon_clipping_1 = __importDefault(require("polygon-clipping"));
  *   [-122.520217, 45.535693]
  * ]]);
  *
- * var intersection = turf.intersect(poly1, poly2);
+ * var intersection = turf.intersect(turf.featureCollection([poly1, poly2]));
  *
  * //addToMap
  * var addToMap = [poly1, poly2, intersection];
  */
-function intersect(poly1, poly2, options) {
-    if (options === void 0) { options = {}; }
-    var geom1 = invariant_1.getGeom(poly1);
-    var geom2 = invariant_1.getGeom(poly2);
-    var intersection = polygon_clipping_1.default.intersection(geom1.coordinates, geom2.coordinates);
+function intersect(features, options = {}) {
+    const geoms = [];
+    meta_1.geomEach(features, (geom) => {
+        geoms.push(geom.coordinates);
+    });
+    if (geoms.length < 2) {
+        throw new Error("Must specify at least 2 geometries");
+    }
+    const intersection = polygon_clipping_1.default.intersection(geoms[0], ...geoms.slice(1));
     if (intersection.length === 0)
         return null;
     if (intersection.length === 1)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/intersect",
-  "version": "6.4.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf intersect module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -12,6 +12,7 @@
     "type": "git",
     "url": "git://github.com/Turfjs/turf.git"
   },
+  "funding": "https://opencollective.com/turf",
   "publishConfig": {
     "access": "public"
   },
@@ -42,7 +43,7 @@
     "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": {
     "@types/tape": "*",
@@ -57,9 +58,10 @@
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/helpers": "^6.4.0",
-    "@turf/invariant": "^6.4.0",
-    "polygon-clipping": "^0.15.2"
+    "@turf/helpers": "^7.0.0-alpha.0",
+    "@turf/meta": "^7.0.0-alpha.0",
+    "polygon-clipping": "^0.15.3",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "1e62773cfc88c627cca8effcb5c14cfb65a905ac"
+  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
 }