Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(calculation parameters): add rounding param #86

Merged
merged 1 commit into from
Dec 30, 2021
Merged

docs(calculation parameters): add rounding param #86

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions METHODS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,17 @@ params.adjustments.fajr = 2;

| Property | Description |
| --------- | ----------- |
| method | CalculationMethod name |
| fajrAngle | Angle of the sun used to calculate Fajr |
| maghribAngle | Angle of the sun used to calculate Maghrib (this is used by the Tehran method) |
| ishaAngle | Angle of the sun used to calculate Isha |
| ishaInterval | Minutes after Maghrib (if set, the time for Isha will be Maghrib plus ishaInterval) |
| madhab | Value from the Madhab object, used to calculate Asr |
| highLatitudeRule | Value from the HighLatitudeRule object, used to set a minimum time for Fajr and a max time for Isha |
| adjustments | Object with custom prayer time adjustments (in minutes) for each prayer time |
| polarCircleResolution | Value from the PolarCircleResolution object, strategy used to resolve undefined prayer times for areas located in polar circles |
| shafaq | Used by the MoonsightingCommittee method to determine how to calculate Isha. See explanation of values below. |
| method | CalculationMethod name. |
| fajrAngle | Angle of the sun used to calculate Fajr. |
| maghribAngle | Angle of the sun used to calculate Maghrib (this is used by the Tehran method). |
| ishaAngle | Angle of the sun used to calculate Isha. |
| ishaInterval | Minutes after Maghrib (if set, the time for Isha will be Maghrib plus ishaInterval). |
| madhab | Value from the Madhab object, used to calculate Asr. `Shafi` is the default value. |
| highLatitudeRule | Value from the HighLatitudeRule object, used to set a minimum time for Fajr and a max time for Isha. |
| adjustments | Object with custom prayer time adjustments (in minutes) for each prayer time. |
| rounding | The behavior for rounding prayer times. Either to nearest minute, to the higher minute, or none. `Nearest` is the default value. |
| polarCircleResolution | Value from the PolarCircleResolution object, strategy used to resolve undefined prayer times for areas located in polar circles. `Unresolved` is the default value. |
| shafaq | Used by the MoonsightingCommittee method to determine how to calculate Isha. See explanation of values below. `General` is the default value. |

#### CalculationMethod

Expand Down