# bigdatacloud-reverse-geocoding

> Reverse geocoding browser-based typescript library, using free Bigdatacloud API

Latest version **0.2.0** (published 2019-11-29) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install bigdatacloud-reverse-geocoding
pnpm add bigdatacloud-reverse-geocoding
yarn add bigdatacloud-reverse-geocoding
bun add bigdatacloud-reverse-geocoding
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2019-11-29 |
| First published | 2019-11-29 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 42.7 KB |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ilya A. Shlyakhovoy |
| Maintainers | bgrusnak |
| Keywords | typescript, bigdatacloud, reverse, geocoding, browser |

## Links

- npm: https://www.npmjs.com/package/bigdatacloud-reverse-geocoding
- Repository: https://github.com/bgrusnak/bigdatacloud-reverse-geocoding
- Homepage: https://github.com/bgrusnak/bigdatacloud-reverse-geocoding#readme
- Issues: https://github.com/bgrusnak/bigdatacloud-reverse-geocoding/issues
- npm.io page: https://npm.io/package/bigdatacloud-reverse-geocoding

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^0.19.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.2.0 (latest) — 2019-11-29
- 0.1.0 — 2019-11-29

## README

# bigdatacloud-reverse-geocoding
Reverse geocoding browser-based typescript library, using free Bigdatacloud API

## Features

- Connects with Bigdatacloud.com and using reverse geocode API for acquiring the location info.
- Using promises (no callback hell anymore)

## Installation
$`npm i -S bigdatacloud-reverse-geocoding`

or

$`yarn add bigdatacloud-reverse-geocoding`

## Usage (very clear and simple)
```javascript
import ReverseGeocode, { ILocation, IGeocode } from "bigdatacloud-reverse-geocoding";
const geocode = new ReverseGeocode();
const location: ILocation = { lat: 33.23323, long: -76.33443};
const place: IGeocode = await geocode.locate(location);
console.log(place.locality);
```
### Optional initialization

You can use options. There are four parameters:
                    
| Name | Default value | Description  |
| ------------- | ---------- | --------------------------------------- |
| language  | `en` | The language of the Bigdatacloud answer. This is the only parameter that you would normally use. <br/> `new ReverseGeocode({language:"cn"})` |
| api  | `https://api.bigdatacloud.net` | The API host |
|endpoint | `/data/reverse-geocode-client` | The API endpoint |
| format | `latitude=${lat}&longitude=${long}`<br/>`&localityLanguage=${lang}` | The query string with placeholders |


## Links

[Bigdatacloud API](https://www.bigdatacloud.com/geocoding-apis/free-reverse-geocode-to-city-api)

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