distance-calculator-js
Calculate the distance between two coordinates (points).
Introduction
This library uses Haversine formula to calculate the distance between two coordinates (points).
Installing
Using yarn.
$ yarn add distance-calculator-js
Using npm.
$ npm install distance-calculator-js
Getting Started
Using import.
;
Using require.
const DistanceCalculator = ;
Examples
calculate(coordinates1, coordinates2, [unit]).
Using import.
; // => Signed decimal degrees without compass directionconst Tokyo = lat: 35652832 long: 139839478 ;const NewYork = lat: 40730610 long: -73935242 ; const m = DistanceCalculator;// => 10847782 (in metres)
If you want to use a different unit, just simply pass it as a third argument of the calculate method.
Using import.
; // => Signed decimal degrees without compass directionconst Tokyo = lat: 35652832 long: 139839478 ;const NewYork = lat: 40730610 long: -73935242 ; const km = DistanceCalculator;// => 10848 (in kilometres) const ft = DistanceCalculator;// => 35589836 (in feet)
Using require.
const DistanceCalculator = ; // => Signed decimal degrees without compass directionconst Tokyo = lat: 35652832 long: 139839478 ;const NewYork = lat: 40730610 long: -73935242 ; const km = DistanceCalculator;// => 10848 (in kilometres) const ft = DistanceCalculator;// => 35589836 (in feet)
Warning! All values are rounded, so the distance between Tokyo and New York will be 10847782.01587274 metres and will be rounded to 10847782 metres and 10847.7820159 kilometres will be rounded to 10848 kilometres.
Supported units
This is the list of all supported units. If you want to use a different unit, just simply pass it as a third argument of the calculate method.
- m (metre) - default
- km (kilometre)
- M (mile)
- ft (foot)
License
This library is licensed under the MIT License.
Acknowledgments
- Inspiration by Chris Veness / Movable Type.