@turf/boolean-contains - npm Package Compare versions

Comparing version 4.5.2 to 4.6.0

index.js

@@ -17,20 +17,7 @@ var inside = require('@turf/inside');
  * @param {Geometry|Feature<any>} feature2 GeoJSON Feature or Geometry
- * @returns {Boolean} true/false
+ * @returns {boolean} true/false
  * @example
- * const point = {
- *   "type": "Feature",
- *   "properties": {},
- *   "geometry": {
- *     "type": "Point",
- *     "coordinates": [1, 2]
- *   }
- * }
- * const line = {
- *   "type": "Feature",
- *   "properties": {},
- *   "geometry": {
- *     "type": "LineString",
- *     "coordinates": [[1, 1], [1, 2], [1, 3], [1, 4]]
- *   }
- * }
+ * const line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
+ * const point = turf.point([1, 2]);
+ *
  * turf.booleanContains(line, point);
@@ -213,3 +200,3 @@ * //=true
  * @param {Geometry|Feature<Polygon>} feature2 Polygon2
- * @returns {Boolean} true/false
+ * @returns {boolean} true/false
  */
@@ -235,4 +222,4 @@ function isPolyInPoly(feature1, feature2) {
  * @param {Array} point coord pair of point to check
- * @param {Boolean} incEnd whether the point is allowed to fall on the line ends
- * @returns {Boolean} true/false
+ * @param {boolean} incEnd whether the point is allowed to fall on the line ends
+ * @returns {boolean} true/false
  */
@@ -239,0 +226,0 @@ function isPointOnLineSegment(lineSegmentStart, lineSegmentEnd, point, incEnd) {

package.json

 {
   "name": "@turf/boolean-contains",
-  "version": "4.5.2",
+  "version": "4.6.0",
   "description": "turf boolean-contains module",
@@ -36,14 +36,14 @@ "main": "index.js",
   "devDependencies": {
-    "@turf/helpers": "^4.5.2",
-    "benchmark": "^2.1.4",
-    "boolean-shapely": "^0.1.2",
-    "glob": "^7.1.1",
-    "load-json-file": "^2.0.0",
-    "tape": "^4.6.3"
+    "@turf/helpers": "^4.6.0",
+    "benchmark": "2.1.4",
+    "boolean-shapely": "0.1.2",
+    "glob": "7.1.2",
+    "load-json-file": "2.0.0",
+    "tape": "4.7.0"
   },
   "dependencies": {
-    "@turf/bbox": "^4.5.2",
-    "@turf/inside": "^4.5.2",
-    "@turf/invariant": "^4.5.2"
+    "@turf/bbox": "^4.6.0",
+    "@turf/inside": "^4.6.0",
+    "@turf/invariant": "^4.6.0"
   }
 }

README.md

@@ -18,18 +18,5 @@ # @turf/boolean-contains
 ```javascript
-const point = {
-  "type": "Feature",
-  "properties": {},
-  "geometry": {
-    "type": "Point",
-    "coordinates": [1, 2]
-  }
-}
-const line = {
-  "type": "Feature",
-  "properties": {},
-  "geometry": {
-    "type": "LineString",
-    "coordinates": [[1, 1], [1, 2], [1, 3], [1, 4]]
-  }
-}
+const line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
+const point = turf.point([1, 2]);
+
 turf.booleanContains(line, point);
@@ -39,3 +26,3 @@ //=true
 
-Returns **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true/false
+Returns **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true/false
 
@@ -42,0 +29,0 @@ <!-- This file is automatically generated. Please don't edit it directly:

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

13161

decreased by-3.03%

Lines of code

259

decreased by-4.78%

Number of lines in readme file

51

decreased by-20.31%

Dependency changes

• Updated@turf/bbox@^4.6.0

• Updated@turf/inside@^4.6.0

• Updated@turf/invariant@^4.6.0