turf-distance

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 32 Open GitHub ↗

Calculates the distance between two point features in degrees, radians, miles, or kilometers.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# DEPRECATED - replaced with [`@turf/distance`](https://github.com/Turfjs/turf/tree/master/packages/turf-distance)
# turf-distance

[![build status](https://secure.travis-ci.org/Turfjs/turf-distance.png)](http://travis-ci.org/Turfjs/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](http://en.wikipedia.org/wiki/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

```js
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]
};

//=points

var distance = turf.distance(point1, point2, units);

//=distance
```

**Returns** `Number`, distance between the two points

## Installation

Requires [nodejs](http://nodejs.org/).

```sh
$ npm install turf-distance
```

## Tests

```sh
$ npm test
```

turf-distance

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README