turf-union - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

bench.js

@@ -5,3 +5,3 @@ var union = require('./');
 
-var fcs = JSON.parse(fs.readFileSync(__dirname+'/test/fixtures/in/Intersect1.json'));
+var fcs = JSON.parse(fs.readFileSync(__dirname+'/test/fixtures/in/Intersect1.geojson'));
 
@@ -17,4 +17,4 @@ var suite = new Benchmark.Suite('turf-union');
   .on('complete', function () {
-    
+
   })
-  .run();
+  .run();

index.js

@@ -9,9 +9,9 @@ // look here for help http://svn.osgeo.org/grass/grass/branches/releasebranch_6_4/vector/v.overlay/main.c
 /**
- * Takes two {@link Polygon} features and returnes a combined {@link Polygon} feature. If the input Polygon features are not contiguous, this function returns a {@link MultiPolygon} feature.
+ * Takes two {@link Polygon|polygons} and returns a combined polygon. If the input polygons are not contiguous, this function returns a {@link MultiPolygon} feature.
  *
  * @module turf/union
  * @category transformation
- * @param {Polygon} poly1 an input Polygon
- * @param {Polygon} poly2 another input Polygon
- * @return {Feature} a combined {@link Polygon} or {@link MultiPolygon} feature
+ * @param {Feature<Polygon>} poly1 input polygon
+ * @param {Feature<Polygon>} poly2 another input polygon
+ * @return {Feature<(Polygon|MultiPolygon)>} a combined {@link Polygon} or {@link MultiPolygon} feature
  * @example
@@ -18,0 +18,0 @@ * var poly1 = {

package.json

 {
   "name": "turf-union",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "find the union of geographic features",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -10,3 +10,3 @@ # turf-union
 
-Takes two polygons and combines them into one polgyon.
+Takes two Polygon|polygons and returns a combined polygon. If the input polygons are not contiguous, this function returns a MultiPolygon feature.
 
@@ -16,6 +16,6 @@
 
-| parameter | type    | description           |
-| --------- | ------- | --------------------- |
-| `poly1`   | Polygon | an input Polygon      |
-| `poly2`   | Polygon | another input Polygon |
+| parameter | type                 | description           |
+| --------- | -------------------- | --------------------- |
+| `poly1`   | Feature\.\<Polygon\> | input polygon         |
+| `poly2`   | Feature\.\<Polygon\> | another input polygon |
 
@@ -26,23 +26,42 @@
 ```js
-var poly1 = turf.polygon([[
- [-82.574787, 35.594087],
- [-82.574787, 35.615581],
- [-82.545261, 35.615581],
- [-82.545261, 35.594087],
- [-82.574787, 35.594087]
-]]);
-poly1.properties.fill = '#0f0';
-var poly2 = turf.polygon([[
- [-82.560024, 35.585153],
- [-82.560024, 35.602602],
- [-82.52964, 35.602602],
- [-82.52964, 35.585153],
- [-82.560024, 35.585153]
-]]);
-poly2.properties.fill = '#00f';
-var polyFC = turf.featurecollection([poly1, poly2]);
+var poly1 = {
+  "type": "Feature",
+  "properties": {
+    "fill": "#0f0"
+  },
+  "geometry": {
+    "type": "Polygon",
+    "coordinates": [[
+      [-82.574787, 35.594087],
+      [-82.574787, 35.615581],
+      [-82.545261, 35.615581],
+      [-82.545261, 35.594087],
+      [-82.574787, 35.594087]
+    ]]
+  }
+};
+var poly2 = {
+  "type": "Feature",
+  "properties": {
+    "fill": "#00f"
+  },
+  "geometry": {
+    "type": "Polygon",
+    "coordinates": [[
+      [-82.560024, 35.585153],
+      [-82.560024, 35.602602],
+      [-82.52964, 35.602602],
+      [-82.52964, 35.585153],
+      [-82.560024, 35.585153]
+    ]]
+  }
+};
+var polygons = {
+  "type": "FeatureCollection",
+  "features": [poly1, poly2]
+};
 
 var union = turf.union(poly1, poly2);
 
-//=polyFC
+//=polygons
 
@@ -52,2 +71,5 @@ //=union
 
+
+**Returns** `Feature.<Polygon|MultiPolygon>`, a combined Polygon or MultiPolygon feature
+
 ## Installation
@@ -67,1 +89,2 @@
 
+

New alerts

NPM Shrinkwrap

Supply chain risk

Package contains a shrinkwrap file. This may allow the package to bypass normal install procedures.

Found 1 instance in 1 package

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11998

increased by8.42%

Number of package files

11

increased by10%

Lines of code

115

increased by18.56%

Number of lines in readme file

86

increased by36.51%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Number of high supply chain risk alerts

1

increased byInfinity%

No dependency changes