# wgs84-util

> Geographic coordinate utilities using WGS84 datum

Latest version **3.0.0** (published 2016-01-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install wgs84-util
pnpm add wgs84-util
yarn add wgs84-util
bun add wgs84-util
```

## 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 | 3.0.0 |
| Published | 2016-01-13 |
| First published | 2014-03-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13 |
| Author | csbrandt |
| Maintainers | csbrandt |
| Keywords | wgs84, geodesy, ellipsoid, UTM, GeoJSON, Vincenty |

## Links

- npm: https://www.npmjs.com/package/wgs84-util
- Repository: https://github.com/csbrandt/WGS84Util
- Homepage: https://github.com/csbrandt/WGS84Util#readme
- Issues: https://github.com/csbrandt/WGS84Util/issues
- npm.io page: https://npm.io/package/wgs84-util

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 3.0.0 (latest) — 2016-01-13
- 2.0.1 — 2015-07-09
- 2.0.0 — 2015-05-25
- 1.0.3 — 2014-07-11
- 1.0.2 — 2014-06-08
- 1.0.1 — 2014-06-08
- 1.0.0 — 2014-05-17
- 0.1.2 — 2014-04-24
- 0.1.1 — 2014-04-24
- 0.1.0 — 2014-04-23
- 0.0.4 — 2014-03-01
- 0.0.3 — 2014-03-01
- 0.0.2 — 2014-03-01
- 0.0.1 — 2014-03-01

## README

[![NPM](https://nodei.co/npm/wgs84-util.png?downloads=true&stars=true)](https://nodei.co/npm/wgs84-util/)

Geographic coordinate utilities using WGS84 datum

Installation
-------------
    $ npm install wgs84-util

Methods
--------
    distanceBetween(pointA, pointB [, bearings ])
> Calculate the distance between a set of GeoJSON points in meters
>
> Uses [Vincenty inverse](https://en.wikipedia.org/wiki/Vincenty's_formulae#Inverse_problem) calculation
>
> Adapted from http://www.movable-type.co.uk/scripts/latlong-vincenty.html
>
> **Parameters**
>
> **pointA**:  *object*,  GeoJSON point
>
> **pointB**:  *object*,  GeoJSON point
>
> **bearings**: *boolean*,  optional switch for including the bearings in degrees
>
> **Returns**
>
> *number | object*,  distance from this point to the supplied point
> in meters or an object that includes distance, initial and final bearings
>
> **throws**: *Error*,  if formula failed to converge

    bearingsBetween(pointA, pointB)
> Convenience function for returning only the initial and final bearings
> between the given coordinates (forward azimuths at each point)
>
> **Parameters**
>
> **pointA**:  *object*,  GeoJSON point
>
> **pointB**:  *object*,  GeoJSON point
>
> **Returns**
>
> *object*,  forward azimuths (initial and final bearings) at each point in degrees

    destination(point, bearing, distance)
> Calculate the destination point from this point having travelled the given
> distance in meters on the given initial bearing
>
> Uses [Vincenty direct](https://en.wikipedia.org/wiki/Vincenty's_formulae#Direct_Problem) calculation
>
> Adapted from http://www.movable-type.co.uk/scripts/latlong-vincenty.html
>
> **Parameters**
>
> **point**:  *object*, GeoJSON point
>
> **bearing**:  *number*,  initial bearing in degrees from north
>
> **distance**:  *number*,  distance along bearing in meters
>
> **Returns**
>
> *object*,  GeoJSON destination point, finalBearing
>
> **throws**: *Error*,  if formula failed to converge

    degToRad(deg)
> Conversion from degrees to radians
>
> **Parameters**
>
> **deg**:  *number*,  angle in degrees
>
> **Returns**
>
> *number*,  angle in radians

    radToDeg(rad)

> Conversion from radians to degrees
>
> **Parameters**
>
> **rad**:  *number*,  angle in radians
>
> **Returns**
>
> *number*,  angle in degrees

    LLtoUTM(ll)

> Converts a set of Longitude and Latitude coordinates to UTM
> using the WGS84 ellipsoid.
>
> **Parameters**
>
> **ll**:  *object*, GeoJSON point representing the coordinate to be converted
>
> **Returns**
>
> *object*,  GeoJSON feature containing the UTM value with easting,
> northing, zoneNumber and zoneLetter properties, and an optional
> accuracy property in digits. Returns null if the conversion failed.

    UTMtoLL(utm)
> Converts UTM coordinates to lat/long, using the WGS84 ellipsoid
>
> **Parameters**
>
> **utm**:  *object*, with northing, easting, zoneNumber
> and zoneLetter properties. If an optional accuracy property is
> provided (in meters), a bounding box will be returned instead of
> latitude and longitude.
>
> **Returns**
>
> *object*, GeoJSON object containing either lat and lon values
> (if no accuracy was provided), or top, right, bottom and left values
> for the bounding box calculated according to the provided accuracy.
> Returns null if the conversion failed.

Running Tests
--------------
Install the development dependencies:

    $ npm install

Then run the tests:

    $ npm test

Code Coverage
--------------
Install the development dependencies:

    $ npm install

Then run coverage

    $ npm run coverage

View coverage reports

    $ firefox coverage/lcov-report/index.html

Browser Bundle
---------------
    $ npm run build

## License

Copyright (c) 2016 Christopher Brandt

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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