mirror of https://github.com/Turfjs/turf.git synced 2025-12-08 20:26:16 +00:00

History

Upgrade lerna, et al to address security vulnerabilities, modernise build environment (#2507 )

* Upgrading to newest @types/node for the typescript version we currently use (3.8.3). https://www.npmjs.com/package/@types/node?activeTab=versions

* Big update to lerna to address security vulnerabilities. bootstrap command no longer required. Seems to build and test ok. May need some tweaking. Will add build caching at a later date.

* Updating documentation (the NPM library) to address security vulnerabilities. Had to wrap body of script so as be async, though otherwise unchanged.

* Updating es-check to address security vulnerabilities.

* Updating tape library to address security vulnerabilities.

* Add lerna caching (via nx). Simplistic setup so will need some tweaking. Remove redundant packages setting from lerna.json (will default to packages setting in package.json instead). Have to add --npm-path to all npm-run-all calls so that lerna doesn't accidentally end up being used as the npm binary. https://github.com/mysticatea/npm-run-all/issues/218 and https://github.com/lerna/lerna/issues/1842 have more details.

* Missed a couple of carats in package.json dependency specs.

* Also need to commit a new yarn.lock file to reflect version spec changes in previous commit.

---------

Co-authored-by: mfedderly <mdfedderly@mdfedderly.com>

2023-10-06 16:48:20 -04:00

test

Add Prettier and ESLint to the builds (#1965 )

2020-12-08 19:24:15 -05:00

bench.js

Enable more lint rules (#2108 )

2021-06-22 18:42:21 -04:00

index.d.ts

@turf/buffer - Update typescript definitions (#2188 )

2022-01-16 16:36:45 -05:00

index.js

resolve bundling issues relating to @turf/jsts in buffer module (#2501 )

2023-09-28 20:05:38 +01:00

LICENSE

Clean package.json

2017-03-05 23:40:09 -05:00

package.json

Upgrade lerna, et al to address security vulnerabilities, modernise build environment (#2507 )

2023-10-06 16:48:20 -04:00

README.md

Fix docs generation (#2279 )

2022-04-02 12:52:52 -04:00

test.js

Add Prettier and ESLint to the builds (#1965 )

2020-12-08 19:24:15 -05:00

types.ts

Migrate to @types/geojson package (#2158 )

2021-10-24 23:07:07 -07:00

README.md

@turf/buffer

buffer

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

geojson (FeatureCollection | Geometry | Feature<any>) input to be buffered
radius number distance to draw the buffer (negative values are allowed)
options Object Optional parameters (optional, default {})
- options.units string any of the options supported by turf units (optional, default "kilometers")
- options.steps number number of steps (optional, default 8)

Examples

var point = turf.point([-90.548630, 14.616599]);
var buffered = turf.buffer(point, 500, {units: 'miles'});

//addToMap
var addToMap = [point, buffered]

Returns (FeatureCollection | Feature<(Polygon | MultiPolygon)> | undefined) 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