@turf/hex-grid - npm Package Compare versions

Comparing version 3.5.2 to 3.5.3

index.js

@@ -22,5 +22,5 @@ var point = require('@turf/helpers').point;
  * @name hexGrid
- * @param {Array<number>} bbox bounding box in [minX, minY, maxX, maxY] order
+ * @param {Array<number>} bbox extent in [minX, minY, maxX, maxY] order
  * @param {number} cellSize dimension of cell in specified units
- * @param {string} units used in calculating cellWidth ('miles' or 'kilometers')
+ * @param {string} [units=kilometers] used in calculating cellSize, can be degrees, radians, miles, or kilometers
  * @param {boolean} triangles whether to return as triangles instead of hexagons
@@ -30,6 +30,6 @@ * @return {FeatureCollection<Polygon>} a hexagonal grid
  * var bbox = [-96,31,-84,40];
- * var cellWidth = 50;
+ * var cellSize = 50;
  * var units = 'miles';
  *
- * var hexgrid = turf.hexGrid(bbox, cellWidth, units);
+ * var hexgrid = turf.hexGrid(bbox, cellSize, units);
  *
@@ -36,0 +36,0 @@ * //=hexgrid

package.json

 {
   "name": "@turf/hex-grid",
-  "version": "3.5.2",
+  "version": "3.5.3",
   "description": "",
@@ -37,10 +37,10 @@ "main": "index.js",
     "tape": "^3.5.0",
-    "@turf/bbox-polygon": "^3.5.2",
-    "@turf/explode": "^3.5.2",
-    "@turf/inside": "^3.5.2"
+    "@turf/bbox-polygon": "^3.5.3",
+    "@turf/explode": "^3.5.3",
+    "@turf/inside": "^3.5.3"
   },
   "dependencies": {
-    "@turf/distance": "^3.5.2",
-    "@turf/helpers": "^3.5.2"
+    "@turf/distance": "^3.5.3",
+    "@turf/helpers": "^3.5.3"
   }
 }

README.md

@@ -11,5 +11,5 @@ # @turf/hex-grid
 
--   `bbox` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>** bounding box in [minX, minY, maxX, maxY] order
+-   `bbox` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>** extent in [minX, minY, maxX, maxY] order
 -   `cellSize` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** dimension of cell in specified units
--   `units` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** used in calculating cellWidth ('miles' or 'kilometers')
+-   `units` **\[[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** used in calculating cellSize, can be degrees, radians, miles, or kilometers (optional, default `kilometers`)
 -   `triangles` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** whether to return as triangles instead of hexagons
@@ -21,6 +21,6 @@
 var bbox = [-96,31,-84,40];
-var cellWidth = 50;
+var cellSize = 50;
 var units = 'miles';
 
-var hexgrid = turf.hexGrid(bbox, cellWidth, units);
+var hexgrid = turf.hexGrid(bbox, cellSize, units);
 
@@ -27,0 +27,0 @@ //=hexgrid

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

Improved metrics

Total package byte prevSize

13641

increased by0.54%

Worsened metrics

Number of package files

7

decreased by-30%

Dependency changes

• Updated@turf/distance@^3.5.3

• Updated@turf/helpers@^3.5.3