# geo-route-generator

> A library to generate geographical route between two points.

Latest version **1.3.0** (published 2021-03-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install geo-route-generator
pnpm add geo-route-generator
yarn add geo-route-generator
bun add geo-route-generator
```

## 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.3.0 |
| Published | 2021-03-31 |
| First published | 2021-03-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 12.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Josemi Chaves |
| Maintainers | josemichaves |

## Links

- npm: https://www.npmjs.com/package/geo-route-generator
- Repository: https://github.com/JosemiChaves9/geo-route-generator
- Homepage: https://github.com/JosemiChaves9/geo-route-generator#readme
- Issues: https://github.com/JosemiChaves9/geo-route-generator/issues
- npm.io page: https://npm.io/package/geo-route-generator

## Recent versions

- 1.3.0 (latest) — 2021-03-31
- 1.2.0 — 2021-03-31
- 1.1.0 — 2021-03-26
- 1.0.0 — 2021-03-25

## README

# OVERVIEW

This is a library to calculate a route between two coordinates.
It will return an array with all the points specified between two coordinates

---

# INSTALLATION

`npm i geo-route-genrator`

---

# USAGE

`import generateRoute from "geo-route-generator"`

This library only have one method `generateRoute()` with three parameters in it:

- StartPosition
- FinalPosition
- Steps

At **StartPosition** and **FinalPosition** you need to pass a object with _lat_ and _lng_ which are the coordinates of the two points you'll be calculating the distance between.

```
const startPos = {
    lat: 25.248726,
    lng: -2.189138
}
```

For the **Steps** parameter you need to specify how many points you route will have, if you put 1000 then the lbrary will return an array with 1000 entries.

```
    const startPos = {
    lat: 45.385348723467,
    lng: -72.644464557683,
  };

  const finalPos = {
    lat: 29.384348971766,
    lng: -85.526861831764,
  };

  const steps = 1000;

  const route = generateRoute(startPos, finalPos, steps);

  // Will return
  // [{
    "lat": 43.785248748296894,"lng": -73.93270428509109},
    ...,
    {"lat": 35.78474887244638,"lng": -80.37390292213158},
    ...,
    {"lat": 29.384348971765974,"lng": -85.52686183176397}]
```

---

# Testing

There's unit testing implemented, there's four use cases in where the coordinates have different scenarios, you can test it with

`npm test`

or

`yarn test`

---

# OTHER SOURCES

You can give it a ★ in [GitHub](https://github.com/JosemiChaves9/geo-route-generator)!

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