@turf/difference 4.6.0 → 4.7.4

package/README.md

@@ -39,17 +39,7 @@ var difference = turf.difference(polygon1, polygon2);
 var addToMap = [polygon1, polygon2, difference];
 ```
 
-Returns **([Feature](http://geojson.org/geojson-spec.html#feature-objects)<([Polygon](http://geojson.org/geojson-spec.html#polygon) \| [MultiPolygon](http://geojson.org/geojson-spec.html#multipolygon))> | [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** a Polygon or MultiPolygon feature showing the area of `polygon1` excluding the area of `polygon2` (if empty returns `undefined`)
-
-# removeEmptyPolygon
-
-Detect Empty Polygon
-
-**Parameters**
-
--   `geom` **[Geometry](http://geojson.org/geojson-spec.html#geometry)<([Polygon](http://geojson.org/geojson-spec.html#polygon) \| [MultiPolygon](http://geojson.org/geojson-spec.html#multipolygon))>** Geometry Object
-
-Returns **([Geometry](http://geojson.org/geojson-spec.html#geometry)<([Polygon](http://geojson.org/geojson-spec.html#polygon) \| [MultiPolygon](http://geojson.org/geojson-spec.html#multipolygon))> | [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** removed any polygons with no areas
+Returns **([Feature](http://geojson.org/geojson-spec.html#feature-objects)<([Polygon](http://geojson.org/geojson-spec.html#polygon) \| [MultiPolygon](http://geojson.org/geojson-spec.html#multipolygon))> | [null](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/null))** a Polygon or MultiPolygon feature showing the area of `polygon1` excluding the area of `polygon2` (if empty returns `null`)
 
 <!-- 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

package/index.d.ts

@@ -3,7 +3,7 @@
 import {Polygon, MultiPolygon, Feature} from '@turf/meta'
 
 type Input = Feature<Polygon|MultiPolygon> | Polygon | MultiPolygon;
-type Output = Feature<Polygon|MultiPolygon> | undefined;
+type Output = Feature<Polygon|MultiPolygon> | null;
 
 /**
  * http://turfjs.org/docs/#difference

package/index.js

@@ -11,7 +11,7 @@ var flattenEach = require('@turf/meta').flattenEach;
  * @name difference
  * @param {Feature<Polygon|MultiPolygon>} polygon1 input Polygon feature
  * @param {Feature<Polygon|MultiPolygon>} polygon2 Polygon feature to difference from polygon1
- * @returns {Feature<Polygon|MultiPolygon>|undefined} a Polygon or MultiPolygon feature showing the area of `polygon1` excluding the area of `polygon2` (if empty returns `undefined`)
+ * @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([[
  *   [128, -26],
@@ -47,7 +47,7 @@ module.exports = function (polygon1, polygon2) {
     // Issue #721 - JSTS can't handle empty polygons
     geom1 = removeEmptyPolygon(geom1);
     geom2 = removeEmptyPolygon(geom2);
-    if (!geom1) return undefined;
+    if (!geom1) return null;
     if (!geom2) return feature(geom1, properties);
 
     // JSTS difference operation
@@ -55,7 +55,7 @@ module.exports = function (polygon1, polygon2) {
     var a = reader.read(geom1);
     var b = reader.read(geom2);
     var differenced = a.difference(b);
-    if (differenced.isEmpty()) return undefined;
+    if (differenced.isEmpty()) return null;
     var writer = new jsts.io.GeoJSONWriter();
     var geom = writer.write(differenced);
 
@@ -65,14 +65,15 @@ module.exports = function (polygon1, polygon2) {
 /**
  * Detect Empty Polygon
  *
+ * @private
  * @param {Geometry<Polygon|MultiPolygon>} geom Geometry Object
- * @returns {Geometry<Polygon|MultiPolygon>|undefined} removed any polygons with no areas
+ * @returns {Geometry<Polygon|MultiPolygon>|null} removed any polygons with no areas
  */
 function removeEmptyPolygon(geom) {
     switch (geom.type) {
     case 'Polygon':
         if (area(geom) > 1) return geom;
-        return undefined;
+        return null;
     case 'MultiPolygon':
         var coordinates = [];
         flattenEach(geom, function (feature) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/difference",
-  "version": "4.6.0",
+  "version": "4.7.4",
   "description": "turf difference module",
   "main": "index.js",
   "types": "index.d.ts",
@@ -34,10 +34,10 @@
     "write-json-file": "^2.0.0"
   },
   "dependencies": {
-    "@turf/area": "^4.6.0",
-    "@turf/helpers": "^4.6.0",
-    "@turf/invariant": "^4.6.0",
-    "@turf/meta": "^4.6.0",
+    "@turf/area": "^4.7.3",
+    "@turf/helpers": "^4.7.3",
+    "@turf/invariant": "^4.7.3",
+    "@turf/meta": "^4.7.3",
     "jsts": "1.3.0"
   }
 }