@turf/distance

@turf/distance

distance

Calculates the distance between two coordinates in degrees, radians, miles, or kilometers. This uses the Haversine formula to account for global curvature.

Parameters

• from Coord origin coordinate

• to Coord destination coordinate

• options Object Optional parameters (optional, default {})

  • options.units Units Supports all valid Turf Units. (optional, default 'kilometers')

Examples

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

var distance = turf.distance(from, to, options);

//addToMap
var addToMap = [from, to];
from.properties.distance = distance;
to.properties.distance = distance;

Returns number distance between the two coordinates

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 single module individually:

$ npm install @turf/distance

Or install the all-encompassing @turf/turf module that includes all modules as functions:

$ npm install @turf/turf