buffer
Description
Calculates a buffer for input features for a given radius. Units supported are miles, kilometers, and degrees.
When using a negative radius, the resulting geometry may be invalid if it's too small compared to the radius magnitude. If the input is a FeatureCollection, only valid members will be returned in the output FeatureCollection - i.e., the output collection may have fewer members than the input, or even be empty.
Parameters
Name | Type | Description |
---|---|---|
geojson | FeatureCollection | Geometry | Feature<any> | input to be buffered |
radius | number | distance to draw the buffer (negative values are allowed) |
options? | Object | Optional parameters (default {}) |
options.units? | string | any of the options supported by turf units (default "kilometers") |
options.steps? | number | number of steps (default 8) |
Returns
FeatureCollection | Feature<Polygon | MultiPolygon> | undefined buffered features
Examples
var point = turf.point([-90.54863, 14.616599]);
var buffered = turf.buffer(point, 500, { units: "miles" });
Installation
$ npm install @turf/buffer
import { buffer } from "@turf/buffer";
const result = buffer(...);
$ npm install @turf/turf
import * as turf from "@turf/turf";
const result = turf.buffer(...);