# @informath/nominatim

> Completely rewritten version of David Howell's Nominatim

Latest version **7.5.5-beta.0** (published 2021-02-09) · 0 weekly downloads

## Install

```sh
npm install @informath/nominatim
pnpm add @informath/nominatim
yarn add @informath/nominatim
bun add @informath/nominatim
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 7.5.5-beta.0 |
| Published | 2021-02-09 |
| First published | 2021-02-07 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | InforMatheMusic |
| Maintainers | informathemusic |

## Links

- npm: https://www.npmjs.com/package/@informath/nominatim
- Repository: https://github.com/dynmeth/node-nominatim
- Homepage: https://github.com/dynmeth/node-nominatim#readme
- Issues: https://github.com/dynmeth/node-nominatim/issues
- npm.io page: https://npm.io/package/@informath/nominatim

## Dependencies (2)

- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1
- [informa-db.js](https://npm.io/package/informa-db.js.md) ^5.5.0

## Recent versions

- 7.5.5-beta.0 (latest) — 2021-02-09
- 7.5.5 — 2021-02-08
- 7.5.0 — 2021-02-08
- 7.0.0 — 2021-02-08
- 6.0.0 — 2021-02-07
- 5.5.0 — 2021-02-07
- 5.1.0 — 2021-02-07
- 5.0.0 — 2021-02-07
- 4.0.0 — 2021-02-07
- 3.0.0 — 2021-02-07
- 2.0.0 — 2021-02-07
- 1.0.0 — 2021-02-07

## README

## 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](http://openstreetmap.org/) (OSM). It attempts to adhere to the [Nominatim usage policy](http://wiki.openstreetmap.org/wiki/Nominatim_usage_policy).

## Example

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

const NominatimClient = new Nominatim('Nelson\'s Obvious tracking (NO tracking) <nelson.bighetti@hooli.xyz>');

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

## Installation

```bash
$ 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](https://medium.com/@alonronin/magic-methods-in-javascript-meet-proxy-65e6305f4d3e)! (Literally a google search I just made)

---
_Source: https://npm.io/package/@informath/nominatim · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._