turf-distance
turf distance module
turf.distance(from, to, [units=kilometers])
Calculates the distance between two Point|points in degrees, radians,
miles, or kilometers. This uses the
Haversine formula
to account for global curvature.
Parameters
parameter | type | description |
---|
from | Feature.<Point> | origin point |
to | Feature.<Point> | destination point |
[units=kilometers] | String | optional: can be degrees, radians, miles, or kilometers |
Example
var point1 = {
"type": "Feature",
"properties": {},
"geometry": {
"type": "Point",
"coordinates": [-75.343, 39.984]
}
};
var point2 = {
"type": "Feature",
"properties": {},
"geometry": {
"type": "Point",
"coordinates": [-75.534, 39.123]
}
};
var units = "miles";
var points = {
"type": "FeatureCollection",
"features": [point1, point2]
};
var distance = turf.distance(point1, point2, units);
Returns Number
, distance between the two points
Installation
Requires nodejs.
$ npm install turf-distance
Tests
$ npm test