@turf/simplify
Advanced tools
Comparing version 3.0.15 to 3.0.16
{ | ||
"name": "@turf/simplify", | ||
"version": "3.0.15", | ||
"version": "3.0.16", | ||
"description": "simplify geographic shapes", | ||
@@ -14,3 +14,3 @@ "main": "index.js", | ||
"type": "git", | ||
"url": "git@github.com:Turfjs/turf-simplify.git" | ||
"url": "git://github.com/Turfjs/turf.git" | ||
}, | ||
@@ -25,5 +25,5 @@ "keywords": [ | ||
"bugs": { | ||
"url": "https://github.com/Turfjs/turf-simplify/issues" | ||
"url": "https://github.com/Turfjs/turf/issues" | ||
}, | ||
"homepage": "https://github.com/Turfjs/turf-simplify", | ||
"homepage": "https://github.com/Turfjs/turf", | ||
"devDependencies": { | ||
@@ -30,0 +30,0 @@ "benchmark": "^1.0.0", |
@@ -1,10 +0,10 @@ | ||
# turf-simplify | ||
# @turf/simplify | ||
# simplify | ||
Takes a [LineString](LineString) or [Polygon](Polygon) and returns a simplified version. Internally uses [simplify-js](http://mourner.github.io/simplify-js/) to perform simplification. | ||
Takes a [LineString](http://geojson.org/geojson-spec.html#linestring) or [Polygon](http://geojson.org/geojson-spec.html#polygon) and returns a simplified version. Internally uses [simplify-js](http://mourner.github.io/simplify-js/) to perform simplification. | ||
**Parameters** | ||
- `feature` **(Feature<(LineString | Polygon | MultiLineString | MultiPolygon)> | FeatureCollection | GeometryCollection)** feature to be simplified | ||
- `feature` **([Feature](http://geojson.org/geojson-spec.html#feature-objects)<([LineString](http://geojson.org/geojson-spec.html#linestring) \| [Polygon](http://geojson.org/geojson-spec.html#polygon) \| [MultiLineString](http://geojson.org/geojson-spec.html#multilinestring) \| [MultiPolygon](http://geojson.org/geojson-spec.html#multipolygon))> | [FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects) \| [GeometryCollection](http://geojson.org/geojson-spec.html#geometrycollection))** feature to be simplified | ||
- `tolerance` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** simplification tolerance | ||
@@ -57,3 +57,3 @@ - `highQuality` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** whether or not to spend more time to create | ||
Returns **(Feature<(LineString | Polygon | MultiLineString | MultiPolygon)> | FeatureCollection | GeometryCollection)** a simplified feature | ||
Returns **([Feature](http://geojson.org/geojson-spec.html#feature-objects)<([LineString](http://geojson.org/geojson-spec.html#linestring) \| [Polygon](http://geojson.org/geojson-spec.html#polygon) \| [MultiLineString](http://geojson.org/geojson-spec.html#multilinestring) \| [MultiPolygon](http://geojson.org/geojson-spec.html#multipolygon))> | [FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects) \| [GeometryCollection](http://geojson.org/geojson-spec.html#geometrycollection))** a simplified feature | ||
@@ -72,3 +72,3 @@ --- | ||
```sh | ||
$ npm install turf-simplify | ||
$ npm install @turf/simplify | ||
``` | ||
@@ -79,3 +79,3 @@ | ||
```sh | ||
$ npm install turf | ||
$ npm install @turf/turf | ||
``` |
11804