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.5 KiB

Raw Blame History

pray-calc v2.1.1

pray-calc / calcTimesAll

Function: calcTimesAll()

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

Defined in: calcTimesAll.ts:30

Compute prayer times formatted as HH:MM:SS strings, plus comparison times for every supported traditional method.

Uses the dynamic twilight angle algorithm for the primary times. See getTimesAll() for full parameter documentation.

Parameters

date

Date

Observer's local date

lat

number

Latitude in decimal degrees (-90 to 90)

lng

number

Longitude in decimal degrees (-180 to 180)

tz?

number = ...

UTC offset in hours (default: system timezone)

elevation?

number = 0

Elevation in meters (default: 0)

temperature?

number = 15

Temperature in Celsius (default: 15)

pressure?

number = 1013.25

Pressure in mbar/hPa (default: 1013.25)

hanafi?

boolean = false

Hanafi Asr convention (default: false)

Returns

FormattedPrayerTimesAll

All prayer times as HH:MM:SS strings. "N/A" for unreachable events.

Example

const result = calcTimesAll(new Date('2024-06-21'), 40.7128, -74.006, -4);
console.log(result.dynamic.Fajr); // "03:51:24"
console.log(result.ISNA.Fajr);    // "04:07:30"

1.5 KiB Raw Blame History