@turf/square-grid 7.0.0-alpha.2 → 7.1.0-alpha.7

package/README.md

@@ -49,26 +49,21 @@ Returns **[FeatureCollection][8]<[Polygon][6]>** grid a grid of polygons
 
 [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
-./scripts/generate-readmes in the turf project. -->
+<!-- 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. -->
 
 ---
 
-This module is part of the [Turfjs project](http://turfjs.org/), an open source
-module collection dedicated to geographic algorithms. It is maintained in the
-[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
-PRs and issues.
+This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.
 
 ### Installation
 
-Install this module individually:
+Install this single module individually:
 
 ```sh
 $ npm install @turf/square-grid
 ```
 
-Or install the Turf module that includes it as a function:
+Or install the all-encompassing @turf/turf module that includes all modules as functions:
 
 ```sh
 $ npm install @turf/turf

package/dist/cjs/index.cjs

@@ -0,0 +1,11 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// index.ts
+var _rectanglegrid = require('@turf/rectangle-grid');
+function squareGrid(bbox, cellSide, options = {}) {
+  return _rectanglegrid.rectangleGrid.call(void 0, bbox, cellSide, cellSide, options);
+}
+var turf_square_grid_default = squareGrid;
+
+
+
+exports.default = turf_square_grid_default; exports.squareGrid = squareGrid;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"names":[],"mappings":";AASA,SAAS,qBAAqB;AA0B9B,SAAS,WACP,MACA,UACA,UAII,CAAC,GAC0B;AAC/B,SAAO,cAAc,MAAM,UAAU,UAAU,OAAO;AACxD;AAGA,IAAO,2BAAQ","sourcesContent":["import {\n  FeatureCollection,\n  Polygon,\n  BBox,\n  Feature,\n  MultiPolygon,\n  GeoJsonProperties,\n} from \"geojson\";\nimport { Units } from \"@turf/helpers\";\nimport { rectangleGrid } from \"@turf/rectangle-grid\";\n\n/**\n * Creates a square grid from a bounding box.\n *\n * @name squareGrid\n * @param {Array<number>} bbox extent in [minX, minY, maxX, maxY] order\n * @param {number} cellSide of each cell, in units\n * @param {Object} [options={}] Optional parameters\n * @param {string} [options.units='kilometers'] used in calculating cellSide, can be degrees,\n * radians, miles, or kilometers\n * @param {Feature<Polygon|MultiPolygon>} [options.mask] if passed a Polygon or MultiPolygon,\n * the grid Points will be created only inside it\n * @param {Object} [options.properties={}] passed to each point of the grid\n * @returns {FeatureCollection<Polygon>} grid a grid of polygons\n * @example\n * var bbox = [-95, 30 ,-85, 40];\n * var cellSide = 50;\n * var options = {units: 'miles'};\n *\n * var squareGrid = turf.squareGrid(bbox, cellSide, options);\n *\n * //addToMap\n * var addToMap = [squareGrid]\n */\n\nfunction squareGrid<P extends GeoJsonProperties = GeoJsonProperties>(\n  bbox: BBox,\n  cellSide: number,\n  options: {\n    units?: Units;\n    properties?: P;\n    mask?: Feature<Polygon | MultiPolygon> | Polygon | MultiPolygon;\n  } = {}\n): FeatureCollection<Polygon, P> {\n  return rectangleGrid(bbox, cellSide, cellSide, options);\n}\n\nexport { squareGrid };\nexport default squareGrid;\n"]}

package/dist/{es/index.js → cjs/index.d.cts}

@@ -1,4 +1,6 @@
-import rectangleGrid from "@turf/rectangle-grid";
+import { GeoJsonProperties, BBox, Feature, Polygon, MultiPolygon, FeatureCollection } from 'geojson';
+import { Units } from '@turf/helpers';
+
 /**
  * Creates a square grid from a bounding box.
  *
@@ -22,6 +24,10 @@ import rectangleGrid from "@turf/rectangle-grid";
  * //addToMap
  * var addToMap = [squareGrid]
  */
-export default function squareGrid(bbox, cellSide, options = {}) {
-    return rectangleGrid(bbox, cellSide, cellSide, options);
-}
+declare function squareGrid<P extends GeoJsonProperties = GeoJsonProperties>(bbox: BBox, cellSide: number, options?: {
+    units?: Units;
+    properties?: P;
+    mask?: Feature<Polygon | MultiPolygon> | Polygon | MultiPolygon;
+}): FeatureCollection<Polygon, P>;
+
+export { squareGrid as default, squareGrid };

package/dist/{js → esm}/index.d.ts

@@ -1,5 +1,6 @@
-import { FeatureCollection, Polygon, BBox, Feature, MultiPolygon, GeoJsonProperties } from "geojson";
-import { Units } from "@turf/helpers";
+import { GeoJsonProperties, BBox, Feature, Polygon, MultiPolygon, FeatureCollection } from 'geojson';
+import { Units } from '@turf/helpers';
+
 /**
  * Creates a square grid from a bounding box.
  *
@@ -23,8 +24,10 @@ import { Units } from "@turf/helpers";
  * //addToMap
  * var addToMap = [squareGrid]
  */
-export default function squareGrid<P = GeoJsonProperties>(bbox: BBox, cellSide: number, options?: {
+declare function squareGrid<P extends GeoJsonProperties = GeoJsonProperties>(bbox: BBox, cellSide: number, options?: {
     units?: Units;
     properties?: P;
     mask?: Feature<Polygon | MultiPolygon> | Polygon | MultiPolygon;
 }): FeatureCollection<Polygon, P>;
+
+export { squareGrid as default, squareGrid };

package/dist/esm/index.js

@@ -0,0 +1,11 @@
+// index.ts
+import { rectangleGrid } from "@turf/rectangle-grid";
+function squareGrid(bbox, cellSide, options = {}) {
+  return rectangleGrid(bbox, cellSide, cellSide, options);
+}
+var turf_square_grid_default = squareGrid;
+export {
+  turf_square_grid_default as default,
+  squareGrid
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"sourcesContent":["import {\n  FeatureCollection,\n  Polygon,\n  BBox,\n  Feature,\n  MultiPolygon,\n  GeoJsonProperties,\n} from \"geojson\";\nimport { Units } from \"@turf/helpers\";\nimport { rectangleGrid } from \"@turf/rectangle-grid\";\n\n/**\n * Creates a square grid from a bounding box.\n *\n * @name squareGrid\n * @param {Array<number>} bbox extent in [minX, minY, maxX, maxY] order\n * @param {number} cellSide of each cell, in units\n * @param {Object} [options={}] Optional parameters\n * @param {string} [options.units='kilometers'] used in calculating cellSide, can be degrees,\n * radians, miles, or kilometers\n * @param {Feature<Polygon|MultiPolygon>} [options.mask] if passed a Polygon or MultiPolygon,\n * the grid Points will be created only inside it\n * @param {Object} [options.properties={}] passed to each point of the grid\n * @returns {FeatureCollection<Polygon>} grid a grid of polygons\n * @example\n * var bbox = [-95, 30 ,-85, 40];\n * var cellSide = 50;\n * var options = {units: 'miles'};\n *\n * var squareGrid = turf.squareGrid(bbox, cellSide, options);\n *\n * //addToMap\n * var addToMap = [squareGrid]\n */\n\nfunction squareGrid<P extends GeoJsonProperties = GeoJsonProperties>(\n  bbox: BBox,\n  cellSide: number,\n  options: {\n    units?: Units;\n    properties?: P;\n    mask?: Feature<Polygon | MultiPolygon> | Polygon | MultiPolygon;\n  } = {}\n): FeatureCollection<Polygon, P> {\n  return rectangleGrid(bbox, cellSide, cellSide, options);\n}\n\nexport { squareGrid };\nexport default squareGrid;\n"],"mappings":";AASA,SAAS,qBAAqB;AA0B9B,SAAS,WACP,MACA,UACA,UAII,CAAC,GAC0B;AAC/B,SAAO,cAAc,MAAM,UAAU,UAAU,OAAO;AACxD;AAGA,IAAO,2BAAQ;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/square-grid",
-  "version": "7.0.0-alpha.2",
+  "version": "7.1.0-alpha.7+0ce6ecca0",
   "description": "turf square-grid module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -23,46 +23,51 @@
     "cartesian",
     "grid"
   ],
-  "main": "dist/js/index.js",
-  "module": "dist/es/index.js",
+  "type": "module",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "types": "./dist/js/index.d.ts",
-      "import": "./dist/es/index.js",
-      "require": "./dist/js/index.js"
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.cts",
+        "default": "./dist/cjs/index.cjs"
+      }
     }
   },
-  "types": "dist/js/index.d.ts",
   "sideEffects": false,
   "files": [
     "dist"
   ],
   "scripts": {
-    "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": "tsx ../../scripts/generate-readmes",
-    "test": "npm-run-all test:*",
-    "test:tape": "tsx test.js"
+    "bench": "tsx bench.ts",
+    "build": "tsup --config ../../tsup.config.ts",
+    "docs": "tsx ../../scripts/generate-readmes.ts",
+    "test": "npm-run-all --npm-path npm test:*",
+    "test:tape": "tsx test.ts"
   },
   "devDependencies": {
-    "@turf/bbox-polygon": "^7.0.0-alpha.2",
-    "@turf/truncate": "^7.0.0-alpha.2",
-    "@types/tape": "*",
-    "benchmark": "*",
-    "npm-run-all": "*",
-    "tape": "*",
-    "tslint": "*",
-    "tsx": "*",
-    "typescript": "*",
-    "write-json-file": "*"
+    "@turf/bbox-polygon": "^7.1.0-alpha.7+0ce6ecca0",
+    "@turf/truncate": "^7.1.0-alpha.7+0ce6ecca0",
+    "@types/benchmark": "^2.1.5",
+    "@types/tape": "^4.2.32",
+    "benchmark": "^2.1.4",
+    "npm-run-all": "^4.1.5",
+    "tape": "^5.7.2",
+    "tsup": "^8.0.1",
+    "tsx": "^4.6.2",
+    "typescript": "^5.2.2",
+    "write-json-file": "^5.0.0"
   },
   "dependencies": {
-    "@turf/helpers": "^7.0.0-alpha.2",
-    "@turf/rectangle-grid": "^7.0.0-alpha.2",
-    "tslib": "^2.3.0"
+    "@turf/helpers": "^7.1.0-alpha.7+0ce6ecca0",
+    "@turf/rectangle-grid": "^7.1.0-alpha.7+0ce6ecca0",
+    "tslib": "^2.6.2"
   },
-  "gitHead": "dd35b52725945b4fa29a98d9a550733e06cc222e"
+  "gitHead": "0ce6ecca05829690270fec6d6bed2003495fe0ea"
 }

package/dist/es/package.json

@@ -1 +0,0 @@
-{"type":"module"}

package/dist/js/index.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const rectangle_grid_1 = tslib_1.__importDefault(require("@turf/rectangle-grid"));
-/**
- * Creates a square grid from a bounding box.
- *
- * @name squareGrid
- * @param {Array<number>} bbox extent in [minX, minY, maxX, maxY] order
- * @param {number} cellSide of each cell, in units
- * @param {Object} [options={}] Optional parameters
- * @param {string} [options.units='kilometers'] used in calculating cellSide, can be degrees,
- * radians, miles, or kilometers
- * @param {Feature<Polygon|MultiPolygon>} [options.mask] if passed a Polygon or MultiPolygon,
- * the grid Points will be created only inside it
- * @param {Object} [options.properties={}] passed to each point of the grid
- * @returns {FeatureCollection<Polygon>} grid a grid of polygons
- * @example
- * var bbox = [-95, 30 ,-85, 40];
- * var cellSide = 50;
- * var options = {units: 'miles'};
- *
- * var squareGrid = turf.squareGrid(bbox, cellSide, options);
- *
- * //addToMap
- * var addToMap = [squareGrid]
- */
-function squareGrid(bbox, cellSide, options = {}) {
-    return rectangle_grid_1.default(bbox, cellSide, cellSide, options);
-}
-exports.default = squareGrid;