@turf/distance
TypeScript icon, indicating that this package has built-in type declarations

7.0.0 • 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 (Coord | Point) origin point or coordinate

  • to (Coord | Point) destination point or coordinate

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

    • options.units string can be degrees, radians, miles, or kilometers (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 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 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

Readme

Keywords

Package Sidebar

Install

npm i @turf/distance

Weekly Downloads

1,023,217

Version

7.0.0

License

MIT

Unpacked Size

14.5 kB

Total Files

9

Last publish

Collaborators

  • twelch
  • jamesmilneruk
  • rowanwins
  • tmcw
  • morganherlocker
  • tcql
  • mdfedderly