Package Exports

@turf/rhumb-distance

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@turf/rhumb-distance) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@turf/rhumb-distance

rhumbDistance

Calculates the distance along a rhumb line between two points in degrees, radians, miles, or kilometers.

Parameters

from (Geometry | Feature<Point> | Array<number>) origin point
to (Geometry | Feature<Point> | Array<number>) 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 distance = turf.rhumbDistance(from, to, "miles");

//addToMap
from.properties.distance = distance;
to.properties.distance = distance;
var addToMap = [from, to];

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/rhumb-distance

Or install the Turf module that includes it as a function:

$ npm install @turf/turf