@turf/triangle-grid 6.4.0 → 7.0.0-alpha.0

package/README.md

@@ -6,16 +6,17 @@
 
 Takes a bounding box and a cell depth and returns a set of triangular [polygons][1] in a grid.
 
-**Parameters**
+### Parameters
 
--   `bbox` **[Array][2]<[number][3]>** extent in [minX, minY, maxX, maxY] order
--   `cellSide` **[number][3]** dimension of each cell
--   `options` **[Object][4]** Optional parameters (optional, default `{}`)
-    -   `options.units` **[string][5]** used in calculating cellSide, can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`)
-    -   `options.mask` **[Feature][6]<[Polygon][7]>?** if passed a Polygon or MultiPolygon, the grid Points will be created only inside it
-    -   `options.properties` **[Object][4]** passed to each point of the grid (optional, default `{}`)
+*   `bbox` **[Array][2]<[number][3]>** extent in \[minX, minY, maxX, maxY] order
+*   `cellSide` **[number][3]** dimension of each cell
+*   `options` **[Object][4]** Optional parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.units` **[string][5]** used in calculating cellSide, can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`)
+    *   `options.mask` **[Feature][6]<[Polygon][7]>?** if passed a Polygon or MultiPolygon, the grid Points will be created only inside it
+    *   `options.properties` **[Object][4]** passed to each point of the grid (optional, default `{}`)
+
+### Examples
 
 ```javascript
 var bbox = [-95, 30 ,-85, 40];
@@ -28,7 +29,7 @@ var triangleGrid = turf.triangleGrid(bbox, cellSide, options);
 var addToMap = [triangleGrid];
 ```
 
-Returns **[FeatureCollection][8]&lt;[Polygon][7]>** grid of polygons
+Returns **[FeatureCollection][8]<[Polygon][7]>** grid of polygons
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.1.6
 

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 a cell depth and returns a set of triangular {@link Polygon|polygons} in a grid.
  *
@@ -22,8 +22,7 @@ import { polygon, featureCollection, } from "@turf/helpers";
  * //addToMap
  * var addToMap = [triangleGrid];
  */
-function triangleGrid(bbox, cellSide, options) {
-    if (options === void 0) { options = {}; }
+function triangleGrid(bbox, cellSide, options = {}) {
     // Containers
     var results = [];
     // Input Validation is being handled by Typescript
@@ -119,9 +118,9 @@ function triangleGrid(bbox, cellSide, options) {
                 ], options.properties);
             }
             if (options.mask) {
-                if (intersect(options.mask, cellTriangle1))
+                if (intersect(featureCollection([options.mask, cellTriangle1])))
                     results.push(cellTriangle1);
-                if (intersect(options.mask, cellTriangle2))
+                if (intersect(featureCollection([options.mask, cellTriangle2])))
                     results.push(cellTriangle2);
             }
             else {

package/dist/js/index.d.ts

@@ -1,4 +1,5 @@
-import { Units, BBox, Feature, Polygon, FeatureCollection, Properties } from "@turf/helpers";
+import { BBox, Feature, Polygon, FeatureCollection, GeoJsonProperties } from "geojson";
+import { Units } from "@turf/helpers";
 /**
  * Takes a bounding box and a cell depth and returns a set of triangular {@link Polygon|polygons} in a grid.
  *
@@ -20,9 +21,9 @@ import { Units, BBox, Feature, Polygon, FeatureCollection, Properties } from "@t
  * //addToMap
  * var addToMap = [triangleGrid];
  */
-declare function triangleGrid<P = Properties>(bbox: BBox, cellSide: number, options?: {
+declare function triangleGrid<P = GeoJsonProperties>(bbox: BBox, cellSide: number, options?: {
     units?: Units;
     properties?: P;
-    mask?: Feature<Polygon> | Polygon;
+    mask?: Feature<Polygon>;
 }): FeatureCollection<Polygon, P>;
 export default triangleGrid;

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 a cell depth and returns a set of triangular {@link Polygon|polygons} in a grid.
  *
@@ -27,8 +25,7 @@ var helpers_1 = require("@turf/helpers");
  * //addToMap
  * var addToMap = [triangleGrid];
  */
-function triangleGrid(bbox, cellSide, options) {
-    if (options === void 0) { options = {}; }
+function triangleGrid(bbox, cellSide, options = {}) {
     // Containers
     var results = [];
     // Input Validation is being handled by Typescript
@@ -124,9 +121,9 @@ function triangleGrid(bbox, cellSide, options) {
                 ], options.properties);
             }
             if (options.mask) {
-                if (intersect_1.default(options.mask, cellTriangle1))
+                if (intersect_1.default(helpers_1.featureCollection([options.mask, cellTriangle1])))
                     results.push(cellTriangle1);
-                if (intersect_1.default(options.mask, cellTriangle2))
+                if (intersect_1.default(helpers_1.featureCollection([options.mask, cellTriangle2])))
                     results.push(cellTriangle2);
             }
             else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/triangle-grid",
-  "version": "6.4.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf triangle-grid module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -12,6 +12,7 @@
     "type": "git",
     "url": "git://github.com/Turfjs/turf.git"
   },
+  "funding": "https://opencollective.com/turf",
   "publishConfig": {
     "access": "public"
   },
@@ -45,11 +46,11 @@
     "docs": "node ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
     "test:tape": "ts-node -r esm test.js",
-    "test:types": "tsc --esModuleInterop --noEmit types.ts"
+    "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
   },
   "devDependencies": {
-    "@turf/bbox-polygon": "^6.4.0",
-    "@turf/truncate": "^6.4.0",
+    "@turf/bbox-polygon": "^7.0.0-alpha.0",
+    "@turf/truncate": "^7.0.0-alpha.0",
     "@types/tape": "*",
     "benchmark": "*",
     "load-json-file": "*",
@@ -61,9 +62,10 @@
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/distance": "^6.4.0",
-    "@turf/helpers": "^6.4.0",
-    "@turf/intersect": "^6.4.0"
+    "@turf/distance": "^7.0.0-alpha.0",
+    "@turf/helpers": "^7.0.0-alpha.0",
+    "@turf/intersect": "^7.0.0-alpha.0",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "1e62773cfc88c627cca8effcb5c14cfb65a905ac"
+  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
 }