Git Product home page Git Product logo

geo-distance-helper's Introduction

geo-distance-helper

Get distance between two points in kilometers, nautical miles

100% typescript, get autocompletions while using.

Install

  • npm
npm install geo-distance-helper
  • yarn
yarn add geo-distance-helper

API

Args Type Required Default Description
point1 GeoPoint true - Point1 coordinates
point2 GeoPoint true - Point2 coordinates
unit string false 'K' 'K': Kilometers, 'N': Nautical miles

Test

// using yarn
yarn test

// using npm
npm test

Types

  • GeoPoint
Args Type Required Default Description
lat number true - Point latitude
lng number true - Point longitude

Example Usage

import geoDistance from 'geo-distance-helper';
// const geoDistance = require('geo-distance-helper');

const point1 = { lat: 36, lng: 42 };
const point2 = { lat: 64, lng: 21 };

// distance in kilometers
const distance = geoDistance(point1, point2);
// or
const distance = geoDistance(point1, point2, 'K');

// distance in nautical miles
const distance = geoDistance(point1, point2, 'N');

geo-distance-helper's People

Contributors

dependabot[bot] avatar profesor11 avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.