https://github.com/njj/haversine

A simple haversine formula module for Node.js
https://github.com/njj/haversine

haversine haversine-formula javascript nodejs

Last synced: about 2 months ago
JSON representation

A simple haversine formula module for Node.js

• Host: GitHub
• URL: https://github.com/njj/haversine
• Owner: njj
• Created: 2013-01-18T19:12:48.000Z (over 11 years ago)
• Default Branch: develop
• Last Pushed: 2023-08-30T02:31:40.000Z (about 1 year ago)
• Last Synced: 2024-05-17T09:02:54.360Z (4 months ago)
• Topics: haversine, haversine-formula, javascript, nodejs
• Language: JavaScript
• Homepage: http://www.npmjs.org/haversine
• Size: 37.1 KB
• Stars: 297
• Watchers: 5
• Forks: 44
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: Changelog.md

Awesome Lists containing this project

README

        
# Haversine

A simple haversine formula module for Node.js

## Installation

`$ npm install haversine`

## Usage

### haversine (start, end, options)

    const haversine = require('haversine')

    const start = {

      latitude: 30.849635,

      longitude: -83.24559

    }

    const end = {

      latitude: 27.950575,

      longitude: -82.457178

    }

    console.log(haversine(start, end))

    console.log(haversine(start, end, {unit: 'mile'}))

    console.log(haversine(start, end, {unit: 'meter'}))

    console.log(haversine(start, end, {threshold: 1}))

    console.log(haversine(start, end, {threshold: 1, unit: 'mile'}))

    console.log(haversine(start, end, {threshold: 1, unit: 'meter'}))

#### api

- `options.unit` - Unit of measurement applied to result (default `km`, available `km, mile, meter, nmi`)

- `options.threshold` - If passed, will result in library returning `boolean` value of whether or not the start and end points are within that supplied threshold.  (default `null`)

- `options.format` - The format of start and end coordinate arguments. See table below for available values. (default `null`)

| Format        | Example

| ------------- |--------------------------|

| `undefined` (default) | `{ latitude: 30.849635, longitude: -83.24559 }`

| `[lat,lon]`   | `[30.849635, -83.24559]`

| `[lon,lat]`   | `[-83.24559, 30.849635]`

| `{lon,lat}`   | `{ lat: 30.849635, lon: -83.24559 }`

| `{lat,lng}`   | `{ lat: 30.849635, lng: -83.24559 }`

| `geojson`     | `{ type: 'Feature', geometry: { coordinates: [-83.24559, 30.849635] } }`

[MIT License](http://opensource.org/licenses/MIT)