@turf/points-within-polygon 6.5.0 → 7.0.0-alpha.1

package/README.md

@@ -4,14 +4,14 @@
 
 ## pointsWithinPolygon
 
-Finds [Points][1] that fall within [(Multi)Polygon(s)][2].
+Finds [Points][1] or [MultiPoint][2] coordinate positions that fall within [(Multi)Polygon(s)][3].
 
-**Parameters**
+### Parameters
 
--   `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)
+*   `points` **([Feature][4] | [FeatureCollection][5]<([Point][6] | [MultiPoint][7])>)** Point(s) or MultiPoint(s) as input search
+*   `polygons` **([FeatureCollection][5] | [Geometry][8] | [Feature][4]<([Polygon][9] | [MultiPolygon][10])>)** (Multi)Polygon(s) to check if points are within
 
-**Examples**
+### Examples
 
 ```javascript
 var points = turf.points([
@@ -42,23 +42,27 @@ turf.featureEach(ptsWithin, function (currentFeature) {
 });
 ```
 
-Returns **[FeatureCollection][4]&lt;[Point][5]>** points that land within at least one polygon
+Returns **[FeatureCollection][5]<([Point][6] | [MultiPoint][7])>** Point(s) or MultiPoint(s) with positions that land within at least one polygon.  The geometry type will match what was passsed in
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2
 
-[2]: https://tools.ietf.org/html/rfc7946#section-3.1.6
+[2]: https://tools.ietf.org/html/rfc7946#section-3.1.3
 
-[3]: https://tools.ietf.org/html/rfc7946#section-3.2
+[3]: https://tools.ietf.org/html/rfc7946#section-3.1.6
 
-[4]: https://tools.ietf.org/html/rfc7946#section-3.3
+[4]: https://tools.ietf.org/html/rfc7946#section-3.2
 
-[5]: https://tools.ietf.org/html/rfc7946#section-3.1.2
+[5]: https://tools.ietf.org/html/rfc7946#section-3.3
 
-[6]: https://tools.ietf.org/html/rfc7946#section-3.1
+[6]: https://tools.ietf.org/html/rfc7946#section-3.1.2
 
-[7]: https://tools.ietf.org/html/rfc7946#section-3.1.6
+[7]: https://tools.ietf.org/html/rfc7946#section-3.1.3
 
-[8]: https://tools.ietf.org/html/rfc7946#section-3.1.7
+[8]: https://tools.ietf.org/html/rfc7946#section-3.1
+
+[9]: https://tools.ietf.org/html/rfc7946#section-3.1.6
+
+[10]: https://tools.ietf.org/html/rfc7946#section-3.1.7
 
 <!-- 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

package/dist/es/index.js

@@ -59,7 +59,7 @@ function pointsWithinPolygon(points, polygons) {
         });
       });
       if (contained) {
-        results.push(multiPoint(pointsWithin));
+        results.push(multiPoint(pointsWithin, point.properties || {}));
       }
     } else {
       throw new Error("Input geometry must be a Point or MultiPoint");

package/dist/js/index.js

@@ -65,7 +65,7 @@ function pointsWithinPolygon(points, polygons) {
         });
       });
       if (contained) {
-        results.push(helpers.multiPoint(pointsWithin));
+        results.push(helpers.multiPoint(pointsWithin, point.properties || {}));
       }
     } else {
       throw new Error("Input geometry must be a Point or MultiPoint");

package/index.d.ts

@@ -5,8 +5,8 @@ import {
   MultiPolygon,
   MultiPoint,
   Point,
-  Properties,
-} from "@turf/helpers";
+  GeoJsonProperties,
+} from "geojson";
 
 /**
  * http://turfjs.org/docs/#pointswithinpolygon
@@ -14,7 +14,7 @@ import {
 export default function pointsWithinPolygon<
   F extends Point | MultiPoint,
   G extends Polygon | MultiPolygon,
-  P = Properties
+  P = GeoJsonProperties
 >(
   points: Feature<F, P> | FeatureCollection<F, P>,
   polygons: Feature<G> | FeatureCollection<G> | G

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/points-within-polygon",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf points-within-polygon module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -28,6 +28,7 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "types": "./index.d.ts",
       "import": "./dist/es/index.js",
       "require": "./dist/js/index.js"
     }
@@ -39,23 +40,24 @@
     "index.d.ts"
   ],
   "scripts": {
-    "bench": "node -r esm bench.js",
+    "bench": "tsx bench.js",
     "build": "rollup -c ../../rollup.config.js && echo '{\"type\":\"module\"}' > dist/es/package.json",
-    "docs": "node ../../scripts/generate-readmes",
+    "docs": "tsx ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
-    "test:tape": "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": {
     "benchmark": "*",
     "npm-run-all": "*",
     "rollup": "*",
-    "tape": "*"
+    "tape": "*",
+    "tsx": "*"
   },
   "dependencies": {
-    "@turf/boolean-point-in-polygon": "^6.5.0",
-    "@turf/helpers": "^6.5.0",
-    "@turf/meta": "^6.5.0"
+    "@turf/boolean-point-in-polygon": "^7.0.0-alpha.1",
+    "@turf/helpers": "^7.0.0-alpha.1",
+    "@turf/meta": "^7.0.0-alpha.1"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
 }