@turf/intersect
Advanced tools
Comparing version 3.0.15 to 3.0.16
{ | ||
"name": "@turf/intersect", | ||
"version": "3.0.15", | ||
"version": "3.0.16", | ||
"description": "find the intersection of spatial features", | ||
@@ -11,3 +11,3 @@ "main": "index.js", | ||
"type": "git", | ||
"url": "git://github.com/Turfjs/turf-intersect.git" | ||
"url": "git://github.com/Turfjs/turf.git" | ||
}, | ||
@@ -22,5 +22,5 @@ "keywords": [ | ||
"bugs": { | ||
"url": "https://github.com/Turfjs/turf-intersect/issues" | ||
"url": "https://github.com/Turfjs/turf/issues" | ||
}, | ||
"homepage": "https://github.com/Turfjs/turf-intersect", | ||
"homepage": "https://github.com/Turfjs/turf", | ||
"devDependencies": { | ||
@@ -27,0 +27,0 @@ "benchmark": "^1.0.0", |
@@ -1,11 +0,11 @@ | ||
# turf-intersect | ||
# @turf/intersect | ||
# intersect | ||
Takes two [polygons](Polygon) and finds their intersection. If they share a border, returns the border; if they don't intersect, returns undefined. | ||
Takes two [polygons](http://geojson.org/geojson-spec.html#polygon) and finds their intersection. If they share a border, returns the border; if they don't intersect, returns undefined. | ||
**Parameters** | ||
- `poly1` **Feature<Polygon>** the first polygon | ||
- `poly2` **Feature<Polygon>** the second polygon | ||
- `poly1` **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Polygon](http://geojson.org/geojson-spec.html#polygon)>** the first polygon | ||
- `poly2` **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Polygon](http://geojson.org/geojson-spec.html#polygon)>** the second polygon | ||
@@ -63,3 +63,3 @@ **Examples** | ||
Returns **(Feature<Polygon> | [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined) | Feature<MultiLineString>)** if `poly1` and `poly2` overlap, returns a Polygon feature representing the area they overlap; if `poly1` and `poly2` do not overlap, returns `undefined`; if `poly1` and `poly2` share a border, a MultiLineString of the locations where their borders are shared | ||
Returns **([Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Polygon](http://geojson.org/geojson-spec.html#polygon)> | [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined) \| [Feature](http://geojson.org/geojson-spec.html#feature-objects)<[MultiLineString](http://geojson.org/geojson-spec.html#multilinestring)>)** if `poly1` and `poly2` overlap, returns a Polygon feature representing the area they overlap; if `poly1` and `poly2` do not overlap, returns `undefined`; if `poly1` and `poly2` share a border, a MultiLineString of the locations where their borders are shared | ||
@@ -78,3 +78,3 @@ --- | ||
```sh | ||
$ npm install turf-intersect | ||
$ npm install @turf/intersect | ||
``` | ||
@@ -85,3 +85,3 @@ | ||
```sh | ||
$ npm install turf | ||
$ npm install @turf/turf | ||
``` |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
6308