@turf/union
Advanced tools
Comparing version 3.0.15 to 3.0.16
{ | ||
"name": "@turf/union", | ||
"version": "3.0.15", | ||
"version": "3.0.16", | ||
"description": "find the union of geographic features", | ||
@@ -11,3 +11,3 @@ "main": "index.js", | ||
"type": "git", | ||
"url": "git@github.com:Turfjs/turf-union.git" | ||
"url": "git://github.com/Turfjs/turf.git" | ||
}, | ||
@@ -21,5 +21,5 @@ "keywords": [ | ||
"bugs": { | ||
"url": "https://github.com/Turfjs/turf-union/issues" | ||
"url": "https://github.com/Turfjs/turf/issues" | ||
}, | ||
"homepage": "https://github.com/Turfjs/turf-union", | ||
"homepage": "https://github.com/Turfjs/turf", | ||
"devDependencies": { | ||
@@ -26,0 +26,0 @@ "benchmark": "^1.0.0", |
@@ -1,11 +0,11 @@ | ||
# turf-union | ||
# @turf/union | ||
# union | ||
Takes two [polygons](Polygon) and returns a combined polygon. If the input polygons are not contiguous, this function returns a [MultiPolygon](MultiPolygon) feature. | ||
Takes two [polygons](http://geojson.org/geojson-spec.html#polygon) and returns a combined polygon. If the input polygons are not contiguous, this function returns a [MultiPolygon](http://geojson.org/geojson-spec.html#multipolygon) feature. | ||
**Parameters** | ||
- `poly1` **Feature<Polygon>** input polygon | ||
- `poly2` **Feature<Polygon>** another input polygon | ||
- `poly1` **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Polygon](http://geojson.org/geojson-spec.html#polygon)>** input polygon | ||
- `poly2` **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Polygon](http://geojson.org/geojson-spec.html#polygon)>** another input polygon | ||
@@ -59,3 +59,3 @@ **Examples** | ||
Returns **Feature<(Polygon | MultiPolygon)>** a combined [Polygon](Polygon) or [MultiPolygon](MultiPolygon) feature | ||
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))>** a combined [Polygon](http://geojson.org/geojson-spec.html#polygon) or [MultiPolygon](http://geojson.org/geojson-spec.html#multipolygon) feature | ||
@@ -74,3 +74,3 @@ --- | ||
```sh | ||
$ npm install turf-union | ||
$ npm install @turf/union | ||
``` | ||
@@ -81,3 +81,3 @@ | ||
```sh | ||
$ npm install turf | ||
$ npm install @turf/turf | ||
``` |
5237