| .. | ||
| index.d.ts | ||
| index.js | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
@turf/distance
distance
Calculates the distance between two points in degrees, radians, miles, or kilometers. This uses the Haversine formula to account for global curvature.
Parameters
fromFeature<Point> origin pointtoFeature<Point> destination pointunits[string] can be degrees, radians, miles, or kilometers (optional, defaultkilometers)
Examples
var from = {
"type": "Feature",
"properties": {},
"geometry": {
"type": "Point",
"coordinates": [-75.343, 39.984]
}
};
var to = {
"type": "Feature",
"properties": {},
"geometry": {
"type": "Point",
"coordinates": [-75.534, 39.123]
}
};
var units = "miles";
var points = {
"type": "FeatureCollection",
"features": [from, to]
};
//=points
var distance = turf.distance(from, to, units);
//=distance
Returns number distance between the two points
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/distance
Or install the Turf module that includes it as a function:
$ npm install @turf/turf