@turf/intersect
Advanced tools
Comparing version 6.1.0 to 6.1.1
{ | ||
"name": "@turf/intersect", | ||
"version": "6.1.0", | ||
"version": "6.1.1", | ||
"description": "turf intersect module", | ||
"main": "index", | ||
"types": "index.d.ts", | ||
"files": [ | ||
"index.js", | ||
"index.ts" | ||
"index.d.ts" | ||
], | ||
@@ -36,5 +37,7 @@ "scripts": { | ||
"load-json-file": "*", | ||
"rollup": "*", | ||
"tape": "*", | ||
"write-json-file": "*" | ||
"write-json-file": "*", | ||
"typescript": "*", | ||
"tslint": "*", | ||
"@types/tape": "*" | ||
}, | ||
@@ -41,0 +44,0 @@ "dependencies": { |
@@ -7,10 +7,10 @@ # @turf/intersect | ||
Takes two [polygon](https://tools.ietf.org/html/rfc7946#section-3.1.6) or [multi-polygon](https://tools.ietf.org/html/rfc7946#section-3.1.7) geometries and finds their polygonal intersection. If they don't intersect, returns null. | ||
Takes two [polygon][1] or [multi-polygon][2] geometries and finds their polygonal intersection. If they don't intersect, returns null. | ||
**Parameters** | ||
- `poly1` **[Feature](https://tools.ietf.org/html/rfc7946#section-3.2)<([Polygon](https://tools.ietf.org/html/rfc7946#section-3.1.6) \| [MultiPolygon](https://tools.ietf.org/html/rfc7946#section-3.1.7))>** the first polygon or multipolygon | ||
- `poly2` **[Feature](https://tools.ietf.org/html/rfc7946#section-3.2)<([Polygon](https://tools.ietf.org/html/rfc7946#section-3.1.6) \| [MultiPolygon](https://tools.ietf.org/html/rfc7946#section-3.1.7))>** the second polygon or multipolygon | ||
- `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Optional Parameters (optional, default `{}`) | ||
- `options.properties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Translate GeoJSON Properties to Feature (optional, default `{}`) | ||
- `poly1` **[Feature][3]<([Polygon][4] \| [MultiPolygon][5])>** the first polygon or multipolygon | ||
- `poly2` **[Feature][3]<([Polygon][4] \| [MultiPolygon][5])>** the second polygon or multipolygon | ||
- `options` **[Object][6]** Optional Parameters (optional, default `{}`) | ||
- `options.properties` **[Object][6]** Translate GeoJSON Properties to Feature (optional, default `{}`) | ||
@@ -45,4 +45,16 @@ **Examples** | ||
Returns **([Feature](https://tools.ietf.org/html/rfc7946#section-3.2) | null)** returns a feature representing the area they share (either a [Polygon](https://tools.ietf.org/html/rfc7946#section-3.1.6) or [MultiPolygon](https://tools.ietf.org/html/rfc7946#section-3.1.7)). If they do not share any area, returns `null`. | ||
Returns **([Feature][3] | null)** returns a feature representing the area they share (either a [Polygon][1] or [MultiPolygon][2]). If they do not share any area, returns `null`. | ||
[1]: https://tools.ietf.org/html/rfc7946#section-3.1.6 | ||
[2]: https://tools.ietf.org/html/rfc7946#section-3.1.7 | ||
[3]: https://tools.ietf.org/html/rfc7946#section-3.2 | ||
[4]: https://tools.ietf.org/html/rfc7946#section-3.1.6 | ||
[5]: https://tools.ietf.org/html/rfc7946#section-3.1.7 | ||
[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object | ||
<!-- This file is automatically generated. Please don't edit it directly: | ||
@@ -49,0 +61,0 @@ if you find an error, edit the source file (likely index.js), and re-run |
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
82
8406
8
4
91