@turf/square-grid 6.5.0 → 7.0.0-alpha.1

package/README.md

@@ -6,18 +6,19 @@
 
 Creates a square grid from a bounding box.
 
-**Parameters**
+### Parameters
 
--   `bbox` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)>** extent in [minX, minY, maxX, maxY] order
--   `cellSide` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** of each cell, in units
--   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Optional parameters (optional, default `{}`)
-    -   `options.units` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** used in calculating cellSide, can be degrees,
+*   `bbox` **[Array][1]<[number][2]>** extent in \[minX, minY, maxX, maxY] order
+*   `cellSide` **[number][2]** of each cell, in units
+*   `options` **[Object][3]** Optional parameters (optional, default `{}`)
+
+    *   `options.units` **[string][4]** used in calculating cellSide, can be degrees,
         radians, miles, or kilometers (optional, default `'kilometers'`)
-    -   `options.mask` **[Feature](https://tools.ietf.org/html/rfc7946#section-3.2)&lt;([Polygon](https://tools.ietf.org/html/rfc7946#section-3.1.6) \| [MultiPolygon](https://tools.ietf.org/html/rfc7946#section-3.1.7))>?** if passed a Polygon or MultiPolygon,
+    *   `options.mask` **[Feature][5]<([Polygon][6] | [MultiPolygon][7])>?** if passed a Polygon or MultiPolygon,
         the grid Points will be created only inside it
-    -   `options.properties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** passed to each point of the grid (optional, default `{}`)
+    *   `options.properties` **[Object][3]** passed to each point of the grid (optional, default `{}`)
 
-**Examples**
+### Examples
 
 ```javascript
 var bbox = [-95, 30 ,-85, 40];
@@ -30,7 +31,23 @@ var squareGrid = turf.squareGrid(bbox, cellSide, options);
 var addToMap = [squareGrid]
 ```
 
-Returns **[FeatureCollection](https://tools.ietf.org/html/rfc7946#section-3.3)&lt;[Polygon](https://tools.ietf.org/html/rfc7946#section-3.1.6)>** grid a grid of polygons
+Returns **[FeatureCollection][8]<[Polygon][6]>** grid a grid of polygons
+
+[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+
+[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[5]: https://tools.ietf.org/html/rfc7946#section-3.2
+
+[6]: https://tools.ietf.org/html/rfc7946#section-3.1.6
+
+[7]: https://tools.ietf.org/html/rfc7946#section-3.1.7
+
+[8]: https://tools.ietf.org/html/rfc7946#section-3.3
 
 <!-- This file is automatically generated. Please don't edit it directly:
 if you find an error, edit the source file (likely index.js), and re-run

package/dist/es/index.js

@@ -22,7 +22,6 @@ import rectangleGrid from "@turf/rectangle-grid";
  * //addToMap
  * var addToMap = [squareGrid]
  */
-export default function squareGrid(bbox, cellSide, options) {
-    if (options === void 0) { options = {}; }
+export default function squareGrid(bbox, cellSide, options = {}) {
     return rectangleGrid(bbox, cellSide, cellSide, options);
 }

package/dist/js/index.d.ts

@@ -1,4 +1,5 @@
-import { FeatureCollection, Polygon, BBox, Units, Feature, MultiPolygon, Properties } from "@turf/helpers";
+import { FeatureCollection, Polygon, BBox, Feature, MultiPolygon, GeoJsonProperties } from "geojson";
+import { Units } from "@turf/helpers";
 /**
  * Creates a square grid from a bounding box.
  *
@@ -22,7 +23,7 @@ import { FeatureCollection, Polygon, BBox, Units, Feature, MultiPolygon, Propert
  * //addToMap
  * var addToMap = [squareGrid]
  */
-export default function squareGrid<P = Properties>(bbox: BBox, cellSide: number, options?: {
+export default function squareGrid<P = GeoJsonProperties>(bbox: BBox, cellSide: number, options?: {
     units?: Units;
     properties?: P;
     mask?: Feature<Polygon | MultiPolygon> | Polygon | MultiPolygon;

package/dist/js/index.js

@@ -1,9 +1,7 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var rectangle_grid_1 = __importDefault(require("@turf/rectangle-grid"));
+const tslib_1 = require("tslib");
+const rectangle_grid_1 = tslib_1.__importDefault(require("@turf/rectangle-grid"));
 /**
  * Creates a square grid from a bounding box.
  *
@@ -27,8 +25,7 @@ var rectangle_grid_1 = __importDefault(require("@turf/rectangle-grid"));
  * //addToMap
  * var addToMap = [squareGrid]
  */
-function squareGrid(bbox, cellSide, options) {
-    if (options === void 0) { options = {}; }
+function squareGrid(bbox, cellSide, options = {}) {
     return rectangle_grid_1.default(bbox, cellSide, cellSide, options);
 }
 exports.default = squareGrid;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/square-grid",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf square-grid module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -28,6 +28,7 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "types": "./dist/js/index.d.ts",
       "import": "./dist/es/index.js",
       "require": "./dist/js/index.js"
     }
@@ -38,29 +39,30 @@
     "dist"
   ],
   "scripts": {
-    "bench": "ts-node bench.js",
+    "bench": "tsx bench.js",
     "build": "npm-run-all build:*",
     "build:es": "tsc --outDir dist/es --module esnext --declaration false && echo '{\"type\":\"module\"}' > dist/es/package.json",
     "build:js": "tsc",
-    "docs": "node ../../scripts/generate-readmes",
+    "docs": "tsx ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
-    "test:tape": "ts-node -r esm test.js"
+    "test:tape": "tsx test.js"
   },
   "devDependencies": {
-    "@turf/bbox-polygon": "^6.5.0",
-    "@turf/truncate": "^6.5.0",
+    "@turf/bbox-polygon": "^7.0.0-alpha.1",
+    "@turf/truncate": "^7.0.0-alpha.1",
     "@types/tape": "*",
     "benchmark": "*",
     "npm-run-all": "*",
     "tape": "*",
-    "ts-node": "*",
     "tslint": "*",
+    "tsx": "*",
     "typescript": "*",
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/helpers": "^6.5.0",
-    "@turf/rectangle-grid": "^6.5.0"
+    "@turf/helpers": "^7.0.0-alpha.1",
+    "@turf/rectangle-grid": "^7.0.0-alpha.1",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
 }