@turf/buffer
Advanced tools
Comparing version
14
index.js
@@ -23,16 +23,9 @@ var d3 = require('d3-geo'); | ||
* @name buffer | ||
* @param {FeatureCollection|Geometry|Feature<any>} feature input to be buffered | ||
* @param {FeatureCollection|Geometry|Feature<any>} geojson input to be buffered | ||
* @param {number} radius distance to draw the buffer (negative values are allowed) | ||
* @param {string} [units=kilometers] any of the options supported by turf units | ||
* @param {number} [steps=64] number of steps | ||
* @return {FeatureCollection|Feature<Polygon|MultiPolygon>|undefined} buffered features | ||
* @returns {FeatureCollection|Feature<Polygon|MultiPolygon>|undefined} buffered features | ||
* @example | ||
* var point = { | ||
* "type": "Feature", | ||
* "properties": {}, | ||
* "geometry": { | ||
* "type": "Point", | ||
* "coordinates": [-90.548630, 14.616599] | ||
* } | ||
* }; | ||
* var point = turf.point([-90.548630, 14.616599]); | ||
* var buffered = turf.buffer(point, 500, 'miles'); | ||
@@ -43,3 +36,2 @@ * | ||
*/ | ||
module.exports = function (geojson, radius, units, steps) { | ||
@@ -46,0 +38,0 @@ // validation |
{ | ||
"name": "@turf/buffer", | ||
"version": "4.5.2", | ||
"version": "4.6.0", | ||
"description": "turf buffer module", | ||
@@ -39,3 +39,3 @@ "main": "index.js", | ||
"devDependencies": { | ||
"@turf/truncate": "^4.5.2", | ||
"@turf/truncate": "^4.6.0", | ||
"benchmark": "^2.1.4", | ||
@@ -47,5 +47,5 @@ "load-json-file": "^2.0.0", | ||
"dependencies": { | ||
"@turf/center": "^4.5.2", | ||
"@turf/helpers": "^4.5.2", | ||
"@turf/meta": "^4.5.2", | ||
"@turf/center": "^4.6.0", | ||
"@turf/helpers": "^4.6.0", | ||
"@turf/meta": "^4.6.0", | ||
"d3-geo": "^1.6.3", | ||
@@ -52,0 +52,0 @@ "jsts": "1.3.0" |
@@ -15,3 +15,3 @@ # @turf/buffer | ||
- `feature` **([FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects) \| [Geometry](http://geojson.org/geojson-spec.html#geometry) \| [Feature](http://geojson.org/geojson-spec.html#feature-objects)<any>)** input to be buffered | ||
- `geojson` **([FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects) \| [Geometry](http://geojson.org/geojson-spec.html#geometry) \| [Feature](http://geojson.org/geojson-spec.html#feature-objects)<any>)** input to be buffered | ||
- `radius` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** distance to draw the buffer (negative values are allowed) | ||
@@ -24,10 +24,3 @@ - `units` **\[[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** any of the options supported by turf units (optional, default `kilometers`) | ||
```javascript | ||
var point = { | ||
"type": "Feature", | ||
"properties": {}, | ||
"geometry": { | ||
"type": "Point", | ||
"coordinates": [-90.548630, 14.616599] | ||
} | ||
}; | ||
var point = turf.point([-90.548630, 14.616599]); | ||
var buffered = turf.buffer(point, 500, 'miles'); | ||
@@ -34,0 +27,0 @@ |
12482
-1.63%189
-3.57%56
-11.11%Updated
Updated
Updated