mirror of
https://github.com/acamarata/pray-calc.git
synced 2026-06-30 19:04:26 +00:00
docs: refresh TypeDoc API output (T-E8-03 QA-A verify)
This commit is contained in:
parent
4227afc2c3
commit
76a2ea8a96
28 changed files with 82 additions and 82 deletions
2
.github/wiki/api/functions/calcTimes.md
vendored
2
.github/wiki/api/functions/calcTimes.md
vendored
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
> **calcTimes**(`date`, `lat`, `lng`, `tz?`, `elevation?`, `temperature?`, `pressure?`, `hanafi?`): [`FormattedPrayerTimes`](../interfaces/FormattedPrayerTimes.md)
|
||||
|
||||
Defined in: [calcTimes.ts:30](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/calcTimes.ts#L30)
|
||||
Defined in: [calcTimes.ts:30](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/calcTimes.ts#L30)
|
||||
|
||||
Compute prayer times formatted as HH:MM:SS strings.
|
||||
|
||||
|
|
|
|||
2
.github/wiki/api/functions/calcTimesAll.md
vendored
2
.github/wiki/api/functions/calcTimesAll.md
vendored
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
> **calcTimesAll**(`date`, `lat`, `lng`, `tz?`, `elevation?`, `temperature?`, `pressure?`, `hanafi?`): [`FormattedPrayerTimesAll`](../interfaces/FormattedPrayerTimesAll.md)
|
||||
|
||||
Defined in: [calcTimesAll.ts:30](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/calcTimesAll.ts#L30)
|
||||
Defined in: [calcTimesAll.ts:30](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/calcTimesAll.ts#L30)
|
||||
|
||||
Compute prayer times formatted as HH:MM:SS strings, plus comparison times
|
||||
for every supported traditional method.
|
||||
|
|
|
|||
2
.github/wiki/api/functions/getAngles.md
vendored
2
.github/wiki/api/functions/getAngles.md
vendored
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
> **getAngles**(`date`, `lat`, `lng`, `elevation?`, `temperature?`, `pressure?`): [`TwilightAngles`](../interfaces/TwilightAngles.md)
|
||||
|
||||
Defined in: [getAngles.ts:216](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/getAngles.ts#L216)
|
||||
Defined in: [getAngles.ts:216](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/getAngles.ts#L216)
|
||||
|
||||
Compute dynamic twilight depression angles for Fajr and Isha.
|
||||
|
||||
|
|
|
|||
2
.github/wiki/api/functions/getAsr.md
vendored
2
.github/wiki/api/functions/getAsr.md
vendored
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
> **getAsr**(`solarNoon`, `latitude`, `declination`, `hanafi?`): `number`
|
||||
|
||||
Defined in: [getAsr.ts:21](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/getAsr.ts#L21)
|
||||
Defined in: [getAsr.ts:21](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/getAsr.ts#L21)
|
||||
|
||||
Compute Asr time as fractional hours.
|
||||
|
||||
|
|
|
|||
2
.github/wiki/api/functions/getMidnight.md
vendored
2
.github/wiki/api/functions/getMidnight.md
vendored
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
> **getMidnight**(`maghribTime`, `endTime`): `number`
|
||||
|
||||
Defined in: [getMidnight.ts:16](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/getMidnight.ts#L16)
|
||||
Defined in: [getMidnight.ts:16](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/getMidnight.ts#L16)
|
||||
|
||||
Compute the midpoint of the night.
|
||||
|
||||
|
|
|
|||
2
.github/wiki/api/functions/getMscFajr.md
vendored
2
.github/wiki/api/functions/getMscFajr.md
vendored
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
> **getMscFajr**(`date`, `latitude`): `number`
|
||||
|
||||
Defined in: [getMSC.ts:103](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/getMSC.ts#L103)
|
||||
Defined in: [getMSC.ts:103](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/getMSC.ts#L103)
|
||||
|
||||
Compute Fajr offset in minutes before sunrise using the MCW algorithm.
|
||||
|
||||
|
|
|
|||
2
.github/wiki/api/functions/getMscIsha.md
vendored
2
.github/wiki/api/functions/getMscIsha.md
vendored
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
> **getMscIsha**(`date`, `latitude`, `shafaq?`): `number`
|
||||
|
||||
Defined in: [getMSC.ts:133](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/getMSC.ts#L133)
|
||||
Defined in: [getMSC.ts:133](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/getMSC.ts#L133)
|
||||
|
||||
Compute Isha offset in minutes after sunset using the MCW algorithm.
|
||||
|
||||
|
|
|
|||
2
.github/wiki/api/functions/getQiyam.md
vendored
2
.github/wiki/api/functions/getQiyam.md
vendored
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
> **getQiyam**(`fajrTime`, `ishaTime`): `number`
|
||||
|
||||
Defined in: [getQiyam.ts:16](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/getQiyam.ts#L16)
|
||||
Defined in: [getQiyam.ts:16](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/getQiyam.ts#L16)
|
||||
|
||||
Compute the start of the last third of the night.
|
||||
|
||||
|
|
|
|||
2
.github/wiki/api/functions/getTimes.md
vendored
2
.github/wiki/api/functions/getTimes.md
vendored
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
> **getTimes**(`date`, `lat`, `lng`, `tz?`, `elevation?`, `temperature?`, `pressure?`, `hanafi?`): [`PrayerTimes`](../interfaces/PrayerTimes.md)
|
||||
|
||||
Defined in: [getTimes.ts:39](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/getTimes.ts#L39)
|
||||
Defined in: [getTimes.ts:39](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/getTimes.ts#L39)
|
||||
|
||||
Compute prayer times for a given date and location.
|
||||
|
||||
|
|
|
|||
2
.github/wiki/api/functions/getTimesAll.md
vendored
2
.github/wiki/api/functions/getTimesAll.md
vendored
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
> **getTimesAll**(`date`, `lat`, `lng`, `tz?`, `elevation?`, `temperature?`, `pressure?`, `hanafi?`): [`PrayerTimesAll`](../interfaces/PrayerTimesAll.md)
|
||||
|
||||
Defined in: [getTimesAll.ts:152](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/getTimesAll.ts#L152)
|
||||
Defined in: [getTimesAll.ts:152](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/getTimesAll.ts#L152)
|
||||
|
||||
Compute prayer times plus all traditional method comparisons.
|
||||
|
||||
|
|
|
|||
2
.github/wiki/api/functions/solarEphemeris.md
vendored
2
.github/wiki/api/functions/solarEphemeris.md
vendored
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
> **solarEphemeris**(`jd`): `SolarEphemeris`
|
||||
|
||||
Defined in: [getSolarEphemeris.ts:46](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/getSolarEphemeris.ts#L46)
|
||||
Defined in: [getSolarEphemeris.ts:46](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/getSolarEphemeris.ts#L46)
|
||||
|
||||
Compute solar declination, Earth-Sun distance, and ecliptic longitude
|
||||
from a Julian Date. Accuracy: ~0.01° for declination, ~0.0001 AU for r.
|
||||
|
|
|
|||
2
.github/wiki/api/functions/toJulianDate.md
vendored
2
.github/wiki/api/functions/toJulianDate.md
vendored
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
> **toJulianDate**(`date`): `number`
|
||||
|
||||
Defined in: [getSolarEphemeris.ts:22](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/getSolarEphemeris.ts#L22)
|
||||
Defined in: [getSolarEphemeris.ts:22](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/getSolarEphemeris.ts#L22)
|
||||
|
||||
Convert a JavaScript Date to a Julian Date number.
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
# Interface: AtmosphericParams
|
||||
|
||||
Defined in: [types.ts:97](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L97)
|
||||
Defined in: [types.ts:97](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L97)
|
||||
|
||||
Optional atmospheric and elevation parameters.
|
||||
|
||||
|
|
@ -16,7 +16,7 @@ Optional atmospheric and elevation parameters.
|
|||
|
||||
> `optional` **elevation?**: `number`
|
||||
|
||||
Defined in: [types.ts:98](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L98)
|
||||
Defined in: [types.ts:98](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L98)
|
||||
|
||||
***
|
||||
|
||||
|
|
@ -24,7 +24,7 @@ Defined in: [types.ts:98](https://github.com/acamarata/pray-calc/blob/af34aef986
|
|||
|
||||
> `optional` **pressure?**: `number`
|
||||
|
||||
Defined in: [types.ts:100](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L100)
|
||||
Defined in: [types.ts:100](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L100)
|
||||
|
||||
***
|
||||
|
||||
|
|
@ -32,4 +32,4 @@ Defined in: [types.ts:100](https://github.com/acamarata/pray-calc/blob/af34aef98
|
|||
|
||||
> `optional` **temperature?**: `number`
|
||||
|
||||
Defined in: [types.ts:99](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L99)
|
||||
Defined in: [types.ts:99](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L99)
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
# Interface: FormattedPrayerTimes
|
||||
|
||||
Defined in: [types.ts:50](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L50)
|
||||
Defined in: [types.ts:50](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L50)
|
||||
|
||||
Prayer times formatted as HH:MM:SS strings.
|
||||
|
||||
|
|
@ -16,7 +16,7 @@ Prayer times formatted as HH:MM:SS strings.
|
|||
|
||||
> **angles**: [`TwilightAngles`](TwilightAngles.md)
|
||||
|
||||
Defined in: [types.ts:60](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L60)
|
||||
Defined in: [types.ts:60](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L60)
|
||||
|
||||
***
|
||||
|
||||
|
|
@ -24,7 +24,7 @@ Defined in: [types.ts:60](https://github.com/acamarata/pray-calc/blob/af34aef986
|
|||
|
||||
> **Asr**: `string`
|
||||
|
||||
Defined in: [types.ts:56](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L56)
|
||||
Defined in: [types.ts:56](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L56)
|
||||
|
||||
***
|
||||
|
||||
|
|
@ -32,7 +32,7 @@ Defined in: [types.ts:56](https://github.com/acamarata/pray-calc/blob/af34aef986
|
|||
|
||||
> **Dhuhr**: `string`
|
||||
|
||||
Defined in: [types.ts:55](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L55)
|
||||
Defined in: [types.ts:55](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L55)
|
||||
|
||||
***
|
||||
|
||||
|
|
@ -40,7 +40,7 @@ Defined in: [types.ts:55](https://github.com/acamarata/pray-calc/blob/af34aef986
|
|||
|
||||
> **Fajr**: `string`
|
||||
|
||||
Defined in: [types.ts:52](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L52)
|
||||
Defined in: [types.ts:52](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L52)
|
||||
|
||||
***
|
||||
|
||||
|
|
@ -48,7 +48,7 @@ Defined in: [types.ts:52](https://github.com/acamarata/pray-calc/blob/af34aef986
|
|||
|
||||
> **Isha**: `string`
|
||||
|
||||
Defined in: [types.ts:58](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L58)
|
||||
Defined in: [types.ts:58](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L58)
|
||||
|
||||
***
|
||||
|
||||
|
|
@ -56,7 +56,7 @@ Defined in: [types.ts:58](https://github.com/acamarata/pray-calc/blob/af34aef986
|
|||
|
||||
> **Maghrib**: `string`
|
||||
|
||||
Defined in: [types.ts:57](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L57)
|
||||
Defined in: [types.ts:57](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L57)
|
||||
|
||||
***
|
||||
|
||||
|
|
@ -64,7 +64,7 @@ Defined in: [types.ts:57](https://github.com/acamarata/pray-calc/blob/af34aef986
|
|||
|
||||
> **Midnight**: `string`
|
||||
|
||||
Defined in: [types.ts:59](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L59)
|
||||
Defined in: [types.ts:59](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L59)
|
||||
|
||||
***
|
||||
|
||||
|
|
@ -72,7 +72,7 @@ Defined in: [types.ts:59](https://github.com/acamarata/pray-calc/blob/af34aef986
|
|||
|
||||
> **Noon**: `string`
|
||||
|
||||
Defined in: [types.ts:54](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L54)
|
||||
Defined in: [types.ts:54](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L54)
|
||||
|
||||
***
|
||||
|
||||
|
|
@ -80,7 +80,7 @@ Defined in: [types.ts:54](https://github.com/acamarata/pray-calc/blob/af34aef986
|
|||
|
||||
> **Qiyam**: `string`
|
||||
|
||||
Defined in: [types.ts:51](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L51)
|
||||
Defined in: [types.ts:51](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L51)
|
||||
|
||||
***
|
||||
|
||||
|
|
@ -88,4 +88,4 @@ Defined in: [types.ts:51](https://github.com/acamarata/pray-calc/blob/af34aef986
|
|||
|
||||
> **Sunrise**: `string`
|
||||
|
||||
Defined in: [types.ts:53](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L53)
|
||||
Defined in: [types.ts:53](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L53)
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
# Interface: FormattedPrayerTimesAll
|
||||
|
||||
Defined in: [types.ts:81](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L81)
|
||||
Defined in: [types.ts:81](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L81)
|
||||
|
||||
Prayer times plus all method comparison times, fully formatted.
|
||||
|
||||
|
|
@ -16,7 +16,7 @@ Prayer times plus all method comparison times, fully formatted.
|
|||
|
||||
> **angles**: [`TwilightAngles`](TwilightAngles.md)
|
||||
|
||||
Defined in: [types.ts:91](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L91)
|
||||
Defined in: [types.ts:91](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L91)
|
||||
|
||||
***
|
||||
|
||||
|
|
@ -24,7 +24,7 @@ Defined in: [types.ts:91](https://github.com/acamarata/pray-calc/blob/af34aef986
|
|||
|
||||
> **Asr**: `string`
|
||||
|
||||
Defined in: [types.ts:87](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L87)
|
||||
Defined in: [types.ts:87](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L87)
|
||||
|
||||
***
|
||||
|
||||
|
|
@ -32,7 +32,7 @@ Defined in: [types.ts:87](https://github.com/acamarata/pray-calc/blob/af34aef986
|
|||
|
||||
> **Dhuhr**: `string`
|
||||
|
||||
Defined in: [types.ts:86](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L86)
|
||||
Defined in: [types.ts:86](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L86)
|
||||
|
||||
***
|
||||
|
||||
|
|
@ -40,7 +40,7 @@ Defined in: [types.ts:86](https://github.com/acamarata/pray-calc/blob/af34aef986
|
|||
|
||||
> **Fajr**: `string`
|
||||
|
||||
Defined in: [types.ts:83](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L83)
|
||||
Defined in: [types.ts:83](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L83)
|
||||
|
||||
***
|
||||
|
||||
|
|
@ -48,7 +48,7 @@ Defined in: [types.ts:83](https://github.com/acamarata/pray-calc/blob/af34aef986
|
|||
|
||||
> **Isha**: `string`
|
||||
|
||||
Defined in: [types.ts:89](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L89)
|
||||
Defined in: [types.ts:89](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L89)
|
||||
|
||||
***
|
||||
|
||||
|
|
@ -56,7 +56,7 @@ Defined in: [types.ts:89](https://github.com/acamarata/pray-calc/blob/af34aef986
|
|||
|
||||
> **Maghrib**: `string`
|
||||
|
||||
Defined in: [types.ts:88](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L88)
|
||||
Defined in: [types.ts:88](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L88)
|
||||
|
||||
***
|
||||
|
||||
|
|
@ -64,7 +64,7 @@ Defined in: [types.ts:88](https://github.com/acamarata/pray-calc/blob/af34aef986
|
|||
|
||||
> **Methods**: `Record`\<`string`, \[[`TimeString`](../type-aliases/TimeString.md), [`TimeString`](../type-aliases/TimeString.md)\]\>
|
||||
|
||||
Defined in: [types.ts:93](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L93)
|
||||
Defined in: [types.ts:93](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L93)
|
||||
|
||||
Formatted comparison times for each method: [fajrString, ishaString].
|
||||
|
||||
|
|
@ -74,7 +74,7 @@ Formatted comparison times for each method: [fajrString, ishaString].
|
|||
|
||||
> **Midnight**: `string`
|
||||
|
||||
Defined in: [types.ts:90](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L90)
|
||||
Defined in: [types.ts:90](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L90)
|
||||
|
||||
***
|
||||
|
||||
|
|
@ -82,7 +82,7 @@ Defined in: [types.ts:90](https://github.com/acamarata/pray-calc/blob/af34aef986
|
|||
|
||||
> **Noon**: `string`
|
||||
|
||||
Defined in: [types.ts:85](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L85)
|
||||
Defined in: [types.ts:85](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L85)
|
||||
|
||||
***
|
||||
|
||||
|
|
@ -90,7 +90,7 @@ Defined in: [types.ts:85](https://github.com/acamarata/pray-calc/blob/af34aef986
|
|||
|
||||
> **Qiyam**: `string`
|
||||
|
||||
Defined in: [types.ts:82](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L82)
|
||||
Defined in: [types.ts:82](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L82)
|
||||
|
||||
***
|
||||
|
||||
|
|
@ -98,4 +98,4 @@ Defined in: [types.ts:82](https://github.com/acamarata/pray-calc/blob/af34aef986
|
|||
|
||||
> **Sunrise**: `string`
|
||||
|
||||
Defined in: [types.ts:84](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L84)
|
||||
Defined in: [types.ts:84](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L84)
|
||||
|
|
|
|||
16
.github/wiki/api/interfaces/MethodDefinition.md
vendored
16
.github/wiki/api/interfaces/MethodDefinition.md
vendored
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
# Interface: MethodDefinition
|
||||
|
||||
Defined in: [types.ts:104](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L104)
|
||||
Defined in: [types.ts:104](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L104)
|
||||
|
||||
Internal record for a single traditional method definition.
|
||||
|
||||
|
|
@ -16,7 +16,7 @@ Internal record for a single traditional method definition.
|
|||
|
||||
> **fajrAngle**: `number` \| `null`
|
||||
|
||||
Defined in: [types.ts:115](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L115)
|
||||
Defined in: [types.ts:115](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L115)
|
||||
|
||||
Fajr depression angle in degrees. Null means the method uses a
|
||||
seasonal calculation (MSC) rather than a fixed angle.
|
||||
|
|
@ -27,7 +27,7 @@ seasonal calculation (MSC) rather than a fixed angle.
|
|||
|
||||
> **id**: `string`
|
||||
|
||||
Defined in: [types.ts:106](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L106)
|
||||
Defined in: [types.ts:106](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L106)
|
||||
|
||||
Short identifier used as the Methods map key.
|
||||
|
||||
|
|
@ -37,7 +37,7 @@ Short identifier used as the Methods map key.
|
|||
|
||||
> **ishaAngle**: `number` \| `null`
|
||||
|
||||
Defined in: [types.ts:120](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L120)
|
||||
Defined in: [types.ts:120](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L120)
|
||||
|
||||
Isha depression angle in degrees. Null means the method uses a
|
||||
fixed-minute offset or seasonal calculation instead.
|
||||
|
|
@ -48,7 +48,7 @@ fixed-minute offset or seasonal calculation instead.
|
|||
|
||||
> `optional` **ishaMinutes?**: `number`
|
||||
|
||||
Defined in: [types.ts:125](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L125)
|
||||
Defined in: [types.ts:125](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L125)
|
||||
|
||||
Fixed minutes after sunset for Isha. Overrides ishaAngle when set.
|
||||
UAQ uses 90 year-round; Qatar uses 90 as well.
|
||||
|
|
@ -59,7 +59,7 @@ UAQ uses 90 year-round; Qatar uses 90 as well.
|
|||
|
||||
> **name**: `string`
|
||||
|
||||
Defined in: [types.ts:108](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L108)
|
||||
Defined in: [types.ts:108](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L108)
|
||||
|
||||
Human-readable name.
|
||||
|
||||
|
|
@ -69,7 +69,7 @@ Human-readable name.
|
|||
|
||||
> **region**: `string`
|
||||
|
||||
Defined in: [types.ts:110](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L110)
|
||||
Defined in: [types.ts:110](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L110)
|
||||
|
||||
Geographic region of primary use.
|
||||
|
||||
|
|
@ -79,7 +79,7 @@ Geographic region of primary use.
|
|||
|
||||
> `optional` **useMSC?**: `boolean`
|
||||
|
||||
Defined in: [types.ts:130](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L130)
|
||||
Defined in: [types.ts:130](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L130)
|
||||
|
||||
When true, the method uses the MSC seasonal algorithm for both
|
||||
Fajr and Isha.
|
||||
|
|
|
|||
22
.github/wiki/api/interfaces/PrayerTimes.md
vendored
22
.github/wiki/api/interfaces/PrayerTimes.md
vendored
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
# Interface: PrayerTimes
|
||||
|
||||
Defined in: [types.ts:26](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L26)
|
||||
Defined in: [types.ts:26](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L26)
|
||||
|
||||
Raw prayer times as fractional hours.
|
||||
|
||||
|
|
@ -20,7 +20,7 @@ Raw prayer times as fractional hours.
|
|||
|
||||
> **angles**: [`TwilightAngles`](TwilightAngles.md)
|
||||
|
||||
Defined in: [types.ts:46](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L46)
|
||||
Defined in: [types.ts:46](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L46)
|
||||
|
||||
Dynamic twilight angles used for this calculation.
|
||||
|
||||
|
|
@ -30,7 +30,7 @@ Dynamic twilight angles used for this calculation.
|
|||
|
||||
> **Asr**: `number`
|
||||
|
||||
Defined in: [types.ts:38](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L38)
|
||||
Defined in: [types.ts:38](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L38)
|
||||
|
||||
Asr (Shafi'i or Hanafi shadow convention).
|
||||
|
||||
|
|
@ -40,7 +40,7 @@ Asr (Shafi'i or Hanafi shadow convention).
|
|||
|
||||
> **Dhuhr**: `number`
|
||||
|
||||
Defined in: [types.ts:36](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L36)
|
||||
Defined in: [types.ts:36](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L36)
|
||||
|
||||
Dhuhr (2.5 minutes after solar noon).
|
||||
|
||||
|
|
@ -50,7 +50,7 @@ Dhuhr (2.5 minutes after solar noon).
|
|||
|
||||
> **Fajr**: `number`
|
||||
|
||||
Defined in: [types.ts:30](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L30)
|
||||
Defined in: [types.ts:30](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L30)
|
||||
|
||||
True dawn (Subh Sadiq).
|
||||
|
||||
|
|
@ -60,7 +60,7 @@ True dawn (Subh Sadiq).
|
|||
|
||||
> **Isha**: `number`
|
||||
|
||||
Defined in: [types.ts:42](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L42)
|
||||
Defined in: [types.ts:42](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L42)
|
||||
|
||||
Isha (nightfall, end of shafaq).
|
||||
|
||||
|
|
@ -70,7 +70,7 @@ Isha (nightfall, end of shafaq).
|
|||
|
||||
> **Maghrib**: `number`
|
||||
|
||||
Defined in: [types.ts:40](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L40)
|
||||
Defined in: [types.ts:40](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L40)
|
||||
|
||||
Maghrib (sunset).
|
||||
|
||||
|
|
@ -80,7 +80,7 @@ Maghrib (sunset).
|
|||
|
||||
> **Midnight**: `number`
|
||||
|
||||
Defined in: [types.ts:44](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L44)
|
||||
Defined in: [types.ts:44](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L44)
|
||||
|
||||
Midnight: midpoint between Maghrib and Fajr.
|
||||
|
||||
|
|
@ -90,7 +90,7 @@ Midnight: midpoint between Maghrib and Fajr.
|
|||
|
||||
> **Noon**: `number`
|
||||
|
||||
Defined in: [types.ts:34](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L34)
|
||||
Defined in: [types.ts:34](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L34)
|
||||
|
||||
Solar noon (exact geometric transit).
|
||||
|
||||
|
|
@ -100,7 +100,7 @@ Solar noon (exact geometric transit).
|
|||
|
||||
> **Qiyam**: `number`
|
||||
|
||||
Defined in: [types.ts:28](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L28)
|
||||
Defined in: [types.ts:28](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L28)
|
||||
|
||||
Start of the last third of the night (Qiyam al-Layl).
|
||||
|
||||
|
|
@ -110,6 +110,6 @@ Start of the last third of the night (Qiyam al-Layl).
|
|||
|
||||
> **Sunrise**: `number`
|
||||
|
||||
Defined in: [types.ts:32](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L32)
|
||||
Defined in: [types.ts:32](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L32)
|
||||
|
||||
Astronomical sunrise.
|
||||
|
|
|
|||
24
.github/wiki/api/interfaces/PrayerTimesAll.md
vendored
24
.github/wiki/api/interfaces/PrayerTimesAll.md
vendored
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
# Interface: PrayerTimesAll
|
||||
|
||||
Defined in: [types.ts:75](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L75)
|
||||
Defined in: [types.ts:75](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L75)
|
||||
|
||||
Prayer times plus all method comparison times as fractional hours.
|
||||
|
||||
|
|
@ -20,7 +20,7 @@ Prayer times plus all method comparison times as fractional hours.
|
|||
|
||||
> **angles**: [`TwilightAngles`](TwilightAngles.md)
|
||||
|
||||
Defined in: [types.ts:46](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L46)
|
||||
Defined in: [types.ts:46](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L46)
|
||||
|
||||
Dynamic twilight angles used for this calculation.
|
||||
|
||||
|
|
@ -34,7 +34,7 @@ Dynamic twilight angles used for this calculation.
|
|||
|
||||
> **Asr**: `number`
|
||||
|
||||
Defined in: [types.ts:38](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L38)
|
||||
Defined in: [types.ts:38](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L38)
|
||||
|
||||
Asr (Shafi'i or Hanafi shadow convention).
|
||||
|
||||
|
|
@ -48,7 +48,7 @@ Asr (Shafi'i or Hanafi shadow convention).
|
|||
|
||||
> **Dhuhr**: `number`
|
||||
|
||||
Defined in: [types.ts:36](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L36)
|
||||
Defined in: [types.ts:36](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L36)
|
||||
|
||||
Dhuhr (2.5 minutes after solar noon).
|
||||
|
||||
|
|
@ -62,7 +62,7 @@ Dhuhr (2.5 minutes after solar noon).
|
|||
|
||||
> **Fajr**: `number`
|
||||
|
||||
Defined in: [types.ts:30](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L30)
|
||||
Defined in: [types.ts:30](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L30)
|
||||
|
||||
True dawn (Subh Sadiq).
|
||||
|
||||
|
|
@ -76,7 +76,7 @@ True dawn (Subh Sadiq).
|
|||
|
||||
> **Isha**: `number`
|
||||
|
||||
Defined in: [types.ts:42](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L42)
|
||||
Defined in: [types.ts:42](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L42)
|
||||
|
||||
Isha (nightfall, end of shafaq).
|
||||
|
||||
|
|
@ -90,7 +90,7 @@ Isha (nightfall, end of shafaq).
|
|||
|
||||
> **Maghrib**: `number`
|
||||
|
||||
Defined in: [types.ts:40](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L40)
|
||||
Defined in: [types.ts:40](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L40)
|
||||
|
||||
Maghrib (sunset).
|
||||
|
||||
|
|
@ -104,7 +104,7 @@ Maghrib (sunset).
|
|||
|
||||
> **Methods**: `Record`\<`string`, [`MethodEntry`](../type-aliases/MethodEntry.md)\>
|
||||
|
||||
Defined in: [types.ts:77](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L77)
|
||||
Defined in: [types.ts:77](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L77)
|
||||
|
||||
Comparison results from all supported fixed-angle and seasonal methods.
|
||||
|
||||
|
|
@ -114,7 +114,7 @@ Comparison results from all supported fixed-angle and seasonal methods.
|
|||
|
||||
> **Midnight**: `number`
|
||||
|
||||
Defined in: [types.ts:44](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L44)
|
||||
Defined in: [types.ts:44](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L44)
|
||||
|
||||
Midnight: midpoint between Maghrib and Fajr.
|
||||
|
||||
|
|
@ -128,7 +128,7 @@ Midnight: midpoint between Maghrib and Fajr.
|
|||
|
||||
> **Noon**: `number`
|
||||
|
||||
Defined in: [types.ts:34](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L34)
|
||||
Defined in: [types.ts:34](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L34)
|
||||
|
||||
Solar noon (exact geometric transit).
|
||||
|
||||
|
|
@ -142,7 +142,7 @@ Solar noon (exact geometric transit).
|
|||
|
||||
> **Qiyam**: `number`
|
||||
|
||||
Defined in: [types.ts:28](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L28)
|
||||
Defined in: [types.ts:28](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L28)
|
||||
|
||||
Start of the last third of the night (Qiyam al-Layl).
|
||||
|
||||
|
|
@ -156,7 +156,7 @@ Start of the last third of the night (Qiyam al-Layl).
|
|||
|
||||
> **Sunrise**: `number`
|
||||
|
||||
Defined in: [types.ts:32](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L32)
|
||||
Defined in: [types.ts:32](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L32)
|
||||
|
||||
Astronomical sunrise.
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
# Interface: TwilightAngles
|
||||
|
||||
Defined in: [types.ts:18](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L18)
|
||||
Defined in: [types.ts:18](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L18)
|
||||
|
||||
Computed twilight depression angles for Fajr and Isha.
|
||||
|
||||
|
|
@ -16,7 +16,7 @@ Computed twilight depression angles for Fajr and Isha.
|
|||
|
||||
> **fajrAngle**: `number`
|
||||
|
||||
Defined in: [types.ts:20](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L20)
|
||||
Defined in: [types.ts:20](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L20)
|
||||
|
||||
Solar depression angle for Fajr (positive degrees below horizon).
|
||||
|
||||
|
|
@ -26,6 +26,6 @@ Solar depression angle for Fajr (positive degrees below horizon).
|
|||
|
||||
> **ishaAngle**: `number`
|
||||
|
||||
Defined in: [types.ts:22](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L22)
|
||||
Defined in: [types.ts:22](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L22)
|
||||
|
||||
Solar depression angle for Isha (positive degrees below horizon).
|
||||
|
|
|
|||
|
|
@ -8,6 +8,6 @@
|
|||
|
||||
> **AsrConvention** = `"shafii"` \| `"hanafi"`
|
||||
|
||||
Defined in: [types.ts:12](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L12)
|
||||
Defined in: [types.ts:12](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L12)
|
||||
|
||||
Asr shadow convention: Shafi'i (shadow = 1x object length) or Hanafi (2x).
|
||||
|
|
|
|||
|
|
@ -8,6 +8,6 @@
|
|||
|
||||
> **FractionalHours** = `number`
|
||||
|
||||
Defined in: [types.ts:6](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L6)
|
||||
Defined in: [types.ts:6](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L6)
|
||||
|
||||
Fractional hours (e.g. 5.5 = 05:30:00). NaN indicates an unreachable event.
|
||||
|
|
|
|||
2
.github/wiki/api/type-aliases/MethodEntry.md
vendored
2
.github/wiki/api/type-aliases/MethodEntry.md
vendored
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
> **MethodEntry** = \[[`FractionalHours`](FractionalHours.md), [`FractionalHours`](FractionalHours.md)\]
|
||||
|
||||
Defined in: [types.ts:72](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L72)
|
||||
Defined in: [types.ts:72](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L72)
|
||||
|
||||
Method entry in the Methods map: `[fajrTime, ishaTime]` as fractional hours.
|
||||
|
||||
|
|
|
|||
2
.github/wiki/api/type-aliases/ShafaqMode.md
vendored
2
.github/wiki/api/type-aliases/ShafaqMode.md
vendored
|
|
@ -8,6 +8,6 @@
|
|||
|
||||
> **ShafaqMode** = `"general"` \| `"ahmer"` \| `"abyad"`
|
||||
|
||||
Defined in: [types.ts:15](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L15)
|
||||
Defined in: [types.ts:15](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L15)
|
||||
|
||||
Shafaq (twilight glow) variant for the MSC Isha model.
|
||||
|
|
|
|||
2
.github/wiki/api/type-aliases/TimeString.md
vendored
2
.github/wiki/api/type-aliases/TimeString.md
vendored
|
|
@ -8,6 +8,6 @@
|
|||
|
||||
> **TimeString** = `string`
|
||||
|
||||
Defined in: [types.ts:9](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/types.ts#L9)
|
||||
Defined in: [types.ts:9](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/types.ts#L9)
|
||||
|
||||
HH:MM:SS string produced by formatTime, or "N/A" when unreachable.
|
||||
|
|
|
|||
2
.github/wiki/api/variables/ANGLE_MAX.md
vendored
2
.github/wiki/api/variables/ANGLE_MAX.md
vendored
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
> `const` **ANGLE\_MAX**: `22` = `22`
|
||||
|
||||
Defined in: [constants.ts:35](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/constants.ts#L35)
|
||||
Defined in: [constants.ts:35](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/constants.ts#L35)
|
||||
|
||||
Maximum allowed dynamic twilight depression angle (degrees).
|
||||
|
||||
|
|
|
|||
2
.github/wiki/api/variables/ANGLE_MIN.md
vendored
2
.github/wiki/api/variables/ANGLE_MIN.md
vendored
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
> `const` **ANGLE\_MIN**: `10` = `10`
|
||||
|
||||
Defined in: [constants.ts:26](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/constants.ts#L26)
|
||||
Defined in: [constants.ts:26](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/constants.ts#L26)
|
||||
|
||||
Minimum allowed dynamic twilight depression angle (degrees).
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
> `const` **DHUHR\_OFFSET\_MINUTES**: `2.5` = `2.5`
|
||||
|
||||
Defined in: [constants.ts:17](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/constants.ts#L17)
|
||||
Defined in: [constants.ts:17](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/constants.ts#L17)
|
||||
|
||||
Minutes added to solar noon to obtain Dhuhr time.
|
||||
|
||||
|
|
|
|||
2
.github/wiki/api/variables/METHODS.md
vendored
2
.github/wiki/api/variables/METHODS.md
vendored
|
|
@ -8,6 +8,6 @@
|
|||
|
||||
> `const` **METHODS**: [`MethodDefinition`](../interfaces/MethodDefinition.md)[]
|
||||
|
||||
Defined in: [getTimesAll.ts:38](https://github.com/acamarata/pray-calc/blob/af34aef986c37d8de9cf8db0744a41e3b0c99c40/src/getTimesAll.ts#L38)
|
||||
Defined in: [getTimesAll.ts:38](https://github.com/acamarata/pray-calc/blob/4227afc2c3993234794b3a1a561c080edc6d4d4e/src/getTimesAll.ts#L38)
|
||||
|
||||
All supported traditional methods.
|
||||
|
|
|
|||
Loading…
Reference in a new issue