geo-distance-helper/README.md

Get distance between two points in kilometers or nautical miles

# geo-distance-helper

Get distance between two points in kilometers, nautical miles
<br/>
<br/>
**100% typescript**, get autocompletions while using.

## Install

- npm

```
npm install geo-distance-helper
```

- yarn

```
yarn add geo-distance-helper
```

## API

| Args   | Type       | Required | Default | Description                          |
| ------ | ---------- | -------- | ------- | ------------------------------------ |
| point1 | `GeoPoint` | true     | -       | Point1 coordinates                   |
| point2 | `GeoPoint` | true     | -       | Point2 coordinates                   |
| unit   | string     | false    | 'K'     | 'K': Kilometers, 'N': Nautical miles |

## Types

- GeoPoint

| Args | Type   | Required | Default | Description     |
| ---- | ------ | -------- | ------- | --------------- |
| lat  | number | true     | -       | Point latitude  |
| lng  | number | true     | -       | Point longitude |

## Example Usage

```
import geoDistance from 'geo-distance-helper';
// const geoDistance = require('geo-distance-helper');

const point1 = {lat: 36, lng: 42};
const point2 = {lat: 64, lng: 21};

// distance in kilometers
const distance = geoDistance(point1, point2);
// or
const distance = geoDistance(point1, point2, 'K');

// distance in nautical miles
const distance = geoDistance(point1, point2, 'N');
```