@turf/dissolve 6.5.0 → 7.0.0-alpha.0

package/README.md

@@ -7,67 +7,40 @@
 Dissolves a FeatureCollection of [polygon][1] features, filtered by an optional property name:value.
 Note that [mulitpolygon][2] features within the collection are not supported
 
-**Parameters**
+### Parameters
 
-- `featureCollection` **[FeatureCollection][3]<[Polygon][4]>** input feature collection to be dissolved
-- `options` **[Object][5]** Optional parameters (optional, default `{}`)
-  - `options.propertyName` **[string][6]?** features with equals 'propertyName' in `properties` will be merged
+*   `featureCollection` **[FeatureCollection][3]<[Polygon][4]>** input feature collection to be dissolved
+*   `options` **[Object][5]** Optional parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.propertyName` **[string][6]?** features with the same `propertyName` value will be dissolved.
+
+### Examples
 
 ```javascript
 var features = turf.featureCollection([
-  turf.polygon(
-    [
-      [
-        [0, 0],
-        [0, 1],
-        [1, 1],
-        [1, 0],
-        [0, 0],
-      ],
-    ],
-    { combine: "yes" }
-  ),
-  turf.polygon(
-    [
-      [
-        [0, -1],
-        [0, 0],
-        [1, 0],
-        [1, -1],
-        [0, -1],
-      ],
-    ],
-    { combine: "yes" }
-  ),
-  turf.polygon(
-    [
-      [
-        [1, -1],
-        [1, 0],
-        [2, 0],
-        [2, -1],
-        [1, -1],
-      ],
-    ],
-    { combine: "no" }
-  ),
+  turf.polygon([[[0, 0], [0, 1], [1, 1], [1, 0], [0, 0]]], {combine: 'yes'}),
+  turf.polygon([[[0, -1], [0, 0], [1, 0], [1, -1], [0,-1]]], {combine: 'yes'}),
+  turf.polygon([[[1,-1],[1, 0], [2, 0], [2, -1], [1, -1]]], {combine: 'no'}),
 ]);
 
-var dissolved = turf.dissolve(features, { propertyName: "combine" });
+var dissolved = turf.dissolve(features, {propertyName: 'combine'});
 
 //addToMap
-var addToMap = [features, dissolved];
+var addToMap = [features, dissolved]
 ```
 
-Returns **[FeatureCollection][3]&lt;[Polygon][4]>** a FeatureCollection containing the dissolved polygons
+Returns **[FeatureCollection][3]<[Polygon][4]>** a FeatureCollection containing the dissolved polygons
 
 [1]: polygon
+
 [2]: mulitpolygon
+
 [3]: https://tools.ietf.org/html/rfc7946#section-3.3
+
 [4]: https://tools.ietf.org/html/rfc7946#section-3.1.6
+
 [5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
 [6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
 <!-- This file is automatically generated. Please don't edit it directly:

package/index.d.ts

@@ -1,4 +1,4 @@
-import { FeatureCollection, Polygon } from "@turf/helpers";
+import { FeatureCollection, Polygon } from "geojson";
 
 /**
  * http://turfjs.org/docs.html#dissolve

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/dissolve",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf dissolve module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -54,10 +54,11 @@
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/helpers": "^6.5.0",
-    "@turf/invariant": "^6.5.0",
-    "@turf/meta": "^6.5.0",
+    "@turf/flatten": "^7.0.0-alpha.0",
+    "@turf/helpers": "^7.0.0-alpha.0",
+    "@turf/invariant": "^7.0.0-alpha.0",
+    "@turf/meta": "^7.0.0-alpha.0",
     "polygon-clipping": "^0.15.3"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
 }