geo-core

Toolkit that includes fast look up of locations by latitude and longitude pairs.

npm install geo-core --save

Requiring

var Geolocation = require('geo-core')

Constructing

Create an instance of the Geolocation class. When constructing, will require a JSON file that contains all cities with a population of 5000 or above.

var GeoManager = new Geolocation();

Options

GeoLocation also takes options to override defaults for any reason.

var GeoManager = new Geolocation({
  radiansConversion: Math.PI / 2,
  radius: 3959,
  units: 'miles',
  minimumLocations: 3
});

Property	Type	Description	Default
radiansConversion	Float	List of messages to display	π / 180
radius	Integer	Radius of the spherical object, defaults to Earth.	3959
units	String	Unit of measurement corresponding to the radius	'miles'
minimumLocations	Integer	Minimum number of nearby locations returned.	3

API

A GeoManager instance exposes the following functions:

findNearbyLocations(Object, Function)

Returns an array of Geolocation Objects closest to the supplied Origin Location Object

GeoManager.findNearbyLocations({
  lat: '35.73265',
  lon: '-78.85029'
}, function(locations) {
  // ... Array of geolocation objects.
});

Geolocation Friendly Objects

Origin Location Object

Property	Type	Description
lon	String (Float)	Longitude coordinate associated with the origin position.
lat	String (Float)	Latitude coordinate associated with the origin position.

Geolocation Object

Property	Type	Description
city	String	City associated with the location.
division	String	Division / Province / State associated with the location.
country	String	Country associated with the location.
population	Integer	Total population of the location.
longitude	Float	Longitude coordinate associated with the location.
latitude	Float	Latitude coordinate associated with the location.
distance	Float	Distance away from the origin to the location.
units	String	Unit of measure associated with the distance

geocore has no dependencies other than the cities5000.txt.

Special Thanks

• Austin Kelleher
• Phil Gates-Idem
• Mark Smith-Guerrero