@turf/intersect 7.1.0-alpha.7 → 7.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -10
- package/package.json +5 -4
package/README.md
CHANGED
|
@@ -9,10 +9,10 @@ finds their polygonal intersection. If they don't intersect, returns null.
|
|
|
9
9
|
|
|
10
10
|
### Parameters
|
|
11
11
|
|
|
12
|
-
* `features` **[FeatureCollection][3]<([Polygon][
|
|
13
|
-
* `options` **[Object][
|
|
12
|
+
* `features` **[FeatureCollection][3]<([Polygon][1] | [MultiPolygon][2])>** the features to intersect
|
|
13
|
+
* `options` **[Object][4]** Optional Parameters (optional, default `{}`)
|
|
14
14
|
|
|
15
|
-
* `options.properties` **[Object][
|
|
15
|
+
* `options.properties` **[Object][4]** Translate GeoJSON Properties to Feature (optional, default `{}`)
|
|
16
16
|
|
|
17
17
|
### Examples
|
|
18
18
|
|
|
@@ -42,7 +42,7 @@ var intersection = turf.intersect(turf.featureCollection([poly1, poly2]));
|
|
|
42
42
|
var addToMap = [poly1, poly2, intersection];
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Returns **([Feature][
|
|
45
|
+
Returns **([Feature][5] | null)** returns a feature representing the area they share (either a [Polygon][1] or
|
|
46
46
|
[MultiPolygon][2]). If they do not share any area, returns `null`.
|
|
47
47
|
|
|
48
48
|
[1]: https://tools.ietf.org/html/rfc7946#section-3.1.6
|
|
@@ -51,13 +51,9 @@ Returns **([Feature][7] | null)** returns a feature representing the area they s
|
|
|
51
51
|
|
|
52
52
|
[3]: https://tools.ietf.org/html/rfc7946#section-3.3
|
|
53
53
|
|
|
54
|
-
[4]: https://
|
|
54
|
+
[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
|
|
55
55
|
|
|
56
|
-
[5]: https://tools.ietf.org/html/rfc7946#section-3.
|
|
57
|
-
|
|
58
|
-
[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
|
|
59
|
-
|
|
60
|
-
[7]: https://tools.ietf.org/html/rfc7946#section-3.2
|
|
56
|
+
[5]: https://tools.ietf.org/html/rfc7946#section-3.2
|
|
61
57
|
|
|
62
58
|
<!-- This file is automatically generated. Please don't edit it directly. If you find an error, edit the source file of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->
|
|
63
59
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@turf/intersect",
|
|
3
|
-
"version": "7.1.0
|
|
3
|
+
"version": "7.1.0",
|
|
4
4
|
"description": "turf intersect module",
|
|
5
5
|
"author": "Turf Authors",
|
|
6
6
|
"license": "MIT",
|
|
@@ -64,10 +64,11 @@
|
|
|
64
64
|
"write-json-file": "^5.0.0"
|
|
65
65
|
},
|
|
66
66
|
"dependencies": {
|
|
67
|
-
"@turf/helpers": "^7.1.0
|
|
68
|
-
"@turf/meta": "^7.1.0
|
|
67
|
+
"@turf/helpers": "^7.1.0",
|
|
68
|
+
"@turf/meta": "^7.1.0",
|
|
69
|
+
"@types/geojson": "^7946.0.10",
|
|
69
70
|
"polygon-clipping": "^0.15.3",
|
|
70
71
|
"tslib": "^2.6.2"
|
|
71
72
|
},
|
|
72
|
-
"gitHead": "
|
|
73
|
+
"gitHead": "68915eeebc9278bb40dec3f1034499698a0561ef"
|
|
73
74
|
}
|