# turf-bearing

> turf bearing module

Latest version **3.0.12** (published 2016-07-05) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install turf-bearing
pnpm add turf-bearing
yarn add turf-bearing
bun add turf-bearing
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 3.0.12 |
| Published | 2016-07-05 |
| First published | 2014-08-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | jvrousseau |
| Maintainers | cspanring, cwmma, jseppi, jvrousseau, lyzidiamond, morganherlocker, mourner, tcql, tmcw |
| Keywords | turf, bearing |

## Links

- npm: https://www.npmjs.com/package/turf-bearing
- Repository: https://github.com/Turfjs/turf-bearing
- Issues: https://github.com/Turfjs/turf-bearing/issues
- npm.io page: https://npm.io/package/turf-bearing

## Dependencies (1)

- [turf-invariant](https://npm.io/package/turf-invariant.md) ^3.0.12

## Recent versions

- 3.0.12 (latest) — 2016-07-05
- 3.0.7-canary.ae89c8b3 (canary) — 2016-06-14
- 3.0.10 — 2016-06-15
- 3.0.7 — 2016-06-13
- 3.0.6 — 2016-06-03
- 3.0.5-canary.4f73aa1a — 2016-06-03
- 3.0.1 — 2016-05-16
- 3.0.0-canary.7879bf6c — 2016-05-16
- 3.0.0-canary.2f5f7167 — 2016-05-16
- 1.0.2 — 2015-12-18
- 1.0.1 — 2015-02-06
- 1.0.0 — 2014-12-11
- 0.0.2 — 2014-08-06
- 0.0.1 — 2014-08-01

## README

# turf-bearing

# bearing

Takes two [points](Point) and finds the geographic bearing between them.

**Parameters**

-   `start` **Feature<Point>** starting Point
-   `end` **Feature<Point>** ending Point

**Examples**

```javascript
var point1 = {
  "type": "Feature",
  "properties": {
    "marker-color": '#f00'
  },
  "geometry": {
    "type": "Point",
    "coordinates": [-75.343, 39.984]
  }
};
var point2 = {
  "type": "Feature",
  "properties": {
    "marker-color": '#0f0'
  },
  "geometry": {
    "type": "Point",
    "coordinates": [-75.534, 39.123]
  }
};

var points = {
  "type": "FeatureCollection",
  "features": [point1, point2]
};

//=points

var bearing = turf.bearing(point1, point2);

//=bearing
```

Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** bearing in decimal degrees

---

This module is part of the [Turfjs project](http://turfjs.org/), an open source
module collection dedicated to geographic algorithms. It is maintained in the
[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
PRs and issues.

### Installation

Install this module individually:

```sh
$ npm install turf-bearing
```

Or install the Turf module that includes it as a function:

```sh
$ npm install turf
```

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