windrose

Windrose

Info

Windrose is a javascript browser/node module that converts compass degrees into compass points and vice versa.

Getting Started

NPM

npm install windrose --save

Bower

bower install windrose --save

Usage

Node

var Windrose = require('windrose');

Windrose.getPoint(225);       /* returns { symbol: 'SW', name: 'South West' } */
Windrose.getPoint(236.25);    /* returns { symbol: SWbW, name: 'South West by West' } */

Windrose.getDegrees('S');     /* returns 90 */
Windrose.getDegrees('South'); /* returns 90 */

Browser

Just include it in your html:

<script type="text/javascript" src="windrose.js">

The Windrose object will be available in your global scope.

It also supports AMD.

API

Windrose.getPoint(degrees)

• degrees (number) the degrees to convert to point (only valid if >= 0 or <= 360)

Windrose.getDegrees(name)

• name (string) the name or symbol of the compass point to convert to degrees

License

Copyright (c) 2015 Rogério Vicente. Licensed under the MIT license.