# turf-buffer

> turf buffer module

Latest version **3.0.12** (published 2016-07-05) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install turf-buffer
pnpm add turf-buffer
yarn add turf-buffer
bun add turf-buffer
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 3.0.12 |
| Published | 2016-07-05 |
| First published | 2014-05-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 23 |
| Author | morganherlocker |
| Maintainers | cspanring, cwmma, jseppi, jvrousseau, lyzidiamond, morganherlocker, mourner, tcql, tmcw |
| Keywords | buffer, offset, polygon, linestring, point, geojson, turf |

## Links

- npm: https://www.npmjs.com/package/turf-buffer
- Repository: https://github.com/Turfjs/turf-buffer
- Issues: https://github.com/Turfjs/turf-buffer/issues
- npm.io page: https://npm.io/package/turf-buffer

## Dependencies (4)

- [jsts](https://npm.io/package/jsts.md) 1.1.2
- [turf-combine](https://npm.io/package/turf-combine.md) ^3.0.12
- [turf-helpers](https://npm.io/package/turf-helpers.md) ^3.0.12
- [geojson-normalize](https://npm.io/package/geojson-normalize.md) 0.0.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 3.0.12 (latest) — 2016-07-05
- 3.0.7-canary.ae89c8b3 (canary) — 2016-06-14
- 3.0.10 — 2016-06-15
- 3.0.7 — 2016-06-13
- 3.0.5-canary.4f73aa1a — 2016-06-03
- 3.0.5 — 2016-05-17
- 3.0.1 — 2016-05-16
- 3.0.0-canary.7879bf6c — 2016-05-16
- 3.0.0-canary.2f5f7167 — 2016-05-16
- 1.1.0 — 2015-12-18
- 1.0.4 — 2015-03-30
- 1.0.3 — 2015-03-24
- 1.0.2 — 2015-03-17
- 1.0.1 — 2015-02-06
- 1.0.0 — 2014-12-11
- … 3 more at https://npm.io/package/turf-buffer/versions

## 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
-   `distance` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** distance to draw the buffer
-   `unit` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** any of the options supported by turf units

**Examples**

```javascript
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](http://turfjs.org/), an open source
module collection dedicated to geographic algorithms. It is maintained in the
[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
PRs and issues.

### Installation

Install this module individually:

```sh
$ npm install turf-buffer
```

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

```sh
$ npm install turf
```

---
_Source: https://npm.io/package/turf-buffer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._