From f372df58d20e05dc047a5354fee3d779fed4ef86 Mon Sep 17 00:00:00 2001 From: Ameir Al-Zoubi Date: Thu, 30 Dec 2021 12:02:13 -0500 Subject: [PATCH] docs(calculation parameters): add rounding param Added the `rounding` param to the list values that can be modified for a CalculationParameters object. --- METHODS.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/METHODS.md b/METHODS.md index 4f9f45f..60d8ab3 100644 --- a/METHODS.md +++ b/METHODS.md @@ -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