Package Exports

@turf/buffer

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@turf/buffer) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@turf/buffer

buffer

Calculates a buffer for input features for a given radius. Units supported are miles, kilometers, and degrees.

Parameters

feature (Feature | FeatureCollection) input to be buffered
radius number distance to draw the buffer
units string any of the options supported by turf units

Examples

var pt = {
  "type": "Feature",
  "properties": {},
  "geometry": {
    "type": "Point",
    "coordinates": [-90.548630, 14.616599]
  }
};
var unit = 'miles';

var buffered = turf.buffer(pt, 500, unit);
var result = turf.featureCollection([buffered, pt]);

//=result

Returns (FeatureCollection<Polygon> | FeatureCollection<MultiPolygon> | Polygon | MultiPolygon) buffered features

This module is part of the Turfjs project, an open source module collection dedicated to geographic algorithms. It is maintained in the Turfjs/turf repository, where you can create PRs and issues.

Installation

Install this module individually:

$ npm install @turf/buffer

Or install the Turf module that includes it as a function:

$ npm install @turf/turf