Detalhes do pacote

pray-calc

acamarata62MIT1.7.2

Accurate prayer times using custom algorithm for dynamic angles and nrel-spa for extreme precision

prayer-times, islamic-prayer-times, adhan-times, fajr

readme (leia-me)

pray-calc

A high-precision prayer times calculator using NREL-SPA (Solar Position Algorithm) and a dynamic Fajr and Isha angle algorithm, refined with empirical data and machine learning. Also supports traditional static-angle methods for comparison.

Live Demo: PrayCalc.com
Documentation & Wiki: PrayCalc.net

📌 This library is in active development and is currently in beta. Please test and submit feedback or issues, inshaa’ Allah.


🚀 Version 1.7 Highlights

Version 1.7 introduces major improvements:

  • Fixed a bug in the core NREL-SPA JavaScript implementation that caused times to be off by up to several minutes.
  • Custom dynamic angle calculation has been completely rewritten using scientific modeling, atmospheric inputs, and ML-trained empirical data. It now generates Fajr and Isha angles that are accurate across all locations and seasons, instead of a simple offset from 18°.

Traditional calculators (based on suncalc or fixed-angle approximations) are known to have timing errors of 2–7 minutes or more, especially at higher latitudes. Our implementation aims for sub-minute accuracy by default.


📦 Installation

npm install pray-calc

🛠️ Usage Example

const { getTimes, calcTimesAll } = require('pray-calc');

// Example for New York City (minimal params)
const date = new Date('2024-01-01T00:00:00Z');
const city = "New York";
const lat = 40.7128;
const lng = -74.006;
const tz = -5;

// Full example for Jakarta:
/*
const city = "Jakarta";
const lat = -6.2088;
const lng = 106.8456;
const tz = 7;
const elevation = 18;
const temperature = 26.56;
const pressure = 1017;
*/

const get = getTimes(date, lat, lng); // Minimal args
const calc = calcTimesAll(date, lat, lng, tz); // Full formatting

console.log(`\nTest: ${city} on ${date.toISOString()}:\n`);
console.log("getTimes =", get, "\n");
console.log("calcTimesAll =", calc, "\n");

🔧 Functions Overview

getTimes(date, lat, lng, tz?, elevation?, temperature?, pressure?, standard?)

Returns prayer times as decimal/fractional hours using dynamic twilight angles.

calcTimesAll(date, lat, lng, tz?, elevation?, temperature?, pressure?)

Returns prayer times as formatted HH:MM:SS and includes traditional methods under a .methods key.

getMoon(date, accuracy = false)

Returns:

  • fraction – moon illumination (0–1)
  • phase – moon phase (e.g., Full Moon)
  • angle – angle from the sun (for visibility estimation)

Helpful for determining moon visibility after Maghrib.


🔢 Parameters

  • date: JavaScript Date object
  • lat: Latitude (decimal degrees)
  • lng: Longitude (decimal degrees)
  • tz: Timezone offset from UTC (optional, defaults to Date object)
  • elevation: Meters above sea level (default: 50)
  • temperature: Ambient °C (default: 15)
  • pressure: mbar / hPa (default: 1013.25)
  • standard: true = Shāfiʿī (Asr shadow = 1), false = Ḥanafī (shadow = 2)

📚 Static vs. Dynamic Methods

The All functions return both:

  • The custom dynamic method (default)
  • Multiple legacy methods:
    • Muslim World League (MWL)
    • Egyptian General Authority of Survey (EGAS)
    • ISNA, Umm al-Qura, Gulf, etc.

This lets developers compare traditional fixed-angle results to the more accurate dynamic calculation.


🤝 Contributing

Contributions, observations, and validations are welcome!


🧪 Accuracy Notes

This package is built for high-precision use cases:

  • Real-time applications (e.g., adhan clocks)
  • Scientific Islamic astronomy
  • High-latitude and seasonal edge-case handling

All core calculations use NREL-SPA and angles dynamically generated to match observable twilight.


📄 License

MIT License

changelog (log de mudanças)

Changelog

All notable changes to this project will be documented in this file.

[1.0.0] - 2023-11-11

  • Initial release

[1.1.0] - 2023-11-12

  • Updated calculation behavior to be more accurate (major)

[1.2.3] - 2023-11-12

  • Moved timezone to main args and changed default behavior (major)
  • Updated test cases and readme to reflect new usage (minor)

[1.3.2] - 2023-11-13

  • Major updates to getMoon with own functions

[1.4.0] - 2023-11-14

  • Renamed to "pray-calc" and removed old package
  • Improved Synodic accuracy slightly and lastKnownMoon

[1.4.1] = 2023-12-01

  • Modified getMoonVisibility to use adjusted moon phase for end of cycle

[1.6.0] = 2025-05-04

  • Major fixes for core files and calculations
  • Updated to use the new "nrel-spa" v1.3.0

[1.6.1] - 2025-05-04

  • Fixed missing modules and types definitions lost in last update
  • Locked suncalc dependency to ^1.9.0
  • Clarified scripts: build, test, and prepublishOnly in package.json

[1.6.2] - 2025-05-04

  • Fixed Package issues

[1.7.0] = 2025-05-04

  • Major update to main algorithm
  • Fixes to syntax and bugs

[1.7.1] = 2025-05-14

  • Update to package meta and location

[1.7.2] = 2025-05-14

  • Added tests