w3w-node-wrapper v2.3.3

 w3w-node-wrapper

A Node.js library to use the what3words REST API.

Overview

The what3words Node.js wrapper gives you programmatic access to

• convert a 3 word address to coordinates
• convert coordinates to a 3 word address
• autosuggest functionality which takes a slightly incorrect 3 word address, and suggests a list of valid 3 word addresses
• obtain a section of the 3m x 3m what3words grid for a bounding box.
• determine the currently support 3 word address languages.

Authentication

To use this library you’ll need a what3words API key, which can be signed up for here.

Installation

npm i --save @what3words/api axios

Initialise

const api = require("@what3words/api");
            
api.setOptions({ key: "what3words-api-key" });

Documentation

See the what3words public API documentation

General Usage

Convert To Coordinates

Convert a 3 word address to a position, expressed as coordinates of latitude and longitude.

This function takes the words parameter as a string of 3 words 'table.book.chair'

The returned payload from the convertToCoordinates method is described in the what3words REST API documentation.

Code Example

api.convertToCoordinates("filled.count.soap")
  .then(data => console.log(data));

Convert To 3 Word Address

Convert coordinates, expressed as latitude and longitude to a 3 word address.

The returned payload from the convertTo3wa method is described in the what3words REST API documentation.

Code Example

api.convertTo3wa({lat:51.520847, lng:-0.195521})
    .then(data => console.log(data));

Available Languages

This function returns the currently supported languages. It will return the two letter code (ISO 639), and the name of the language both in that language and in English.

The returned payload from the convertTo3wa method is described in the what3words REST API documentation

Code Example

api.availableLanguages()
  .then(data => console.log(data));

Grid Section

Returns a section of the 3m x 3m what3words grid for a given area. The requested box must not exceed 4km from corner to corner, or a BadBoundingBoxTooBig error will be returned. Latitudes must be >= -90 and <= 90, but longitudes are allowed to wrap around 180. To specify a bounding-box that crosses the anti-meridian, use longitude greater than 180. Example value: 50.0, 179.995, 50.01, 180.0005.

The returned payload from the gridSection function is described in the what3words REST API documentation

Code Example

api.gridSection({
    southwest: { lat: 52.208867, lng: 0.117540 },
    northeast: { lat: 52.207988, lng: 0.116126 }
  })
  .then(data => console.log(data));

AutoSuggest

Returns a list of 3 word addresses based on user input and other parameters.

This method provides corrections for the following types of input error:

• typing errors
• spelling errors
• misremembered words (e.g. singular vs. plural)
• words in the wrong order

The autoSuggest method determines possible corrections to the supplied 3 word address string based on the probability of the input errors listed above and returns a ranked list of suggestions. This method can also take into consideration the geographic proximity of possible corrections to a given location to further improve the suggestions returned.

Input 3 word address

You will only receive results back if the partial 3 word address string you submit contains the first two words and at least the first character of the third word; otherwise an error message will be returned.

Clipping and Focus

We provide various clip policies to allow you to specify a geographic area that is used to exclude results that are not likely to be relevant to your users. We recommend that you use the clipping to give a more targeted, shorter set of results to your user. If you know your user’s current location, we also strongly recommend that you use the focus to return results which are likely to be more relevant.

In summary, the clip policy is used to optionally restrict the list of candidate AutoSuggest results, after which, if focus has been supplied, this will be used to rank the results in order of relevancy to the focus.

The returned payload from the autosuggest method is described in the what3words REST API documentation.

Usage

Code Example

api.autosuggest("fun.with.code")
  .then(data => console.log(data));

Code Example Two

Clipping the results returned to France and Germany..

api.autosuggest("fun.with.code", { clipToCountry: ["FR", "DE"] })
  .then(data => console.log(data));

Handling Errors

Errors returned from the API can be caught with the wrapper through the use of a catch function.

Within the catch function, code and message values which represent the error, are accessbable from the error object parameter

api.convertToCoordinates("filled.count.soap")
  .then(function(response) {
    console.log("[convertToCoordinates]", response);
  })
  .catch(function(error) { // catch errors here
    console.log("[code]", error.code);
    console.log("[message]", error.message);
  });

Error values are listed in the what3words REST API documentation.