Skip to content

acamarata/qibla

Repository files navigation

@acamarata/qibla

npm version CI License: MIT

Qibla direction, great-circle path, and haversine distance. Pure math, zero dependencies.

Installation

npm install @acamarata/qibla

Quick Start

import {
  qiblaAngle,
  compassDir,
  distanceKm,
  KAABA_LAT,
  KAABA_LNG,
} from "@acamarata/qibla";

// Bearing from New York to the Ka'bah
const bearing = qiblaAngle(40.7128, -74.006);
console.log(bearing); // ~58.48
console.log(compassDir(bearing)); // "NE"

// Distance in kilometers
const km = distanceKm(40.7128, -74.006, KAABA_LAT, KAABA_LNG);
console.log(km); // ~9,634

API

qiblaAngle(lat, lng): number

Computes the initial bearing (forward azimuth) from the given coordinates to the Ka'bah.

Parameter Type Description
lat number Latitude in decimal degrees (-90 to 90)
lng number Longitude in decimal degrees (-180 to 180)
Returns number Bearing in degrees clockwise from north (0-360)

Throws RangeError if coordinates are out of bounds.

compassDir(bearing): CompassAbbr

Eight-point compass abbreviation: N, NE, E, SE, S, SW, W, NW.

compassName(bearing): CompassName

Full compass name: North, Northeast, East, Southeast, South, Southwest, West, Northwest.

qiblaGreatCircle(lat, lng, steps?): [number, number][]

Generates waypoints along the great circle from [lat, lng] to the Ka'bah using spherical linear interpolation (Slerp). Returns steps + 1 points (default: 121).

Useful for drawing Qibla direction lines on maps.

distanceKm(lat1, lng1, lat2, lng2): number

Haversine distance between two points in kilometers (spherical Earth approximation, R = 6,371 km).

Constants

Name Value Description
KAABA_LAT 21.422511 Ka'bah center latitude (degrees north)
KAABA_LNG 39.826150 Ka'bah center longitude (degrees east)
EARTH_RADIUS_KM 6371 WGS-84 volumetric mean radius

Architecture

All calculations use the forward azimuth formula from spherical trigonometry. Great-circle paths use Slerp (spherical linear interpolation). Distance uses the haversine formula. The Ka'bah coordinates are fixed constants from verified GPS data.

See Architecture for algorithm details.

Compatibility

Node.js 20+. Works in browsers and all major bundlers (Webpack, Vite, Rollup, esbuild). Ships as dual CJS/ESM with full TypeScript definitions.

TypeScript

import { qiblaAngle, CompassAbbr, CompassName } from "@acamarata/qibla";

const bearing: number = qiblaAngle(40.7128, -74.006);

Documentation

Full reference available on the GitHub Wiki:

  • Home: Overview and quick start
  • API Reference: Full function and constant reference
  • Architecture: Algorithm design, spherical trigonometry, Slerp implementation

Related

Acknowledgments

Ka'bah coordinates verified against published GPS surveys and cross-checked with satellite imagery. The forward azimuth formula follows the standard spherical trigonometry derivation used in aviation and geodesy.

License

MIT

About

Qibla direction, great-circle path, and haversine distance. Pure math, zero dependencies.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors