@turf/triangle-grid - npm Package Compare versions

Comparing version 6.5.0 to 7.0.0-alpha.0

dist/es/index.js

 import distance from "@turf/distance";
 import intersect from "@turf/intersect";
-import { polygon, featureCollection, } from "@turf/helpers";
+import { polygon, featureCollection } from "@turf/helpers";
 /**
@@ -25,4 +25,3 @@ * Takes a bounding box and a cell depth and returns a set of triangular {@link Polygon|polygons} in a grid.
  */
-function triangleGrid(bbox, cellSide, options) {
-    if (options === void 0) { options = {}; }
+function triangleGrid(bbox, cellSide, options = {}) {
     // Containers
@@ -123,5 +122,5 @@ var results = [];
             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);
@@ -128,0 +127,0 @@ }

dist/js/index.d.ts

@@ -1,2 +0,3 @@
-import { Units, BBox, Feature, Polygon, FeatureCollection, Properties } from "@turf/helpers";
+import { BBox, Feature, Polygon, FeatureCollection, GeoJsonProperties } from "geojson";
+import { Units } from "@turf/helpers";
 /**
@@ -23,7 +24,7 @@ * Takes a bounding box and a cell depth and returns a set of triangular {@link Polygon|polygons} in a grid.
  */
-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;

dist/js/index.js

 "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");
 /**
@@ -30,4 +28,3 @@ * Takes a bounding box and a cell depth and returns a set of triangular {@link Polygon|polygons} in a grid.
  */
-function triangleGrid(bbox, cellSide, options) {
-    if (options === void 0) { options = {}; }
+function triangleGrid(bbox, cellSide, options = {}) {
     // Containers
@@ -128,5 +125,5 @@ var results = [];
             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);
@@ -133,0 +130,0 @@ }

package.json

 {
   "name": "@turf/triangle-grid",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf triangle-grid module",
@@ -49,7 +49,7 @@ "author": "Turf Authors",
     "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.5.0",
-    "@turf/truncate": "^6.5.0",
+    "@turf/bbox-polygon": "^7.0.0-alpha.0",
+    "@turf/truncate": "^7.0.0-alpha.0",
     "@types/tape": "*",
@@ -66,7 +66,8 @@ "benchmark": "*",
   "dependencies": {
-    "@turf/distance": "^6.5.0",
-    "@turf/helpers": "^6.5.0",
-    "@turf/intersect": "^6.5.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": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
 }

README.md

@@ -9,13 +9,14 @@ # @turf/triangle-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
@@ -32,3 +33,3 @@ var bbox = [-95, 30 ,-85, 40];
 
-Returns **[FeatureCollection][8]&lt;[Polygon][7]>** grid of polygons
+Returns **[FeatureCollection][8]<[Polygon][7]>** grid of polygons
 
@@ -35,0 +36,0 @@ [1]: https://tools.ietf.org/html/rfc7946#section-3.1.6

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

18810

increased by0.22%

Number of lines in readme file

74

increased by1.37%

Worsened metrics

Dependency count

4

increased by33.33%

Lines of code

308

decreased by-0.96%

Number of low quality alerts

1

increased byInfinity%

Dependency changes

• + Addedtslib@^2.3.0

• + Added@turf/distance@7.0.0-alpha.116(transitive)

• + Added@turf/helpers@7.0.0-alpha.116(transitive)

• + Added@turf/intersect@7.0.0-alpha.116(transitive)

• + Added@turf/invariant@7.0.0-alpha.116(transitive)

• + Added@turf/meta@7.0.0-alpha.116(transitive)

• + Addedarray-buffer-byte-length@1.0.1(transitive)

• + Addedavailable-typed-arrays@1.0.7(transitive)

• + Addedcall-bind@1.0.7(transitive)

• + Addeddeep-equal@2.2.3(transitive)

• + Addeddefine-data-property@1.1.4(transitive)

• + Addeddefine-properties@1.2.1(transitive)

• + Addedes-define-property@1.0.0(transitive)

• + Addedes-errors@1.3.0(transitive)

• + Addedes-get-iterator@1.1.3(transitive)

• + Addedfor-each@0.3.3(transitive)

• + Addedfunction-bind@1.1.2(transitive)

• + Addedfunctions-have-names@1.2.3(transitive)

• + Addedget-intrinsic@1.2.4(transitive)

• + Addedgopd@1.0.1(transitive)

• + Addedhas-bigints@1.0.2(transitive)

• + Addedhas-property-descriptors@1.0.2(transitive)

• + Addedhas-proto@1.0.3(transitive)

• + Addedhas-symbols@1.0.3(transitive)

• + Addedhas-tostringtag@1.0.2(transitive)

• + Addedhasown@2.0.2(transitive)

• + Addedinternal-slot@1.0.7(transitive)

• + Addedis-arguments@1.1.1(transitive)

• + Addedis-array-buffer@3.0.4(transitive)

• + Addedis-bigint@1.0.4(transitive)

• + Addedis-boolean-object@1.1.2(transitive)

• + Addedis-callable@1.2.7(transitive)

• + Addedis-date-object@1.0.5(transitive)

• + Addedis-map@2.0.3(transitive)

• + Addedis-number-object@1.0.7(transitive)

• + Addedis-regex@1.1.4(transitive)

• + Addedis-set@2.0.3(transitive)

• + Addedis-shared-array-buffer@1.0.3(transitive)

• + Addedis-string@1.0.7(transitive)

• + Addedis-symbol@1.0.4(transitive)

• + Addedis-weakmap@2.0.2(transitive)

• + Addedis-weakset@2.0.3(transitive)

• + Addedisarray@2.0.5(transitive)

• + Addedobject-inspect@1.13.1(transitive)

• + Addedobject-is@1.1.6(transitive)

• + Addedobject-keys@1.1.1(transitive)

• + Addedobject.assign@4.1.5(transitive)

• + Addedpossible-typed-array-names@1.0.0(transitive)

• + Addedregexp.prototype.flags@1.5.2(transitive)

• + Addedset-function-length@1.2.2(transitive)

• + Addedset-function-name@2.0.2(transitive)

• + Addedside-channel@1.0.6(transitive)

• + Addedstop-iteration-iterator@1.0.0(transitive)

• + Addedtslib@2.6.2(transitive)

• + Addedwhich-boxed-primitive@1.0.2(transitive)

• + Addedwhich-collection@1.0.2(transitive)

• + Addedwhich-typed-array@1.1.15(transitive)

• - Removed@turf/distance@6.5.0(transitive)

• - Removed@turf/helpers@6.5.0(transitive)

• - Removed@turf/intersect@6.5.0(transitive)

• - Removed@turf/invariant@6.5.0(transitive)

• Updated@turf/distance@^7.0.0-alpha.0

• Updated@turf/helpers@^7.0.0-alpha.0

• Updated@turf/intersect@^7.0.0-alpha.0