@turf/points-within-polygon 6.4.0 → 6.5.0

package/dist/es/index.js

@@ -1,14 +1,14 @@
 import pointInPolygon from '@turf/boolean-point-in-polygon';
-import { featureCollection } from '@turf/helpers';
-import { geomEach, featureEach } from '@turf/meta';
+import { multiPoint, featureCollection } from '@turf/helpers';
+import { featureEach, geomEach, coordEach } from '@turf/meta';
 
 /**
- * Finds {@link Points} that fall within {@link (Multi)Polygon(s)}.
+ * Finds {@link Points} or {@link MultiPoint} coordinate positions that fall within {@link (Multi)Polygon(s)}.
  *
  * @name pointsWithinPolygon
- * @param {Feature|FeatureCollection<Point>} points Points as input search
- * @param {FeatureCollection|Geometry|Feature<Polygon|MultiPolygon>} polygons Points must be within these (Multi)Polygon(s)
- * @returns {FeatureCollection<Point>} points that land within at least one polygon
+ * @param {Feature|FeatureCollection<Point|MultiPoint>} points Point(s) or MultiPoint(s) as input search
+ * @param {FeatureCollection|Geometry|Feature<Polygon|MultiPolygon>} polygons (Multi)Polygon(s) to check if points are within
+ * @returns {FeatureCollection<Point|MultiPoint>} Point(s) or MultiPoint(s) with positions that land within at least one polygon.  The geometry type will match what was passsed in
  * @example
  * var points = turf.points([
  *     [-46.6318, -23.5523],
@@ -41,11 +41,28 @@ function pointsWithinPolygon(points, polygons) {
   var results = [];
   featureEach(points, function (point) {
     var contained = false;
-    geomEach(polygons, function (polygon) {
-      if (pointInPolygon(point, polygon)) contained = true;
-    });
-    if (contained) {
-      results.push(point);
+    if (point.geometry.type === "Point") {
+      geomEach(polygons, function (polygon) {
+        if (pointInPolygon(point, polygon)) contained = true;
+      });
+      if (contained) {
+        results.push(point);
+      }
+    } else if (point.geometry.type === "MultiPoint") {
+      var pointsWithin = [];
+      geomEach(polygons, function (polygon) {
+        coordEach(point, function (pointCoord) {
+          if (pointInPolygon(pointCoord, polygon)) {
+            contained = true;
+            pointsWithin.push(pointCoord);
+          }
+        });
+      });
+      if (contained) {
+        results.push(multiPoint(pointsWithin));
+      }
+    } else {
+      throw new Error("Input geometry must be a Point or MultiPoint");
     }
   });
   return featureCollection(results);

package/dist/js/index.js

@@ -1,18 +1,20 @@
 'use strict';
 
-function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
-
-var pointInPolygon = _interopDefault(require('@turf/boolean-point-in-polygon'));
+var pointInPolygon = require('@turf/boolean-point-in-polygon');
 var helpers = require('@turf/helpers');
 var meta = require('@turf/meta');
 
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var pointInPolygon__default = /*#__PURE__*/_interopDefaultLegacy(pointInPolygon);
+
 /**
- * Finds {@link Points} that fall within {@link (Multi)Polygon(s)}.
+ * Finds {@link Points} or {@link MultiPoint} coordinate positions that fall within {@link (Multi)Polygon(s)}.
  *
  * @name pointsWithinPolygon
- * @param {Feature|FeatureCollection<Point>} points Points as input search
- * @param {FeatureCollection|Geometry|Feature<Polygon|MultiPolygon>} polygons Points must be within these (Multi)Polygon(s)
- * @returns {FeatureCollection<Point>} points that land within at least one polygon
+ * @param {Feature|FeatureCollection<Point|MultiPoint>} points Point(s) or MultiPoint(s) as input search
+ * @param {FeatureCollection|Geometry|Feature<Polygon|MultiPolygon>} polygons (Multi)Polygon(s) to check if points are within
+ * @returns {FeatureCollection<Point|MultiPoint>} Point(s) or MultiPoint(s) with positions that land within at least one polygon.  The geometry type will match what was passsed in
  * @example
  * var points = turf.points([
  *     [-46.6318, -23.5523],
@@ -45,14 +47,32 @@ function pointsWithinPolygon(points, polygons) {
   var results = [];
   meta.featureEach(points, function (point) {
     var contained = false;
-    meta.geomEach(polygons, function (polygon) {
-      if (pointInPolygon(point, polygon)) contained = true;
-    });
-    if (contained) {
-      results.push(point);
+    if (point.geometry.type === "Point") {
+      meta.geomEach(polygons, function (polygon) {
+        if (pointInPolygon__default['default'](point, polygon)) contained = true;
+      });
+      if (contained) {
+        results.push(point);
+      }
+    } else if (point.geometry.type === "MultiPoint") {
+      var pointsWithin = [];
+      meta.geomEach(polygons, function (polygon) {
+        meta.coordEach(point, function (pointCoord) {
+          if (pointInPolygon__default['default'](pointCoord, polygon)) {
+            contained = true;
+            pointsWithin.push(pointCoord);
+          }
+        });
+      });
+      if (contained) {
+        results.push(helpers.multiPoint(pointsWithin));
+      }
+    } else {
+      throw new Error("Input geometry must be a Point or MultiPoint");
     }
   });
   return helpers.featureCollection(results);
 }
 
 module.exports = pointsWithinPolygon;
+module.exports.default = pointsWithinPolygon;

package/index.d.ts

@@ -3,6 +3,7 @@ import {
   FeatureCollection,
   Polygon,
   MultiPolygon,
+  MultiPoint,
   Point,
   Properties,
 } from "@turf/helpers";
@@ -11,9 +12,10 @@ import {
  * http://turfjs.org/docs/#pointswithinpolygon
  */
 export default function pointsWithinPolygon<
+  F extends Point | MultiPoint,
   G extends Polygon | MultiPolygon,
   P = Properties
 >(
-  points: Feature<Point, P> | FeatureCollection<Point, P>,
+  points: Feature<F, P> | FeatureCollection<F, P>,
   polygons: Feature<G> | FeatureCollection<G> | G
-): FeatureCollection<Point, P>;
+): FeatureCollection<F, P>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/points-within-polygon",
-  "version": "6.4.0",
+  "version": "6.5.0",
   "description": "turf points-within-polygon 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"
   },
@@ -52,9 +53,9 @@
     "tape": "*"
   },
   "dependencies": {
-    "@turf/boolean-point-in-polygon": "^6.4.0",
-    "@turf/helpers": "^6.4.0",
-    "@turf/meta": "^6.4.0"
+    "@turf/boolean-point-in-polygon": "^6.5.0",
+    "@turf/helpers": "^6.5.0",
+    "@turf/meta": "^6.5.0"
   },
-  "gitHead": "1e62773cfc88c627cca8effcb5c14cfb65a905ac"
+  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
 }