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

    6.5.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 origin point
    • to Coord destination point
    • 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 module individually:

    $ npm install @turf/distance

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

    $ npm install @turf/turf

    Install

    npm i @turf/distance

    DownloadsWeekly Downloads

    375,138

    Version

    6.5.0

    License

    MIT

    Unpacked Size

    9.34 kB

    Total Files

    7

    Last publish

    Collaborators

    • rowanwins
    • tmcw
    • morganherlocker
    • tcql
    • deniscarriere
    • mdfedderly