@turf/within
Advanced tools
Comparing version 3.0.15 to 3.0.16
{ | ||
"name": "@turf/within", | ||
"version": "3.0.15", | ||
"version": "3.0.16", | ||
"description": "turf within module", | ||
@@ -11,3 +11,3 @@ "main": "index.js", | ||
"type": "git", | ||
"url": "https://github.com/Turfjs/turf-within.git" | ||
"url": "git://github.com/Turfjs/turf.git" | ||
}, | ||
@@ -24,14 +24,14 @@ "keywords": [ | ||
"bugs": { | ||
"url": "https://github.com/Turfjs/turf-within/issues" | ||
"url": "https://github.com/Turfjs/turf/issues" | ||
}, | ||
"homepage": "https://github.com/Turfjs/turf-within", | ||
"homepage": "https://github.com/Turfjs/turf", | ||
"devDependencies": { | ||
"benchmark": "^1.0.0", | ||
"tape": "^3.5.0", | ||
"@turf/helpers": "^3.0.15" | ||
"@turf/helpers": "^3.0.16" | ||
}, | ||
"dependencies": { | ||
"@turf/inside": "^3.0.15", | ||
"@turf/helpers": "^3.0.15" | ||
"@turf/inside": "^3.0.16", | ||
"@turf/helpers": "^3.0.16" | ||
} | ||
} |
@@ -1,11 +0,11 @@ | ||
# turf-within | ||
# @turf/within | ||
# within | ||
Takes a set of [points](Point) and a set of [polygons](Polygon) and returns the points that fall within the polygons. | ||
Takes a set of [points](http://geojson.org/geojson-spec.html#point) and a set of [polygons](http://geojson.org/geojson-spec.html#polygon) and returns the points that fall within the polygons. | ||
**Parameters** | ||
- `points` **FeatureCollection<Point>** input points | ||
- `polygons` **FeatureCollection<Polygon>** input polygons | ||
- `points` **[FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects)<[Point](http://geojson.org/geojson-spec.html#point)>** input points | ||
- `polygons` **[FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects)<[Polygon](http://geojson.org/geojson-spec.html#polygon)>** input polygons | ||
@@ -87,3 +87,3 @@ **Examples** | ||
Returns **FeatureCollection<Point>** points that land within at least one polygon | ||
Returns **[FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects)<[Point](http://geojson.org/geojson-spec.html#point)>** points that land within at least one polygon | ||
@@ -102,3 +102,3 @@ --- | ||
```sh | ||
$ npm install turf-within | ||
$ npm install @turf/within | ||
``` | ||
@@ -109,3 +109,3 @@ | ||
```sh | ||
$ npm install turf | ||
$ npm install @turf/turf | ||
``` |
9344
Updated@turf/helpers@^3.0.16
Updated@turf/inside@^3.0.16