Skip to content

Commit

Permalink
docs(calculation parameters): add rounding param
Browse files Browse the repository at this point in the history
Added the `rounding` param to the list values
that can be modified for a CalculationParameters
object.
  • Loading branch information
z3bi committed Dec 30, 2021
1 parent b33f265 commit f372df5
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions METHODS.md
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

0 comments on commit f372df5

Please sign in to comment.