2.0.2 • Published 2 years ago
furkot-geocode v2.0.2
furkot-geocode
Geocoding service for Furkot
Install
$ npm install --save furkot-geocode
Usage
var furkotGeocode = require('furkot-geocode');
var options = {}; // options activating geocoding services
var geocode = furkotGeocode(options);
var query = {}; // geocoding query
geocode(query, function (result) {
// process result
}
Configuration options
Geocoding component expects a configuration options object with following fields:
max
- maximum number of places to returnorder
- list of names of geocoding services in the order they will be triedXXX_key
- API key for serviceXXX
(if serviceXXX
requires a key)XXX_enable
- function that takes query and returnstrue
when serviceXXX
is expected to handle that query; if the function is absent, the serviceXXX
won't be used even if listed in theorder
XXX_parameters
- object with additional parameters specific to serviceXXX
Query parameters
Common parameters:
max
- maximum number of places to return (overrides configuration option)lang
- language code, defaults toen
Reverse geocoding:
ll
- array of coordinates[ longitude, latitude ]
Forward geocoding:
address
- string representing an addressplace
- string representing place name; eitheraddess
orplace
is expectedpartial
- a boolean flag set when geocoding is done as part of autocompletebounds
- a hint to the region place resides in as array of south west and north east[[SW longitude, SW latitude], [NE longitude, NE latitude]]
Results format
If successful, geocoding service will return object with field places
- an array of objects, each describing one place with following fields (not all fields are always set):
place
- place name (may be absent if address doesn't correspond to a named place)type
- place typeaddress
- formated addresshouse
- building numberstreet
- street namecommunity
- neighborhood or villagetown
- town or citycounty
- administrative area more general than townprovince
- state or province (usually abbreviated)country
- country (short form but not abbreviated)
License
MIT © Natalia Kowalczyk
1.5.5
2 years ago
2.0.2
2 years ago
2.0.1
2 years ago
2.0.0
2 years ago
1.5.4
5 years ago
1.5.3
5 years ago
1.5.2
5 years ago
1.5.1
5 years ago
1.5.0
5 years ago
1.4.12
5 years ago
1.4.11
6 years ago
1.4.10
6 years ago
1.4.9
6 years ago
1.4.8
6 years ago
1.4.7
6 years ago
1.4.6
6 years ago
1.4.5
6 years ago
1.4.4
6 years ago
1.4.3
6 years ago
1.4.2
6 years ago
1.4.1
6 years ago
1.4.0
6 years ago
1.3.1
6 years ago
1.3.0
6 years ago
1.2.1
6 years ago
1.2.0
6 years ago
1.1.0
6 years ago
1.0.1
6 years ago
1.0.0
6 years ago
0.0.0
6 years ago