@informath/nominatim

Nominatim

DISCLAIMER

This is a fully rewritten version, do not expect to be using that one just by replacing the original library with this one

===

nominatim is a basic node module to handle geocoding and reverse geocoding via OpenStreetMap (OSM). It attempts to adhere to the Nominatim usage policy.

Example

const Nominatim = require('@informath/nominatim');

const NominatimClient = new Nominatim('Nelson\'s Obvious tracking (NO tracking) <[e-mail]>');

NominatimClient.search('5230, Newell Road, Palo Alto')
  .then((v) => {
    console.log(v);
  });

Installation

$ npm install @informath/nominatim

How to use?

await NominatimClient[operationToPerform](options, overwriteOptions)

options will be merged with Nominatim.default unless overwriteOptions is truthy

What are the possible endpoints?

Any!

It will make a request at https://nominatim.openstreetmap.org/[[Your operation here!]]

Learn more about proxy magic here! (Literally a google search I just made)