viktor-gusev / node-open-geocoder Goto Github PK

#node-open-geocoder

code coverage:
npm test && npm run check-coverage && npm run coverage

codestyle: npm run codestyle

jshint: npm run jshint

###Description

Simple client for Node.js that uses the Open Street Map API for geocoding and reverse geocoding.

OpenStreetMap has an Editing API for fetching and saving raw geodata from/to the OpenStreetMap database.

API v0.6 is the current version of the OSM Editing API deployed 17-21 April 2009.

Usage Policy for Open Street Map.

###Usage

####Geocode

geocode = function (addr, [options], cb)

more info about the address format

• addr
  ex: '135 pilkington avenue, birmingham'

• options
  ex: {addressdetails: 1, polygon_geojson: 1}
  
  

    addressdetails: Include a breakdown of the address into elements, can be 0 | 1
    				
    the second prop define the type of polygon and can be define only one:
     	polygon_geojson:  Output geometry of results in geojson format.
     	polygon_kml    :  Output geometry of results in kml format.
     	polygon_svg    :  Output geometry of results in svg format.
     	polygon_text   :  Output geometry of results as a WKT.
  

• cb: callback(err, res)

######Example

var OpenGeocoder = require('node-open-geocoder');

var geo = new OpenGeocoder();

geo.geocode('135 pilkington avenue, birmingham', function(err, res) {
	if (err) {
		return err;
	} else {
		return res;
	}
});

####Reverse

reverse = function(longitude, latitude, cb)

• longitude: valid longitude
• latitude : valid latitude
• cb : callback(err, res)

######Example

var OpenGeocoder = require('node-open-geocoder');

var geo = new OpenGeocoder();

geo.reverse(-8.945406, 38.575078, function(err, res) {
	if (err) {
		return err;
	} else {
		return res;
	}	
});