distance-from

distance-from

Simple API for quickly calculating distance between two coordinates

Installation

$ npm i distance-from

Example

// Use format of [lat, lng]
const chicago = [42.01682819245601, -87.3011661732315]
const ny = [40.79500901101372, -74.12456877495657]

const distFrom = require('distance-from')

// defaults to kilometers if no units put in
distFrom(chicago).to(ny).in('mi')
// returns distance using haversine formula with margin of error +/- 0.03%

// Additionally we also have a hardcoded list of places from the US you can use
const chitown = distFrom().places().usa.il.chicago
const nyc = distFrom().places().usa.ny.newYorkCity

distFrom(chitown).to(nyc).in('mi')

// To see a list of all supported states you can use
distFrom().listOfSupportedStates()

// Or all the cities you can use
distFrom().listOfSupportedCities()

// If you don't see a state/city in the list then feel free to open a PR

Supported units

• km || kilometer || kilometers
• m || meter || meters
• cm || centimeter || centimeters
• mi || mile || miles
• ft || feet
• in || inch || inches
• yd || yard || yards

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.