JS.Geo.What3Words
A node.js wrapper for the What3Words API.
Turns WGS84 coordinates into three words or OneWords and vice-versa using what3words.com HTTP API
Further information on the What3Words API and its features is available at http://what3words.com/api/reference.
Installation
Installing using npm (node package manager):
npm install geo.what3words
If you don't have npm installed or don't want to use it:
cd ~/.node_libraries
git clone git://github.com/lokku/js-geo-what3words.git what3words
Please note that parts of this library depend on request. This library needs to be installed for the API to work.
Usage
Initialization
var What3Words = w3w = 'YOUR_API_KEY';
The constructor function also takes an optional configuration object:
var What3Words = w3w = 'YOUR_API_KEY' language: 'ru' userAgent: 'Your custom UA' ;
Forward
w3w;
Optional parameters:
- lang sets a different language for the response
- full returns the full response of the api
- You can pass all request params
Reverse
w3w;
Optional parameters:
- full returns the full response of the api
- lang sets a different language for the response
- You can pass all request params
Autosuggest
w3w;
Optional parameters:
- full returns the full response of the api
- lang sets a different language for the response
- You can pass all request params
StandardBlend
w3w;
Optional parameters:
- lang sets a different language for the response
- You can pass all request params
Grid
w3w;
Optional parameters:
- You can pass all request params
GetLanguages
w3w;
Optional parameters:
- full returns the full response of the api
- lang sets a different language for the response
Errors
All the methods return a promise.
License
JS.Geo.What3Words is licensed under the MIT License. (See LICENSE)