# geocodr

> geocoder

Latest version **1.1.6** (published 2017-01-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install geocodr
pnpm add geocodr
yarn add geocodr
bun add geocodr
```

## 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 | 1.1.6 |
| Published | 2017-01-23 |
| First published | 2016-07-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Tony L. Kerz |
| Maintainers | tony-kerz |

## Links

- npm: https://www.npmjs.com/package/geocodr
- Repository: https://github.com/tony-kerz/node-geocodr
- Homepage: https://github.com/tony-kerz/node-geocodr#readme
- Issues: https://github.com/tony-kerz/node-geocodr/issues
- npm.io page: https://npm.io/package/geocodr

## Dependencies (3)

- [axios](https://npm.io/package/axios.md) ^0.14.0
- [debug](https://npm.io/package/debug.md) ^2.6.0
- [tymer](https://npm.io/package/tymer.md) ^1.0.2

## Recent versions

- 1.1.6 (latest) — 2017-01-23
- 1.1.5 — 2017-01-23
- 1.1.4 — 2017-01-22
- 1.1.3 — 2017-01-21
- 1.0.6 — 2016-09-02
- 1.0.5 — 2016-09-02
- 1.0.4 — 2016-09-01
- 1.0.3 — 2016-07-31
- 1.0.2 — 2016-07-20
- 1.0.1 — 2016-07-17

## README

# node-geocodr

this simple component allows for geocoding from various providers

[![Build Status](https://travis-ci.org/tony-kerz/node-geocodr.svg?branch=master)](https://travis-ci.org/tony-kerz/node-geocodr)
[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)

## currently supported adapters

[adapters](./adapters)

## example usage

> currently just returns an array of the form [lon, lat] or null if the address can't be geocoded

### geocode single
```
import geocode, {nominatim} from 'geocodr'

geocode('10021', nominatim).then((coordinates)=>{
  // do stuff with coordinates
})
```

### geocode multiple
```
import geocode, {geocodio} from 'geocodr'

geocode(['10021', '06067', '06108'], geocodio).then((coordinates)=>{
  // do stuff with coordinates (will be an array of [lon, lat] arrays in respective order)
})
```

### override default
```
import geocode, {mapzen} from 'geocodr'

geocode('10021', {...mapzen, api_key: 'my-api-key'}).then((coordinates)=>{
  // do stuff with coordinates
})
```

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