This package has been deprecated

Author message:

Turf packages are now namespaced: please use @turf/distance instead

turf-distance

3.0.12 • Public • Published

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

  • from Feature<Point> origin point
  • to Feature<Point> destination point
  • units [String] can be degrees, radians, miles, or kilometers (optional, default kilometers)

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

Readme

Keywords

Package Sidebar

Install

npm i turf-distance

Weekly Downloads

18,525

Version

3.0.12

License

MIT

Last publish

Collaborators

  • tcql
  • morganherlocker
  • mourner
  • jvrousseau
  • jseppi
  • cspanring
  • cwmma
  • lyzidiamond
  • tmcw