@hebcal/core 5.3.9 → 5.3.11

package/README.md

@@ -1998,6 +1998,7 @@ Enables or disables elevation adjustment for zmanim support elevation adjustment
 ### zmanim.timeAtAngle(angle, rising) ⇒ <code>Date</code>
 Convenience function to get the time when sun is above or below the horizon
 for a certain angle (in degrees).
+This function does not support elevation adjustment.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 
@@ -2010,41 +2011,52 @@ for a certain angle (in degrees).
 
 ### zmanim.sunrise() ⇒ <code>Date</code>
 Upper edge of the Sun appears over the eastern horizon in the morning (0.833° above horizon)
+If elevation is enabled, this function will include elevation in the calculation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+seaLevelSunrise"></a>
 
 ### zmanim.seaLevelSunrise() ⇒ <code>Date</code>
-Upper edge of the Sun appears over the eastern horizon in the morning (0.833° above horizon)
+Upper edge of the Sun appears over the eastern horizon in the morning (0.833° above horizon).
+This function does not support elevation adjustment.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+sunset"></a>
 
 ### zmanim.sunset() ⇒ <code>Date</code>
-When the upper edge of the Sun disappears below the horizon (0.833° below horizon)
+When the upper edge of the Sun disappears below the horizon (0.833° below horizon).
+If elevation is enabled, this function will include elevation in the calculation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+seaLevelSunset"></a>
 
 ### zmanim.seaLevelSunset() ⇒ <code>Date</code>
-When the upper edge of the Sun disappears below the horizon (0.833° below horizon)
+When the upper edge of the Sun disappears below the horizon (0.833° below horizon).
+This function does not support elevation adjustment.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+dawn"></a>
 
 ### zmanim.dawn() ⇒ <code>Date</code>
-Civil dawn; Sun is 6° below the horizon in the morning
+Civil dawn; Sun is 6° below the horizon in the morning.
+Because degree-based functions estimate the amount of light in the sky,
+the result is not impacted by elevation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+dusk"></a>
 
 ### zmanim.dusk() ⇒ <code>Date</code>
-Civil dusk; Sun is 6° below the horizon in the evening
+Civil dusk; Sun is 6° below the horizon in the evening.
+Because degree-based functions estimate the amount of light in the sky,
+the result is not impacted by elevation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+gregEve"></a>
 
 ### zmanim.gregEve() ⇒ <code>Date</code>
+Returns sunset for the previous day.
+If elevation is enabled, this function will include elevation in the calculation.
+
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+chatzot"></a>
 
@@ -2055,37 +2067,46 @@ Midday – Chatzot; Sunrise plus 6 halachic hours
 <a name="Zmanim+chatzotNight"></a>
 
 ### zmanim.chatzotNight() ⇒ <code>Date</code>
-Midnight – Chatzot; Sunset plus 6 halachic hours
+Midnight – Chatzot; Sunset plus 6 halachic hours.
+If elevation is enabled, this function will include elevation in the calculation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+alotHaShachar"></a>
 
 ### zmanim.alotHaShachar() ⇒ <code>Date</code>
-Dawn – Alot haShachar; Sun is 16.1° below the horizon in the morning
+Dawn – Alot haShachar; Sun is 16.1° below the horizon in the morning.
+Because degree-based functions estimate the amount of light in the sky,
+the result is not impacted by elevation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+misheyakir"></a>
 
 ### zmanim.misheyakir() ⇒ <code>Date</code>
-Earliest talis & tefillin – Misheyakir; Sun is 11.5° below the horizon in the morning
+Earliest talis & tefillin – Misheyakir; Sun is 11.5° below the horizon in the morning.
+Because degree-based functions estimate the amount of light in the sky,
+the result is not impacted by elevation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+misheyakirMachmir"></a>
 
 ### zmanim.misheyakirMachmir() ⇒ <code>Date</code>
-Earliest talis & tefillin – Misheyakir Machmir; Sun is 10.2° below the horizon in the morning
+Earliest talis & tefillin – Misheyakir Machmir; Sun is 10.2° below the horizon in the morning.
+Because degree-based functions estimate the amount of light in the sky,
+the result is not impacted by elevation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+sofZmanShma"></a>
 
 ### zmanim.sofZmanShma() ⇒ <code>Date</code>
-Latest Shema (Gra); Sunrise plus 3 halachic hours, according to the Gra
+Latest Shema (Gra); Sunrise plus 3 halachic hours, according to the Gra.
+If elevation is enabled, this function will include elevation in the calculation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+sofZmanTfilla"></a>
 
 ### zmanim.sofZmanTfilla() ⇒ <code>Date</code>
-Latest Shacharit (Gra); Sunrise plus 4 halachic hours, according to the Gra
+Latest Shacharit (Gra); Sunrise plus 4 halachic hours, according to the Gra.
+If elevation is enabled, this function will include elevation in the calculation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+sofZmanShmaMGA"></a>
@@ -2146,19 +2167,22 @@ https://kosherjava.com/2022/01/12/equinox-vs-equilux-zmanim-calculations/
 <a name="Zmanim+minchaGedola"></a>
 
 ### zmanim.minchaGedola() ⇒ <code>Date</code>
-Earliest Mincha – Mincha Gedola; Sunrise plus 6.5 halachic hours
+Earliest Mincha – Mincha Gedola; Sunrise plus 6.5 halachic hours.
+If elevation is enabled, this function will include elevation in the calculation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+minchaKetana"></a>
 
 ### zmanim.minchaKetana() ⇒ <code>Date</code>
-Preferable earliest time to recite Minchah – Mincha Ketana; Sunrise plus 9.5 halachic hours
+Preferable earliest time to recite Minchah – Mincha Ketana; Sunrise plus 9.5 halachic hours.
+If elevation is enabled, this function will include elevation in the calculation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+plagHaMincha"></a>
 
 ### zmanim.plagHaMincha() ⇒ <code>Date</code>
-Plag haMincha; Sunrise plus 10.75 halachic hours
+Plag haMincha; Sunrise plus 10.75 halachic hours.
+If elevation is enabled, this function will include elevation in the calculation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+tzeit"></a>
@@ -2168,7 +2192,7 @@ Plag haMincha; Sunrise plus 10.75 halachic hours
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| [angle] | <code>number</code> | <code>8.5</code> | optional time for solar depression.   Default is 8.5 degrees for 3 small stars, use 7.083 degrees for 3 medium-sized stars. |
+| [angle] | <code>number</code> | <code>8.5</code> | optional time for solar depression.   Default is 8.5 degrees for 3 small stars, use 7.083 degrees for 3 medium-sized stars. Because degree-based functions estimate the amount of light in the sky, the result is not impacted by elevation. |
 
 <a name="Zmanim+neitzHaChama"></a>
 
@@ -2188,13 +2212,17 @@ Alias for sunset
 Rabbeinu Tam holds that bein hashmashos is a specific time
 between sunset and tzeis hakochavim.
 One opinion on how to calculate this time is that
-it is 13.5 minutes before tzies 7.083
+it is 13.5 minutes before tzies 7.083.
+Because degree-based functions estimate the amount of light in the sky,
+the result is not impacted by elevation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+sunriseOffset"></a>
 
 ### zmanim.sunriseOffset(offset, roundMinute, forceSeaLevel) ⇒ <code>Date</code>
 Returns sunrise + `offset` minutes (either positive or negative).
+If elevation is enabled, this function will include elevation in the calculation
+ unless `forceSeaLevel` is `true`.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 
@@ -2208,6 +2236,8 @@ Returns sunrise + `offset` minutes (either positive or negative).
 
 ### zmanim.sunsetOffset(offset, roundMinute, forceSeaLevel) ⇒ <code>Date</code>
 Returns sunset + `offset` minutes (either positive or negative).
+If elevation is enabled, this function will include elevation in the calculation
+ unless `forceSeaLevel` is `true`.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 
@@ -3336,6 +3366,92 @@ Holiday flags for Event
 | NACH_YOMI | <code>number</code> | <code>33554432</code> | Nach Yomi |
 | DAILY_LEARNING | <code>number</code> | <code>67108864</code> | Daily Learning |
 
+<a name="holidayDesc"></a>
+
+## holidayDesc : <code>enum</code>
+Transliterated names of holidays, used by `Event.getDesc()`
+
+**Kind**: global enum  
+**Read only**: true  
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| ASARA_BTEVET | <code>string</code> | <code>&quot;Asara B&#x27;Tevet&quot;</code> | Asara B'Tevet |
+| BIRKAT_HACHAMAH | <code>string</code> | <code>&quot;Birkat Hachamah&quot;</code> | Birkat Hachamah |
+| CHAG_HABANOT | <code>string</code> | <code>&quot;Chag HaBanot&quot;</code> | Chag HaBanot |
+| CHANUKAH_8TH_DAY | <code>string</code> | <code>&quot;Chanukah: 8th Day&quot;</code> | Chanukah: 8th Day |
+| EREV_TISHA_BAV | <code>string</code> | <code>&quot;Erev Tish&#x27;a B&#x27;Av&quot;</code> | Erev Tish'a B'Av |
+| LEIL_SELICHOT | <code>string</code> | <code>&quot;Leil Selichot&quot;</code> | Leil Selichot |
+| PURIM_KATAN | <code>string</code> | <code>&quot;Purim Katan&quot;</code> | Purim Katan |
+| PURIM_MESHULASH | <code>string</code> | <code>&quot;Purim Meshulash&quot;</code> | Purim Meshulash |
+| SHABBAT_CHAZON | <code>string</code> | <code>&quot;Shabbat Chazon&quot;</code> | Shabbat Chazon |
+| SHABBAT_HACHODESH | <code>string</code> | <code>&quot;Shabbat HaChodesh&quot;</code> | Shabbat HaChodesh |
+| SHABBAT_HAGADOL | <code>string</code> | <code>&quot;Shabbat HaGadol&quot;</code> | Shabbat HaGadol |
+| SHABBAT_NACHAMU | <code>string</code> | <code>&quot;Shabbat Nachamu&quot;</code> | Shabbat Nachamu |
+| SHABBAT_PARAH | <code>string</code> | <code>&quot;Shabbat Parah&quot;</code> | Shabbat Parah |
+| SHABBAT_SHEKALIM | <code>string</code> | <code>&quot;Shabbat Shekalim&quot;</code> | Shabbat Shekalim |
+| SHABBAT_SHIRAH | <code>string</code> | <code>&quot;Shabbat Shirah&quot;</code> | Shabbat Shirah |
+| SHABBAT_SHUVA | <code>string</code> | <code>&quot;Shabbat Shuva&quot;</code> | Shabbat Shuva |
+| SHABBAT_ZACHOR | <code>string</code> | <code>&quot;Shabbat Zachor&quot;</code> | Shabbat Zachor |
+| SHUSHAN_PURIM_KATAN | <code>string</code> | <code>&quot;Shushan Purim Katan&quot;</code> | Shushan Purim Katan |
+| TAANIT_BECHOROT | <code>string</code> | <code>&quot;Ta&#x27;anit Bechorot&quot;</code> | Ta'anit Bechorot |
+| TAANIT_ESTHER | <code>string</code> | <code>&quot;Ta&#x27;anit Esther&quot;</code> | Ta'anit Esther |
+| TISHA_BAV | <code>string</code> | <code>&quot;Tish&#x27;a B&#x27;Av&quot;</code> | Tish'a B'Av |
+| TZOM_GEDALIAH | <code>string</code> | <code>&quot;Tzom Gedaliah&quot;</code> | Tzom Gedaliah |
+| TZOM_TAMMUZ | <code>string</code> | <code>&quot;Tzom Tammuz&quot;</code> | Tzom Tammuz |
+| YOM_HAATZMA_UT | <code>string</code> | <code>&quot;Yom HaAtzma&#x27;ut&quot;</code> | Yom HaAtzma'ut |
+| YOM_HASHOAH | <code>string</code> | <code>&quot;Yom HaShoah&quot;</code> | Yom HaShoah |
+| YOM_HAZIKARON | <code>string</code> | <code>&quot;Yom HaZikaron&quot;</code> | Yom HaZikaron |
+| BEN_GURION_DAY | <code>string</code> | <code>&quot;BEN_GURION_DAY&quot;</code> | Ben-Gurion Day |
+| CHANUKAH_1_CANDLE | <code>string</code> | <code>&quot;CHANUKAH_1_CANDLE&quot;</code> | Chanukah: 1 Candle |
+| EREV_PESACH | <code>string</code> | <code>&quot;EREV_PESACH&quot;</code> | Erev Pesach |
+| EREV_PURIM | <code>string</code> | <code>&quot;EREV_PURIM&quot;</code> | Erev Purim |
+| EREV_ROSH_HASHANA | <code>string</code> | <code>&quot;EREV_ROSH_HASHANA&quot;</code> | Erev Rosh Hashana |
+| EREV_SHAVUOT | <code>string</code> | <code>&quot;EREV_SHAVUOT&quot;</code> | Erev Shavuot |
+| EREV_SUKKOT | <code>string</code> | <code>&quot;EREV_SUKKOT&quot;</code> | Erev Sukkot |
+| EREV_YOM_KIPPUR | <code>string</code> | <code>&quot;EREV_YOM_KIPPUR&quot;</code> | Erev Yom Kippur |
+| FAMILY_DAY | <code>string</code> | <code>&quot;FAMILY_DAY&quot;</code> | Family Day |
+| HEBREW_LANGUAGE_DAY | <code>string</code> | <code>&quot;HEBREW_LANGUAGE_DAY&quot;</code> | Hebrew Language Day |
+| HERZL_DAY | <code>string</code> | <code>&quot;HERZL_DAY&quot;</code> | Herzl Day |
+| JABOTINSKY_DAY | <code>string</code> | <code>&quot;JABOTINSKY_DAY&quot;</code> | Jabotinsky Day |
+| LAG_BAOMER | <code>string</code> | <code>&quot;LAG_BAOMER&quot;</code> | Lag BaOmer |
+| PESACH_I | <code>string</code> | <code>&quot;PESACH_I&quot;</code> | Pesach I |
+| PESACH_II | <code>string</code> | <code>&quot;PESACH_II&quot;</code> | Pesach II |
+| PESACH_III_CHM | <code>string</code> | <code>&quot;PESACH_III_CHM&quot;</code> | Pesach III (CH''M) |
+| PESACH_II_CHM | <code>string</code> | <code>&quot;PESACH_II_CHM&quot;</code> | Pesach II (CH''M) |
+| PESACH_IV_CHM | <code>string</code> | <code>&quot;PESACH_IV_CHM&quot;</code> | Pesach IV (CH''M) |
+| PESACH_SHENI | <code>string</code> | <code>&quot;PESACH_SHENI&quot;</code> | Pesach Sheni |
+| PESACH_VII | <code>string</code> | <code>&quot;PESACH_VII&quot;</code> | Pesach VII |
+| PESACH_VIII | <code>string</code> | <code>&quot;PESACH_VIII&quot;</code> | Pesach VIII |
+| PESACH_VI_CHM | <code>string</code> | <code>&quot;PESACH_VI_CHM&quot;</code> | Pesach VI (CH''M) |
+| PESACH_V_CHM | <code>string</code> | <code>&quot;PESACH_V_CHM&quot;</code> | Pesach V (CH''M) |
+| PURIM | <code>string</code> | <code>&quot;PURIM&quot;</code> | Purim |
+| ROSH_HASHANA_II | <code>string</code> | <code>&quot;ROSH_HASHANA_II&quot;</code> | Rosh Hashana II |
+| ROSH_HASHANA_LABEHEMOT | <code>string</code> | <code>&quot;ROSH_HASHANA_LABEHEMOT&quot;</code> | Rosh Hashana LaBehemot |
+| SHAVUOT | <code>string</code> | <code>&quot;SHAVUOT&quot;</code> | Shavuot |
+| SHAVUOT_I | <code>string</code> | <code>&quot;SHAVUOT_I&quot;</code> | Shavuot I |
+| SHAVUOT_II | <code>string</code> | <code>&quot;SHAVUOT_II&quot;</code> | Shavuot II |
+| SHMINI_ATZERET | <code>string</code> | <code>&quot;SHMINI_ATZERET&quot;</code> | Shmini Atzeret |
+| SHUSHAN_PURIM | <code>string</code> | <code>&quot;SHUSHAN_PURIM&quot;</code> | Shushan Purim |
+| SIGD | <code>string</code> | <code>&quot;SIGD&quot;</code> | Sigd |
+| SIMCHAT_TORAH | <code>string</code> | <code>&quot;SIMCHAT_TORAH&quot;</code> | Simchat Torah |
+| SUKKOT_I | <code>string</code> | <code>&quot;SUKKOT_I&quot;</code> | Sukkot I |
+| SUKKOT_II | <code>string</code> | <code>&quot;SUKKOT_II&quot;</code> | Sukkot II |
+| SUKKOT_III_CHM | <code>string</code> | <code>&quot;SUKKOT_III_CHM&quot;</code> | Sukkot III (CH''M) |
+| SUKKOT_II_CHM | <code>string</code> | <code>&quot;SUKKOT_II_CHM&quot;</code> | Sukkot II (CH''M) |
+| SUKKOT_IV_CHM | <code>string</code> | <code>&quot;SUKKOT_IV_CHM&quot;</code> | Sukkot IV (CH''M) |
+| SUKKOT_VII_HOSHANA_RABA | <code>string</code> | <code>&quot;SUKKOT_VII_HOSHANA_RABA&quot;</code> | Sukkot VII (Hoshana Raba) |
+| SUKKOT_VI_CHM | <code>string</code> | <code>&quot;SUKKOT_VI_CHM&quot;</code> | Sukkot VI (CH''M) |
+| SUKKOT_V_CHM | <code>string</code> | <code>&quot;SUKKOT_V_CHM&quot;</code> | Sukkot V (CH''M) |
+| TU_BAV | <code>string</code> | <code>&quot;TU_BAV&quot;</code> | Tu B\'Av |
+| TU_BISHVAT | <code>string</code> | <code>&quot;TU_BISHVAT&quot;</code> | Tu BiShvat |
+| YITZHAK_RABIN_MEMORIAL_DAY | <code>string</code> | <code>&quot;YITZHAK_RABIN_MEMORIAL_DAY&quot;</code> | Yitzhak Rabin Memorial Day |
+| YOM_HAALIYAH | <code>string</code> | <code>&quot;YOM_HAALIYAH&quot;</code> | Yom HaAliyah |
+| YOM_HAALIYAH_SCHOOL_OBSERVANCE | <code>string</code> | <code>&quot;YOM_HAALIYAH_SCHOOL_OBSERVANCE&quot;</code> | Yom HaAliyah School Observance |
+| YOM_KIPPUR | <code>string</code> | <code>&quot;YOM_KIPPUR&quot;</code> | Yom Kippur |
+| YOM_YERUSHALAYIM | <code>string</code> | <code>&quot;YOM_YERUSHALAYIM&quot;</code> | Yom Yerushalayim |
+
 <a name="parshiot"></a>
 
 ## parshiot : <code>Array.&lt;string&gt;</code>