mirror of
https://github.com/acamarata/pray-calc.git
synced 2026-07-01 03:14:28 +00:00
45 lines
1.5 KiB
Markdown
45 lines
1.5 KiB
Markdown
|
|
# praycalc
|
|
|
|
Prayer times calculator using nrel-spa and custom formula for Fajr and Isha angles (as well as traditional static angle methods in the All function).
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install praycalc
|
|
```
|
|
|
|
## Usage
|
|
|
|
Example of using praycalc to get prayer times:
|
|
|
|
```js
|
|
const { calcTimes } = require('./calcTimes');
|
|
|
|
const date = new Date(); // Current date
|
|
const latitude = 40.7128; // Latitude for New York City
|
|
const longitude = -74.006; // Longitude for New York City
|
|
const elevation = 10; // Elevation for New York City
|
|
|
|
const prayerTimes = calcTimes(date, latitude, longitude, elevation);
|
|
console.log(prayerTimes);
|
|
```
|
|
|
|
Exported functions include getTimes, calcTimes, getTimesAll, calcTimesAll where the "get" functions return fractal or decimal times directly from the source nrel-spa calculator and the "calc" functions return formatted times in HH:MM:SS.sss format. The functions will give results including our custom angle but the "All" functions will include a methods key with all traditional static angle methods (Muslim World League, Egyptian General Authority of Survey, ISNA, etc.) included as well for their Fajr and Isha times.
|
|
|
|
### Parameters:
|
|
|
|
- date: The date for which prayer times are calculated.
|
|
- lat: Latitude of the location.
|
|
- lng: Longitude of the location.
|
|
- elevation: Elevation in meters (optional, default 50).
|
|
- temperature: Temperature in Celsius (optional, default 15).
|
|
- pressure: Atmospheric pressure in millibars (optional, default 1013.25).
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome!
|
|
|
|
## License
|
|
|
|
ISC License
|