Skip to content
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
641 lines (507 sloc) 40 KB

5.0.0 🎉

⭐️ Major Updates

  • TurfJS now supports ES Modules (Related PR's)
  • Optional parameters are now defined as an Object.

🚀 New Modules


Takes a FeatureCollection of points, and a bounding box, and returns a FeatureCollection of Voronoi polygons. (PR - Author @stevage)


Returns the shortest path from start to end without colliding with any feature in obstacles (PR - Author @stebogit)


Boolean-Parallel returns True if each segment of line1 is parallel to the correspondent segment of line2 (PR - Author @stebogit)


Takes a {@link Point} and a {@link LineString} and calculates the closest Point on the (Multi)LineString. (PR - Author @stebogit)

🏅 New Features/Enhancements

🐛 Bug Fixes

⚠️ Breaking Change

  • Optional parameters are now defined as an Object:


var from = [-75.343, 39.984];
var to = [-75.534, 39.123];
var units = 'miles';
var distance = turf.distance(from, to, units);


var from = [-75.343, 39.984];
var to = [-75.534, 39.123];
var options = {units: 'miles'};
var distance = turf.distance(from, to, options);


🚀 New Modules


  • toMercator: Converts a WGS84 GeoJSON object into Mercator (EPSG:900913) projection
  • toWgs84: Converts a Mercator (EPSG:900913) GeoJSON object into WGS84 projection

(PR - Author @stebogit)


Returns the minimum distance between a {@link Point} and a {@link LineString}, being the distance from a line the minimum distance between the point and any segment of the LineString.

(PR - Author @stebogit)


Boolean-within returns true if the first geometry is completely within the second geometry. The interiors of both geometries must intersect and, the interior and boundary of the primary (geometry a) must not intersect the exterior of the secondary (geometry b). Boolean-within returns the exact opposite result of the @turf/boolean-contains.

(PR - Author @rowanwins)

🏅 New Features/Enhancements

🐛 Bug Fixes


🚀 New Modules

🏅 New Features/Enhancements

🐛 Bug Fixes


🚀 New Modules

🏅 New Features/Enhancements

🐛 Bug Fixes


🚀 New Modules

🏅 New Features

🐛 Bug Fixes


🚀 New Modules

🏅 New Features

🐛 Bug Fixes


New Modules


Bug Fixes




New Modules


Bug Fixes


Typescript definitions index.d.ts added to all the packages.


Fix turf-line-slice bug with vertical linestrings.


This is a big change in Turf! 3.0.0 is a release that targets the development cycle of Turf, letting us work on it more and release more often.


Turf 3.x and forward is a monorepo project. We publish lots of little modules as usual, but there's one repo - turfjs/turf - that contains all the code and the issues for the Turf source code. We use lerna to link these packages together and make sure they work.

Why? We already had internal turf modules, like turf-meta, and development was harder and harder - we had a bunch of custom scripts to do releases and tests, and these were just written for Turf. Lerna is from the very popular and very well-maintained babel project, and it works really well, and reduces maintainer sadness.


Turf grew a bunch of modules that weren't totally necessary, or were expressing only a line or two of JavaScript. We want to make things easier, but these modules didn't make code more expressive and they hid complexity where it didn't need to be hidden. Turf 3.x focuses on the core functionalities we need, making sure they're tested and performant.

turf-erase has been renamed turf-difference to make its name more similar to the equivalents in other libraries.

Removed modules: merge, sum, min, max, average, median, variance, deviation, filter, remove, jenks, quantile. See the upgrade guide below for replacements.

Upgrading from v2

If you were using turf-merge

turf-merge repeatedly called turf-union on an array of polygons. Here's how to implement the same thing without the special module

var clone = require('clone');
var union = require('turf-union');
function merge(polygons) {
  var merged = clone(polygons.features[0]), features = polygons.features;
  for (var i = 0, len = features.length; i < len; i++) {
    var poly = features[i];
    if (poly.geometry) merged = union(merged, poly);
  return merged;

An alternative method that merges pairs of features recursively. With large numbers and similar complexity of input geometries this can speed up run time by factor 10. Choose depending on your use case.

var union = require('turf-union');
function mergeBin(polygons) {
  var features = polygons.features;

  do {
    var merged = [], len = features.length;
    for (var i = 0; i < len-1; i += 2) {
      merged.push(turf.union(features[i], features[i+1]));
    if (len % 2 !== 0) {
    features = merged;
  } while(features.length > 1);

  return features[0];

If you were using turf-sum, min, max, average, median, variance, deviation

The turf-collect method provides the core of these statistical methods and lets you bring your own statistical library, like simple-statistics, science.js, or others.

For example, here's how to find the median of matched values with simple-statistics. Finding other statistics, like variance, mean, and so on simply use other methods from the statistics library.

var ss = require('simple-statistics');
var turf = require('@turf/turf');

var poly1 = turf.polygon([[[0,0],[10,0],[10,10],[0,10],[0,0]]]);
var poly2 = turf.polygon([[[10,0],[20,10],[20,20],[20,0],[10,0]]]);
var polyFC = turf.featureCollection([poly1, poly2]);
var pt1 = turf.point([5,5], {population: 200});
var pt2 = turf.point([1,3], {population: 600});
var pt3 = turf.point([14,2], {population: 100});
var pt4 = turf.point([13,1], {population: 200});
var pt5 = turf.point([19,7], {population: 300});
var ptFC = turf.featureCollection([pt1, pt2, pt3, pt4, pt5]);

// collects values from matching points into an array called 'values'
var collected = turf.collect(polyFC, ptFC, 'population', 'values');

// finds the median of those values.
collected.features.forEach(function (feature) { = ss.median(;

console.log(JSON.stringify(collected, null, 2));

If you were using turf-filter, turf-remove

These modules were thin wrappers around native JavaScript methods: use Array.filter instead:

var filteredFeatures = features.filter(function(feature) {
  return > 10;

If you were using turf-jenks, turf-quantile

Use to get values, and then bring your own statistical calculation, like simple-statistics or science.js.

var values = {

If you were using turf-extent

turf-extent's name was changed to turf-bbox. It is functionally the same.

turf.bbox(poly) // [minx, miny, maxx, maxy]


  • turf-grid renamed turf-point-grid (turf.grid => turf.pointGrid)
  • turf-hex renamed turf-hex-grid (turf.hex => turf.hexGrid)
  • turf-hex-grid now has a required unit parameter
  • remove turf-isobands; use turf-isolines instead
  • added turf-square-grid (turf.squareGrid)
  • added turf-triangle-grid (turf.triangleGrid)
  • constrain turf-point-grid to the bbox


  • update all module dependencies to master
  • add support for features in turf.intersection
  • fix issues with turf.polygon coordinate wrapping inconsistencies
  • add unit parameter to turf.concave


  • harmonize turf-tin dependency tree


  • fixes bug in turf-along


  • added turf-line-slice for segmenting LineStrings with Points
  • turf-point-on-line for calculating the closest Point from a Point to a LineString


  • tin ~7x faster
  • Fix mutability issues with flip, erase: data passed to Turf should never be changed in place.
  • added turf-line-distance for geodesic measuring of LineStrings
  • added turf-along for calculating a the location of a Point x distance along a LineString
  • added turf-area for calculating the area of a given feature
You can’t perform that action at this time.