@turf/points-within-polygon - npm Package Compare versions

Comparing version 5.1.5 to 6.2.0-alpha.0

index.d.ts

@@ -1,2 +0,2 @@
-import { Feature, FeatureCollection, Polygon, MultiPolygon, Point } from '@turf/helpers'
+import { Feature, FeatureCollection, Polygon, MultiPolygon, Point, Properties } from '@turf/helpers'
 
@@ -6,5 +6,5 @@ /**
  */
-export default function pointsWithinPolygon<G extends Polygon | MultiPolygon>(
-    points: Feature<Point> | FeatureCollection<Point>,
+export default function pointsWithinPolygon<G extends Polygon | MultiPolygon, P = Properties>(
+    points: Feature<Point, P> | FeatureCollection<Point, P>,
     polygons: Feature<G> | FeatureCollection<G> | G
-): FeatureCollection<Point>;
+): FeatureCollection<Point, P>;

package.json

 {
   "name": "@turf/points-within-polygon",
-  "version": "5.1.5",
+  "version": "6.2.0-alpha.0",
   "description": "turf points-within-polygon module",
-  "main": "main.js",
-  "module": "main.es.js",
-  "types": "index.d.ts",
-  "files": [
-    "index.js",
-    "index.d.ts",
-    "main.js",
-    "main.es.js"
-  ],
-  "scripts": {
-    "pretest": "rollup -c ../../rollup.config.js",
-    "test": "node -r @std/esm test.js",
-    "posttest": "node -r @std/esm ../../scripts/validate-es5-dependencies.js",
-    "bench": "node -r @std/esm bench.js",
-    "docs": "node ../../scripts/generate-readmes"
+  "author": "Turf Authors",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Turfjs/turf/issues"
   },
+  "homepage": "https://github.com/Turfjs/turf",
   "repository": {
@@ -32,10 +22,21 @@ "type": "git",
   ],
-  "author": "Turf Authors",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/Turfjs/turf/issues"
+  "main": "dist/js/index.js",
+  "module": "dist/es/index.js",
+  "types": "index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "index.d.ts"
+  ],
+  "scripts": {
+    "bench": "npm-run-all prepare bench:run",
+    "bench:run": "node bench.js",
+    "docs": "node ../../scripts/generate-readmes",
+    "posttest": "node -r esm ../../scripts/validate-es5-dependencies.js",
+    "prepare": "rollup -c ../../rollup.config.js",
+    "test": "npm-run-all prepare test:*",
+    "test:tape": "node -r esm test.js",
+    "test:types": "tsc --noEmit types.ts"
   },
-  "homepage": "https://github.com/Turfjs/turf",
   "devDependencies": {
-    "@std/esm": "*",
     "benchmark": "*",
@@ -46,10 +47,7 @@ "rollup": "*",
   "dependencies": {
-    "@turf/boolean-point-in-polygon": "^5.1.5",
-    "@turf/helpers": "^5.1.5",
-    "@turf/meta": "^5.1.5"
+    "@turf/boolean-point-in-polygon": "^6.2.0-alpha.0",
+    "@turf/helpers": "^6.2.0-alpha.0",
+    "@turf/meta": "^6.2.0-alpha.0"
   },
-  "@std/esm": {
-    "esm": "js",
-    "cjs": true
-  }
+  "gitHead": "23b651deaa1ca6a0960d0142aea620b7cc6a076d"
 }

README.md

@@ -7,8 +7,8 @@ # @turf/points-within-polygon
 
-Finds [Points](https://tools.ietf.org/html/rfc7946#section-3.1.2) that fall within [(Multi)Polygon(s)](https://tools.ietf.org/html/rfc7946#section-3.1.6).
+Finds [Points][1] that fall within [(Multi)Polygon(s)][2].
 
 **Parameters**
 
--   `points` **(Feauture | [FeatureCollection](https://tools.ietf.org/html/rfc7946#section-3.3)<[Point](https://tools.ietf.org/html/rfc7946#section-3.1.2)>)** Points as input search
--   `polygons` **([FeatureCollection](https://tools.ietf.org/html/rfc7946#section-3.3) | Geoemtry | [Feature](https://tools.ietf.org/html/rfc7946#section-3.2)<([Polygon](https://tools.ietf.org/html/rfc7946#section-3.1.6) \| [MultiPolygon](https://tools.ietf.org/html/rfc7946#section-3.1.7))>)** Points must be within these (Multi)Polygon(s)
+-   `points` **([Feature][3] \| [FeatureCollection][4]<[Point][5]>)** Points as input search
+-   `polygons` **([FeatureCollection][4] \| [Geometry][6] \| [Feature][3]<([Polygon][7] \| [MultiPolygon][8])>)** Points must be within these (Multi)Polygon(s)
 
@@ -46,4 +46,20 @@ **Examples**
 
-Returns **[FeatureCollection](https://tools.ietf.org/html/rfc7946#section-3.3)<[Point](https://tools.ietf.org/html/rfc7946#section-3.1.2)>** points that land within at least one polygon
+Returns **[FeatureCollection][4]<[Point][5]>** points that land within at least one polygon
 
+[1]: https://tools.ietf.org/html/rfc7946#section-3.1.2
+
+[2]: https://tools.ietf.org/html/rfc7946#section-3.1.6
+
+[3]: https://tools.ietf.org/html/rfc7946#section-3.2
+
+[4]: https://tools.ietf.org/html/rfc7946#section-3.3
+
+[5]: https://tools.ietf.org/html/rfc7946#section-3.1.2
+
+[6]: https://tools.ietf.org/html/rfc7946#section-3.1
+
+[7]: https://tools.ietf.org/html/rfc7946#section-3.1.6
+
+[8]: https://tools.ietf.org/html/rfc7946#section-3.1.7
+
 <!-- This file is automatically generated. Please don't edit it directly:
@@ -50,0 +66,0 @@ if you find an error, edit the source file (likely index.js), and re-run

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

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

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

12433

increased by23.26%

Dev dependency count

3

decreased by-25%

Number of package files

8

increased by14.29%

Lines of code

222

increased by43.23%

Number of lines in readme file

87

increased by22.54%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Added@turf/boolean-point-in-polygon@6.5.0(transitive)

• + Added@turf/helpers@6.5.0(transitive)

• + Added@turf/invariant@6.5.0(transitive)

• + Added@turf/meta@6.5.0(transitive)

• - Removed@turf/boolean-point-in-polygon@5.1.5(transitive)

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

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

• - Removed@turf/meta@5.2.0(transitive)

• Updated@turf/boolean-point-in-polygon@^6.2.0-alpha.0

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

• Updated@turf/meta@^6.2.0-alpha.0