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

package/README.md

@@ -8,18 +8,19 @@ Takes a bounding box and the diameter of the cell and returns a [FeatureCollecti
 hexagons or triangles ([Polygon][2] features) aligned in an "odd-q" vertical grid as
 described in [Hexagonal Grids][3].
 
-**Parameters**
+### Parameters
 
--   `bbox` **[BBox][4]** extent in [minX, minY, maxX, maxY] order
--   `cellSide` **[number][5]** length of the side of the the hexagons or triangles, in units. It will also coincide with the
+*   `bbox` **[BBox][4]** extent in \[minX, minY, maxX, maxY] order
+*   `cellSide` **[number][5]** length of the side of the the hexagons or triangles, in units. It will also coincide with the
     radius of the circumcircle of the hexagons.
--   `options` **[Object][6]** Optional parameters (optional, default `{}`)
-    -   `options.units` **[string][7]** used in calculating cell size, can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`)
-    -   `options.properties` **[Object][6]** passed to each hexagon or triangle of the grid (optional, default `{}`)
-    -   `options.mask` **[Feature][8]<[Polygon][9]>?** if passed a Polygon or MultiPolygon, the grid Points will be created only inside it
-    -   `options.triangles` **[boolean][10]** whether to return as triangles instead of hexagons (optional, default `false`)
+*   `options` **[Object][6]** Optional parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.units` **[string][7]** used in calculating cell size, can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`)
+    *   `options.properties` **[Object][6]** passed to each hexagon or triangle of the grid (optional, default `{}`)
+    *   `options.mask` **[Feature][8]<[Polygon][9]>?** if passed a Polygon or MultiPolygon, the grid Points will be created only inside it
+    *   `options.triangles` **[boolean][10]** whether to return as triangles instead of hexagons (optional, default `false`)
+
+### Examples
 
 ```javascript
 var bbox = [-96,31,-84,40];
@@ -32,7 +33,7 @@ var hexgrid = turf.hexGrid(bbox, cellSide, options);
 var addToMap = [hexgrid];
 ```
 
-Returns **[FeatureCollection][11]&lt;[Polygon][9]>** a hexagonal grid
+Returns **[FeatureCollection][11]<[Polygon][9]>** a hexagonal grid
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.3
 

package/dist/es/index.js

@@ -1,6 +1,6 @@
 import distance from "@turf/distance";
 import intersect from "@turf/intersect";
-import { polygon, featureCollection, } from "@turf/helpers";
+import { polygon, featureCollection } from "@turf/helpers";
 /**
  * Takes a bounding box and the diameter of the cell and returns a {@link FeatureCollection} of flat-topped
  * hexagons or triangles ({@link Polygon} features) aligned in an "odd-q" vertical grid as
@@ -26,63 +26,62 @@ import { polygon, featureCollection, } from "@turf/helpers";
  * //addToMap
  * var addToMap = [hexgrid];
  */
-function hexGrid(bbox, cellSide, options) {
-    if (options === void 0) { options = {}; }
+function hexGrid(bbox, cellSide, options = {}) {
     // Issue => https://github.com/Turfjs/turf/issues/1284
-    var clonedProperties = JSON.stringify(options.properties || {});
-    var west = bbox[0], south = bbox[1], east = bbox[2], north = bbox[3];
-    var centerY = (south + north) / 2;
-    var centerX = (west + east) / 2;
+    const clonedProperties = JSON.stringify(options.properties || {});
+    const [west, south, east, north] = bbox;
+    const centerY = (south + north) / 2;
+    const centerX = (west + east) / 2;
     // https://github.com/Turfjs/turf/issues/758
-    var xFraction = (cellSide * 2) / distance([west, centerY], [east, centerY], options);
-    var cellWidth = xFraction * (east - west);
-    var yFraction = (cellSide * 2) / distance([centerX, south], [centerX, north], options);
-    var cellHeight = yFraction * (north - south);
-    var radius = cellWidth / 2;
-    var hex_width = radius * 2;
-    var hex_height = (Math.sqrt(3) / 2) * cellHeight;
-    var box_width = east - west;
-    var box_height = north - south;
-    var x_interval = (3 / 4) * hex_width;
-    var y_interval = hex_height;
+    const xFraction = (cellSide * 2) / distance([west, centerY], [east, centerY], options);
+    const cellWidth = xFraction * (east - west);
+    const yFraction = (cellSide * 2) / distance([centerX, south], [centerX, north], options);
+    const cellHeight = yFraction * (north - south);
+    const radius = cellWidth / 2;
+    const hex_width = radius * 2;
+    const hex_height = (Math.sqrt(3) / 2) * cellHeight;
+    const box_width = east - west;
+    const box_height = north - south;
+    const x_interval = (3 / 4) * hex_width;
+    const y_interval = hex_height;
     // adjust box_width so all hexagons will be inside the bbox
-    var x_span = (box_width - hex_width) / (hex_width - radius / 2);
-    var x_count = Math.floor(x_span);
-    var x_adjust = (x_count * x_interval - radius / 2 - box_width) / 2 -
+    const x_span = (box_width - hex_width) / (hex_width - radius / 2);
+    const x_count = Math.floor(x_span);
+    const x_adjust = (x_count * x_interval - radius / 2 - box_width) / 2 -
         radius / 2 +
         x_interval / 2;
     // adjust box_height so all hexagons will be inside the bbox
-    var y_count = Math.floor((box_height - hex_height) / hex_height);
-    var y_adjust = (box_height - y_count * hex_height) / 2;
-    var hasOffsetY = y_count * hex_height - box_height > hex_height / 2;
+    const y_count = Math.floor((box_height - hex_height) / hex_height);
+    let y_adjust = (box_height - y_count * hex_height) / 2;
+    const hasOffsetY = y_count * hex_height - box_height > hex_height / 2;
     if (hasOffsetY) {
         y_adjust -= hex_height / 4;
     }
     // Precompute cosines and sines of angles used in hexagon creation for performance gain
-    var cosines = [];
-    var sines = [];
-    for (var i = 0; i < 6; i++) {
-        var angle = ((2 * Math.PI) / 6) * i;
+    const cosines = [];
+    const sines = [];
+    for (let i = 0; i < 6; i++) {
+        const angle = ((2 * Math.PI) / 6) * i;
         cosines.push(Math.cos(angle));
         sines.push(Math.sin(angle));
     }
-    var results = [];
-    for (var x = 0; x <= x_count; x++) {
-        for (var y = 0; y <= y_count; y++) {
-            var isOdd = x % 2 === 1;
+    const results = [];
+    for (let x = 0; x <= x_count; x++) {
+        for (let y = 0; y <= y_count; y++) {
+            const isOdd = x % 2 === 1;
             if (y === 0 && isOdd)
                 continue;
             if (y === 0 && hasOffsetY)
                 continue;
-            var center_x = x * x_interval + west - x_adjust;
-            var center_y = y * y_interval + south + y_adjust;
+            const center_x = x * x_interval + west - x_adjust;
+            let center_y = y * y_interval + south + y_adjust;
             if (isOdd) {
                 center_y -= hex_height / 2;
             }
             if (options.triangles === true) {
                 hexTriangles([center_x, center_y], cellWidth / 2, cellHeight / 2, JSON.parse(clonedProperties), cosines, sines).forEach(function (triangle) {
                     if (options.mask) {
-                        if (intersect(options.mask, triangle))
+                        if (intersect(featureCollection([options.mask, triangle])))
                             results.push(triangle);
                     }
                     else {
@@ -91,9 +90,9 @@ function hexGrid(bbox, cellSide, options) {
                 });
             }
             else {
-                var hex = hexagon([center_x, center_y], cellWidth / 2, cellHeight / 2, JSON.parse(clonedProperties), cosines, sines);
+                const hex = hexagon([center_x, center_y], cellWidth / 2, cellHeight / 2, JSON.parse(clonedProperties), cosines, sines);
                 if (options.mask) {
-                    if (intersect(options.mask, hex))
+                    if (intersect(featureCollection([options.mask, hex])))
                         results.push(hex);
                 }
                 else {
@@ -117,10 +116,10 @@ function hexGrid(bbox, cellSide, options) {
  * @returns {Feature<Polygon>} hexagon
  */
 function hexagon(center, rx, ry, properties, cosines, sines) {
-    var vertices = [];
-    for (var i = 0; i < 6; i++) {
-        var x = center[0] + rx * cosines[i];
-        var y = center[1] + ry * sines[i];
+    const vertices = [];
+    for (let i = 0; i < 6; i++) {
+        const x = center[0] + rx * cosines[i];
+        const y = center[1] + ry * sines[i];
         vertices.push([x, y]);
     }
     //first and last vertex must be the same
@@ -140,9 +139,9 @@ function hexagon(center, rx, ry, properties, cosines, sines) {
  * @returns {Array<Feature<Polygon>>} triangles
  */
 function hexTriangles(center, rx, ry, properties, cosines, sines) {
-    var triangles = [];
-    for (var i = 0; i < 6; i++) {
-        var vertices = [];
+    const triangles = [];
+    for (let i = 0; i < 6; i++) {
+        const vertices = [];
         vertices.push(center);
         vertices.push([center[0] + rx * cosines[i], center[1] + ry * sines[i]]);
         vertices.push([

package/dist/js/index.d.ts

@@ -1,4 +1,5 @@
-import { Feature, FeatureCollection, Units, Properties, Polygon, BBox } from "@turf/helpers";
+import { Feature, FeatureCollection, GeoJsonProperties, Polygon, BBox } from "geojson";
+import { Units } from "@turf/helpers";
 /**
  * Takes a bounding box and the diameter of the cell and returns a {@link FeatureCollection} of flat-topped
  * hexagons or triangles ({@link Polygon} features) aligned in an "odd-q" vertical grid as
@@ -24,10 +25,10 @@ import { Feature, FeatureCollection, Units, Properties, Polygon, BBox } from "@t
  * //addToMap
  * var addToMap = [hexgrid];
  */
-declare function hexGrid<P = Properties>(bbox: BBox, cellSide: number, options?: {
+declare function hexGrid<P = GeoJsonProperties>(bbox: BBox, cellSide: number, options?: {
     units?: Units;
     triangles?: boolean;
     properties?: P;
-    mask?: Feature<Polygon> | Polygon;
+    mask?: Feature<Polygon>;
 }): FeatureCollection<Polygon, P>;
 export default hexGrid;

package/dist/js/index.js

@@ -1,11 +1,9 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var distance_1 = __importDefault(require("@turf/distance"));
-var intersect_1 = __importDefault(require("@turf/intersect"));
-var helpers_1 = require("@turf/helpers");
+const tslib_1 = require("tslib");
+const distance_1 = tslib_1.__importDefault(require("@turf/distance"));
+const intersect_1 = tslib_1.__importDefault(require("@turf/intersect"));
+const helpers_1 = require("@turf/helpers");
 /**
  * Takes a bounding box and the diameter of the cell and returns a {@link FeatureCollection} of flat-topped
  * hexagons or triangles ({@link Polygon} features) aligned in an "odd-q" vertical grid as
@@ -31,63 +29,62 @@ var helpers_1 = require("@turf/helpers");
  * //addToMap
  * var addToMap = [hexgrid];
  */
-function hexGrid(bbox, cellSide, options) {
-    if (options === void 0) { options = {}; }
+function hexGrid(bbox, cellSide, options = {}) {
     // Issue => https://github.com/Turfjs/turf/issues/1284
-    var clonedProperties = JSON.stringify(options.properties || {});
-    var west = bbox[0], south = bbox[1], east = bbox[2], north = bbox[3];
-    var centerY = (south + north) / 2;
-    var centerX = (west + east) / 2;
+    const clonedProperties = JSON.stringify(options.properties || {});
+    const [west, south, east, north] = bbox;
+    const centerY = (south + north) / 2;
+    const centerX = (west + east) / 2;
     // https://github.com/Turfjs/turf/issues/758
-    var xFraction = (cellSide * 2) / distance_1.default([west, centerY], [east, centerY], options);
-    var cellWidth = xFraction * (east - west);
-    var yFraction = (cellSide * 2) / distance_1.default([centerX, south], [centerX, north], options);
-    var cellHeight = yFraction * (north - south);
-    var radius = cellWidth / 2;
-    var hex_width = radius * 2;
-    var hex_height = (Math.sqrt(3) / 2) * cellHeight;
-    var box_width = east - west;
-    var box_height = north - south;
-    var x_interval = (3 / 4) * hex_width;
-    var y_interval = hex_height;
+    const xFraction = (cellSide * 2) / distance_1.default([west, centerY], [east, centerY], options);
+    const cellWidth = xFraction * (east - west);
+    const yFraction = (cellSide * 2) / distance_1.default([centerX, south], [centerX, north], options);
+    const cellHeight = yFraction * (north - south);
+    const radius = cellWidth / 2;
+    const hex_width = radius * 2;
+    const hex_height = (Math.sqrt(3) / 2) * cellHeight;
+    const box_width = east - west;
+    const box_height = north - south;
+    const x_interval = (3 / 4) * hex_width;
+    const y_interval = hex_height;
     // adjust box_width so all hexagons will be inside the bbox
-    var x_span = (box_width - hex_width) / (hex_width - radius / 2);
-    var x_count = Math.floor(x_span);
-    var x_adjust = (x_count * x_interval - radius / 2 - box_width) / 2 -
+    const x_span = (box_width - hex_width) / (hex_width - radius / 2);
+    const x_count = Math.floor(x_span);
+    const x_adjust = (x_count * x_interval - radius / 2 - box_width) / 2 -
         radius / 2 +
         x_interval / 2;
     // adjust box_height so all hexagons will be inside the bbox
-    var y_count = Math.floor((box_height - hex_height) / hex_height);
-    var y_adjust = (box_height - y_count * hex_height) / 2;
-    var hasOffsetY = y_count * hex_height - box_height > hex_height / 2;
+    const y_count = Math.floor((box_height - hex_height) / hex_height);
+    let y_adjust = (box_height - y_count * hex_height) / 2;
+    const hasOffsetY = y_count * hex_height - box_height > hex_height / 2;
     if (hasOffsetY) {
         y_adjust -= hex_height / 4;
     }
     // Precompute cosines and sines of angles used in hexagon creation for performance gain
-    var cosines = [];
-    var sines = [];
-    for (var i = 0; i < 6; i++) {
-        var angle = ((2 * Math.PI) / 6) * i;
+    const cosines = [];
+    const sines = [];
+    for (let i = 0; i < 6; i++) {
+        const angle = ((2 * Math.PI) / 6) * i;
         cosines.push(Math.cos(angle));
         sines.push(Math.sin(angle));
     }
-    var results = [];
-    for (var x = 0; x <= x_count; x++) {
-        for (var y = 0; y <= y_count; y++) {
-            var isOdd = x % 2 === 1;
+    const results = [];
+    for (let x = 0; x <= x_count; x++) {
+        for (let y = 0; y <= y_count; y++) {
+            const isOdd = x % 2 === 1;
             if (y === 0 && isOdd)
                 continue;
             if (y === 0 && hasOffsetY)
                 continue;
-            var center_x = x * x_interval + west - x_adjust;
-            var center_y = y * y_interval + south + y_adjust;
+            const center_x = x * x_interval + west - x_adjust;
+            let center_y = y * y_interval + south + y_adjust;
             if (isOdd) {
                 center_y -= hex_height / 2;
             }
             if (options.triangles === true) {
                 hexTriangles([center_x, center_y], cellWidth / 2, cellHeight / 2, JSON.parse(clonedProperties), cosines, sines).forEach(function (triangle) {
                     if (options.mask) {
-                        if (intersect_1.default(options.mask, triangle))
+                        if (intersect_1.default(helpers_1.featureCollection([options.mask, triangle])))
                             results.push(triangle);
                     }
                     else {
@@ -96,9 +93,9 @@ function hexGrid(bbox, cellSide, options) {
                 });
             }
             else {
-                var hex = hexagon([center_x, center_y], cellWidth / 2, cellHeight / 2, JSON.parse(clonedProperties), cosines, sines);
+                const hex = hexagon([center_x, center_y], cellWidth / 2, cellHeight / 2, JSON.parse(clonedProperties), cosines, sines);
                 if (options.mask) {
-                    if (intersect_1.default(options.mask, hex))
+                    if (intersect_1.default(helpers_1.featureCollection([options.mask, hex])))
                         results.push(hex);
                 }
                 else {
@@ -122,10 +119,10 @@ function hexGrid(bbox, cellSide, options) {
  * @returns {Feature<Polygon>} hexagon
  */
 function hexagon(center, rx, ry, properties, cosines, sines) {
-    var vertices = [];
-    for (var i = 0; i < 6; i++) {
-        var x = center[0] + rx * cosines[i];
-        var y = center[1] + ry * sines[i];
+    const vertices = [];
+    for (let i = 0; i < 6; i++) {
+        const x = center[0] + rx * cosines[i];
+        const y = center[1] + ry * sines[i];
         vertices.push([x, y]);
     }
     //first and last vertex must be the same
@@ -145,9 +142,9 @@ function hexagon(center, rx, ry, properties, cosines, sines) {
  * @returns {Array<Feature<Polygon>>} triangles
  */
 function hexTriangles(center, rx, ry, properties, cosines, sines) {
-    var triangles = [];
-    for (var i = 0; i < 6; i++) {
-        var vertices = [];
+    const triangles = [];
+    for (let i = 0; i < 6; i++) {
+        const vertices = [];
         vertices.push(center);
         vertices.push([center[0] + rx * cosines[i], center[1] + ry * sines[i]]);
         vertices.push([

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/hex-grid",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf hex-grid module",
   "author": "Turf Authors",
   "contributors": [
@@ -37,6 +37,7 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "types": "./dist/js/index.d.ts",
       "import": "./dist/es/index.js",
       "require": "./dist/js/index.js"
     }
@@ -47,33 +48,34 @@
     "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:types": "tsc --esModuleInterop --noEmit types.ts"
+    "test:tape": "tsx test.js",
+    "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
   },
   "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": "*",
     "load-json-file": "*",
     "npm-run-all": "*",
     "tape": "*",
-    "ts-node": "*",
     "tslint": "*",
+    "tsx": "*",
     "typescript": "*",
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/distance": "^6.5.0",
-    "@turf/helpers": "^6.5.0",
-    "@turf/intersect": "^6.5.0",
-    "@turf/invariant": "^6.5.0"
+    "@turf/distance": "^7.0.0-alpha.1",
+    "@turf/helpers": "^7.0.0-alpha.1",
+    "@turf/intersect": "^7.0.0-alpha.1",
+    "@turf/invariant": "^7.0.0-alpha.1",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
 }