jcblw / distance.js

:car: Small Library for calculating distances between points.

Distance.js

A Small Utility to calulate distance from a latitude and longitude points.

Warning Javascript in general is not the greatest at math when dealing with large numbers... You have been warned

Distance().from([lat, lng]).to([lat, lng]).unit('miles')
// returns kilometers by default
var home = Distance().from([lat, lng]);
var nearby = [];
var locations = [/*...*/];
for(var i = 0; i < locations.length; i += 1){
  var location = locations[i];
  // use the same instance over and over
  if(home.to(location.center).unit('miles') < 3){
    nearby.push(location)
  }  
}

Available length units

• kilometers
• miles
• feet

Unit conversion is handled in the prototype of Number and is subject to change

more methods to be added

Development

All new features for distance.js must be accompanied by a test to prove feature works. Bug fixes do not need new test but it is recommended.

Install packages

Install Grunt

npm install

Grunt methods

grunt build
grunt test

distance.js's Issues

Unit as first param

does not look to be used anywhere might need to make a release that removes that in favor of an options object.

distance( {
    unit: 'kilometers',
    radius: 1182
} )

An in-range update of grunt is breaking the build 🚨

The devDependency grunt was updated from 1.0.3 to 1.0.4.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

grunt is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ continuous-integration/travis-ci/push: The Travis CI build failed (Details).

---

Commits

The new version differs by 5 commits.

• 8fcbed1 v1.0.4 (#1668)
• 0b13970 Update js-yaml to address https://npmjs.com/advisories/788 (#1667)
• 7db6cf7 Use SOURCE_DATE_EPOCH to render dates in template. (#1596)
• a2d6d80 Revert "Indicate in package.json that Node.js 4 or newer is required (#1643)" (#1644)
• 773b7e7 Indicate in package.json that Node.js 4 or newer is required (#1643)

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

Chaining fails

First distance is correct but the rest are way off

Version 10 of node.js has been released

Version 10 of Node.js (code name Dubnium) has been released! 🎊

To see what happens to your code in Node.js 10, Greenkeeper has created a branch with the following changes:

• Added the new Node.js version to your .travis.yml

If you’re interested in upgrading this repo to Node.js 10, you can open a PR with these changes. Please note that this issue is just intended as a friendly reminder and the PR as a possible starting point for getting your code running on Node.js 10.

More information on this issue

Greenkeeper has checked the engines key in any package.json file, the .nvmrc file, and the .travis.yml file, if present.

• engines was only updated if it defined a single version, not a range.
• .nvmrc was updated to Node.js 10
• .travis.yml was only changed if there was a root-level node_js that didn’t already include Node.js 10, such as node or lts/*. In this case, the new version was appended to the list. We didn’t touch job or matrix configurations because these tend to be quite specific and complex, and it’s difficult to infer what the intentions were.

For many simpler .travis.yml configurations, this PR should suffice as-is, but depending on what you’re doing it may require additional work or may not be applicable at all. We’re also aware that you may have good reasons to not update to Node.js 10, which is why this was sent as an issue and not a pull request. Feel free to delete it without comment, I’m a humble robot and won’t feel rejected 🤖

---

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

Allow for different radius

So that this library can be used to find the distance between points on small spheres, or other planets.