@turf/buffer
    TypeScript icon, indicating that this package has built-in type declarations

    6.3.0 • Public • Published

    @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

    Install

    npm i @turf/[email protected]

    Version

    6.3.0

    License

    MIT

    Unpacked Size

    18.9 kB

    Total Files

    7

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar