mirror of https://github.com/acamarata/pray-calc.git synced 2026-06-30 19:04:26 +00:00

Aric Camarata 4227afc2c3 docs: add TypeDoc API generation (typedoc@0.28.19 + typedoc-plugin-markdown@4.11.0)

Add typedoc and typedoc-plugin-markdown as devDependencies. Add typedoc.json config
targeting src/index.ts with markdown output to .github/wiki/api. Add docs script to
package.json. Generate initial API reference pages.

Part of T-E8-03 — TypeDoc automation for all 12 JS/TS packages.

2026-05-30 16:41:58 -04:00

1.4 KiB

Raw Blame History

pray-calc v2.1.1

pray-calc / getTimesAll

Function: getTimesAll()

getTimesAll(date, lat, lng, tz?, elevation?, temperature?, pressure?, hanafi?): PrayerTimesAll

Defined in: getTimesAll.ts:152

Compute prayer times plus all traditional method comparisons.

Parameters

date

Date

Observer's local date (time-of-day is ignored)

lat

number

Latitude in decimal degrees (-90 to 90)

lng

number

Longitude in decimal degrees (-180 to 180)

tz?

number = ...

UTC offset in hours (defaults to system tz)

elevation?

number = 0

Observer elevation in meters (default: 0)

temperature?

number = 15

Ambient temperature in °C (default: 15)

pressure?

number = 1013.25

Atmospheric pressure in mbar (default: 1013.25)

hanafi?

boolean = false

Asr convention: false = Shafi'i (default), true = Hanafi

Returns

PrayerTimesAll

Prayer times for the dynamic method plus all traditional methods. Any time that cannot be computed is returned as NaN. Methods map contains [fajrTime, ishaTime] per method.

Throws

if lat, lng, tz, or elevation are out of valid range

1.4 KiB Raw Blame History