@turf/square-grid - npm Package Compare versions

Comparing version 3.5.2 to 3.5.3

index.js

@@ -12,10 +12,10 @@ var featurecollection = require('@turf/helpers').featureCollection;
  * @param {number} cellSize width of each cell
- * @param {string} units units to use for cellWidth
+ * @param {string} [units=kilometers] used in calculating cellSize, can be degrees, radians, miles, or kilometers
  * @return {FeatureCollection<Polygon>} grid a grid of polygons
  * @example
- * var extent = [-77.3876953125,38.71980474264239,-76.9482421875,39.027718840211605];
- * var cellWidth = 10;
+ * var bbox = [-96,31,-84,40];
+ * var cellSize = 10;
  * var units = 'miles';
  *
- * var squareGrid = turf.squareGrid(extent, cellWidth, units);
+ * var squareGrid = turf.squareGrid(bbox, cellSize, units);
  *
@@ -22,0 +22,0 @@ * //=squareGrid

package.json

 {
   "name": "@turf/square-grid",
-  "version": "3.5.2",
+  "version": "3.5.3",
   "description": "",
   "main": "index.js",
   "dependencies": {
-    "@turf/distance": "^3.5.2",
-    "@turf/helpers": "^3.5.2"
+    "@turf/distance": "^3.5.3",
+    "@turf/helpers": "^3.5.3"
   },
@@ -10,0 +10,0 @@ "devDependencies": {

README.md

@@ -11,3 +11,3 @@ # @turf/square-grid
 -   `cellSize` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** width of each cell
--   `units` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** units to use for cellWidth
+-   `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`)
 
@@ -17,7 +17,7 @@ **Examples**
 ```javascript
-var extent = [-77.3876953125,38.71980474264239,-76.9482421875,39.027718840211605];
-var cellWidth = 10;
+var bbox = [-96,31,-84,40];
+var cellSize = 10;
 var units = 'miles';
 
-var squareGrid = turf.squareGrid(extent, cellWidth, units);
+var squareGrid = turf.squareGrid(bbox, cellSize, units);
 
@@ -24,0 +24,0 @@ //=squareGrid

No alert changes

Improved metrics

Total package byte prevSize

7786

increased by0.37%

Dependency changes

• Updated@turf/distance@^3.5.3

• Updated@turf/helpers@^3.5.3