Cardinal Direction

Each of the 4 main compass quadrants (N,E,S,W), contain 7 sub-regions. This tool can be used to convert a degree ranging from 0-360 to a correlated cardinal direction.

Example of North Quadrant Cardinal Directions

See CardinalDirection for the full list.

N – North
NbE – North by East
NNE – North Northeast
NEbN – Northeast by North
NE – Northeast
NEbE – Northeast by East
ENE – East Northeast
EbN – East by North

Install

npm install cardinal-direction

Usage

const Compass = require("cardinal-direction");

cardinalFromDegree

Converts a compass degree value into its correlated cardinal value.

Param	Type	Required	Description
degree	number	yes	A number between `0` and `360`.
subset	CardinalSubset	no	Restricts the return value to a subset of the possible cardinal directions. The default is `Full`. See CardinalSubset for more.

/*
 * Basic usage.
 * - returns "SW"
 */
Compass.cardinalFromDegree(221);

/*
 * Restricting results with subset.
 * - returns "W"
 */
Compass.cardinalFromDegree(221, Compass.CardinalSubset.Basic);

degreeFromCardinal

Converts a cardinal direction into its correlated degree value.

Param	Type	Required	Description
cardinal	CardinalDirection	yes	One of the possible cardinal directions. See CardinalDirection for more.

/*
 * These all return 90.
 */
Compass.degreeFromCardinal("E");
Compass.degreeFromCardinal(Compass.CardinalDirection["E"]);
Compass.degreeFromCardinal(Compass.CardinalDirection.E);
Compass.degreeFromCardinal(Compass.CardinalDirection[8]);
Compass.degreeFromCardinal(8);

cardinalConverter

Converts a cardinal value to either its abbreviation or full title.

Param	Type	Required	Description
cardinal	string/number	yes	One of the `CardinalDirection` enum member values, or its full title. See Cardinal Table for context.

Compass.cardinalConverter(3): // NEbN
Compass.cardinalConverter("NEbN"): // Northeast by North
Compass.cardinalConverter("Northeast by North"); // NEbN

CardinalSubset enum

This subset enum can be used to fine tune the return value of cardinalFromDegree. When used the specified degree will be pushed to the nearest accepted cardinal direction, based on your restriction.

Value	Description
Full	Enables all possible cardinal directions to be retuned. *Default*
Basic	Restricts the possible returned cardinals to N,E,S,W.
Ordinal	Extends `Basic` to include NE,SE,SW,NW,.
Intercardinal	Extends `Ordinal` to include NNE,ENE,ESE,SSE,SSW,WSW,WNW,NNW.