@turf/difference 6.4.0 → 7.0.0-alpha.0

package/README.md

@@ -4,14 +4,13 @@
 
 ## difference
 
-Finds the difference between two [polygons][1] by clipping the second polygon from the first.
+Finds the difference between multiple [polygons][1] by clipping the subsequent polygon from the first.
 
-**Parameters**
+### Parameters
 
--   `polygon1` **[Feature][2]<([Polygon][3] \| [MultiPolygon][4])>** input Polygon feature
--   `polygon2` **[Feature][2]<([Polygon][3] \| [MultiPolygon][4])>** Polygon feature to difference from polygon1
+*   `features` **[FeatureCollection][2]<([Polygon][3] | [MultiPolygon][4])>** input Polygon features
 
-**Examples**
+### Examples
 
 ```javascript
 var polygon1 = turf.polygon([[
@@ -35,22 +34,24 @@ var polygon2 = turf.polygon([[
   "fill-opacity": 0.1
 });
 
-var difference = turf.difference(polygon1, polygon2);
+var difference = turf.difference(turf.featureCollection([polygon1, polygon2]));
 
 //addToMap
 var addToMap = [polygon1, polygon2, difference];
 ```
 
-Returns **([Feature][2]&lt;([Polygon][3] \| [MultiPolygon][4])> | null)** a Polygon or MultiPolygon feature showing the area of `polygon1` excluding the area of `polygon2` (if empty returns `null`)
+Returns **([Feature][5]<([Polygon][3] | [MultiPolygon][4])> | null)** a Polygon or MultiPolygon feature showing the area of `polygon1` excluding the area of `polygon2` (if empty returns `null`)
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.1.6
 
-[2]: https://tools.ietf.org/html/rfc7946#section-3.2
+[2]: https://tools.ietf.org/html/rfc7946#section-3.3
 
 [3]: https://tools.ietf.org/html/rfc7946#section-3.1.6
 
 [4]: https://tools.ietf.org/html/rfc7946#section-3.1.7
 
+[5]: 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 polygonClipping from 'polygon-clipping';
 import { polygon, multiPolygon } from '@turf/helpers';
-import { getGeom } from '@turf/invariant';
+import { geomEach } from '@turf/meta';
 
 /**
- * Finds the difference between two {@link Polygon|polygons} by clipping the second polygon from the first.
+ * Finds the difference between multiple {@link Polygon|polygons} by clipping the subsequent polygon from the first.
  *
  * @name difference
- * @param {Feature<Polygon|MultiPolygon>} polygon1 input Polygon feature
- * @param {Feature<Polygon|MultiPolygon>} polygon2 Polygon feature to difference from polygon1
+ * @param {FeatureCollection<Polygon|MultiPolygon>} features input Polygon features
  * @returns {Feature<Polygon|MultiPolygon>|null} a Polygon or MultiPolygon feature showing the area of `polygon1` excluding the area of `polygon2` (if empty returns `null`)
  * @example
  * var polygon1 = turf.polygon([[
@@ -31,20 +30,25 @@ import { getGeom } from '@turf/invariant';
  *   "fill-opacity": 0.1
  * });
  *
- * var difference = turf.difference(polygon1, polygon2);
+ * var difference = turf.difference(turf.featureCollection([polygon1, polygon2]));
  *
  * //addToMap
  * var addToMap = [polygon1, polygon2, difference];
  */
-function difference(polygon1, polygon2) {
-  var geom1 = getGeom(polygon1);
-  var geom2 = getGeom(polygon2);
-  var properties = polygon1.properties || {};
+function difference(features) {
+  const geoms = [];
 
-  var differenced = polygonClipping.difference(
-    geom1.coordinates,
-    geom2.coordinates
-  );
+  geomEach(features, (geom) => {
+    geoms.push(geom.coordinates);
+  });
+
+  if (geoms.length < 2) {
+    throw new Error("Must have at least two features");
+  }
+
+  var properties = features.features[0].properties || {};
+
+  var differenced = polygonClipping.difference(geoms[0], ...geoms.slice(1));
   if (differenced.length === 0) return null;
   if (differenced.length === 1) return polygon(differenced[0], properties);
   return multiPolygon(differenced, properties);

package/dist/js/index.js

@@ -1,17 +1,18 @@
 'use strict';
 
-function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
-
-var polygonClipping = _interopDefault(require('polygon-clipping'));
+var polygonClipping = require('polygon-clipping');
 var helpers = require('@turf/helpers');
-var invariant = require('@turf/invariant');
+var meta = require('@turf/meta');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var polygonClipping__default = /*#__PURE__*/_interopDefaultLegacy(polygonClipping);
 
 /**
- * Finds the difference between two {@link Polygon|polygons} by clipping the second polygon from the first.
+ * Finds the difference between multiple {@link Polygon|polygons} by clipping the subsequent polygon from the first.
  *
  * @name difference
- * @param {Feature<Polygon|MultiPolygon>} polygon1 input Polygon feature
- * @param {Feature<Polygon|MultiPolygon>} polygon2 Polygon feature to difference from polygon1
+ * @param {FeatureCollection<Polygon|MultiPolygon>} features input Polygon features
  * @returns {Feature<Polygon|MultiPolygon>|null} a Polygon or MultiPolygon feature showing the area of `polygon1` excluding the area of `polygon2` (if empty returns `null`)
  * @example
  * var polygon1 = turf.polygon([[
@@ -35,23 +36,29 @@ var invariant = require('@turf/invariant');
  *   "fill-opacity": 0.1
  * });
  *
- * var difference = turf.difference(polygon1, polygon2);
+ * var difference = turf.difference(turf.featureCollection([polygon1, polygon2]));
  *
  * //addToMap
  * var addToMap = [polygon1, polygon2, difference];
  */
-function difference(polygon1, polygon2) {
-  var geom1 = invariant.getGeom(polygon1);
-  var geom2 = invariant.getGeom(polygon2);
-  var properties = polygon1.properties || {};
-
-  var differenced = polygonClipping.difference(
-    geom1.coordinates,
-    geom2.coordinates
-  );
+function difference(features) {
+  const geoms = [];
+
+  meta.geomEach(features, (geom) => {
+    geoms.push(geom.coordinates);
+  });
+
+  if (geoms.length < 2) {
+    throw new Error("Must have at least two features");
+  }
+
+  var properties = features.features[0].properties || {};
+
+  var differenced = polygonClipping__default['default'].difference(geoms[0], ...geoms.slice(1));
   if (differenced.length === 0) return null;
   if (differenced.length === 1) return helpers.polygon(differenced[0], properties);
   return helpers.multiPolygon(differenced, properties);
 }
 
 module.exports = difference;
+module.exports.default = difference;

package/index.d.ts

@@ -1,9 +1,8 @@
-import { Polygon, MultiPolygon, Feature } from "@turf/helpers";
+import { Polygon, MultiPolygon, Feature, FeatureCollection } from "geojson";
 
 /**
  * http://turfjs.org/docs/#difference
  */
 export default function difference(
-  polygon1: Feature<Polygon | MultiPolygon> | Polygon | MultiPolygon,
-  polygon2: Feature<Polygon | MultiPolygon> | Polygon | MultiPolygon
+  features: FeatureCollection<Polygon | MultiPolygon>
 ): Feature<Polygon | MultiPolygon> | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/difference",
-  "version": "6.4.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf difference 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"
   },
@@ -51,9 +52,9 @@
     "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"
   },
-  "gitHead": "1e62773cfc88c627cca8effcb5c14cfb65a905ac"
+  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
 }