@hebcal/core 3.45.5 → 3.46.0

package/README.md

@@ -1,17 +1,19 @@
 # @hebcal/core
-Hebcal is a perpetual Jewish Calendar. This library converts between Hebrew and Gregorian
-dates, and generates lists of Jewish holidays for any year (past, present or future).
-Shabbat and holiday candle lighting and havdalah times are approximated based on
-location. Torah readings (Parashat HaShavua), Daf Yomi, and counting of the Omer can
-also be specified. Hebcal also includes algorithms to calculate yahrzeits,
-birthdays and anniversaries.
+Hebcal is a perpetual Jewish Calendar. This library converts between
+Hebrew and Gregorian dates, and generates lists of Jewish holidays for
+any year (past, present or future).  Shabbat and holiday candle
+lighting and havdalah times are approximated based on location. Torah
+readings (Parashat HaShavua), Daf Yomi, and counting of the Omer can
+also be specified. Hebcal also includes algorithms to calculate
+yahrzeits, birthdays and anniversaries.
 
 [![Build Status](https://github.com/hebcal/hebcal-es6/actions/workflows/node.js.yml/badge.svg)](https://github.com/hebcal/hebcal-es6/actions/workflows/node.js.yml)
 
-Hebcal was created in 1994 by Danny Sadinoff as a Unix/Linux program written in C, inspired
-by similar functionality written in Emacs Lisp. The initial JavaScript port was released in
-2014 by Eyal Schachter (age 15). This ECMAScript 2015 implementation was released in 2020
-by Michael J. Radwin. `@hebcal/core` targets both
+Hebcal was created in 1994 by Danny Sadinoff as a Unix/Linux program
+written in C, inspired by similar functionality written in Emacs
+Lisp. The initial JavaScript port was released in 2014 by Eyal
+Schachter (age 15). This ECMAScript 2015 implementation was released
+in 2020 by Michael J. Radwin. `@hebcal/core` targets both
 browser-based JavaScript and server-side Node.js.
 
 Many users of this library will utilize the [HebrewCalendar](#HebrewCalendar)
@@ -124,6 +126,9 @@ each day in order to finish the entire Mishnah in ~6 years.</p>
 <dt><a href="#MishnaYomiEvent">MishnaYomiEvent</a></dt>
 <dd><p>Event wrapper around a Mishna Yomi instance</p>
 </dd>
+<dt><a href="#YerushalmiYomiEvent">YerushalmiYomiEvent</a></dt>
+<dd><p>Event wrapper around a Yerushalmi Yomi result</p>
+</dd>
 <dt><a href="#HebrewCalendar">HebrewCalendar</a></dt>
 <dd><p>HebrewCalendar is the main interface to the <code>@hebcal/core</code> library.
 This namespace is used to calculate holidays, rosh chodesh, candle lighting &amp; havdalah times,
@@ -149,6 +154,19 @@ parshiot[0] == &#39;Bereshit&#39;, parshiot[1] == &#39;Noach&#39;, parshiot[53]
 <p>When specifying years of the Hebrew calendar in the present millennium,
 we omit the thousands (which is presently 5 [ה]).</p>
 </dd>
+<dt><a href="#yerushalmiYomi">yerushalmiYomi(date, config)</a> ⇒ <code>any</code></dt>
+<dd><p>Using the Vilna edition, the Yerushalmi Daf Yomi program takes
+~4.25 years or 51 months.
+Unlike the Daf Yomi Bavli cycle, this Yerushalmi cycle skips both
+Yom Kippur and Tisha B&#39;Av (returning <code>null</code>).
+The page numbers are according to the Vilna
+Edition which is used since 1900.</p>
+<p>The Schottenstein edition uses different page numbers and takes
+~6 years to complete.</p>
+<p>Throws an exception if the date is before Daf Yomi Yerushalmi
+cycle began (2 February 1980 for Vilna,
+14 November 2022 for Schottenstein).</p>
+</dd>
 </dl>
 
 ## Typedefs
@@ -2371,6 +2389,37 @@ Returns Mishna Yomi name (e.g. "Bava Metzia 10:5-6" or "Berakhot 9:5-Peah 1:1").
 Returns a link to sefaria.org
 
 **Kind**: instance method of [<code>MishnaYomiEvent</code>](#MishnaYomiEvent)  
+<a name="YerushalmiYomiEvent"></a>
+
+## YerushalmiYomiEvent
+Event wrapper around a Yerushalmi Yomi result
+
+**Kind**: global class  
+
+* [YerushalmiYomiEvent](#YerushalmiYomiEvent)
+    * [new YerushalmiYomiEvent(date, daf)](#new_YerushalmiYomiEvent_new)
+    * [.render([locale])](#YerushalmiYomiEvent+render) ⇒ <code>string</code>
+
+<a name="new_YerushalmiYomiEvent_new"></a>
+
+### new YerushalmiYomiEvent(date, daf)
+
+| Param | Type |
+| --- | --- |
+| date | [<code>HDate</code>](#HDate) | 
+| daf | <code>any</code> | 
+
+<a name="YerushalmiYomiEvent+render"></a>
+
+### yerushalmiYomiEvent.render([locale]) ⇒ <code>string</code>
+Returns name of tractate and page (e.g. "Yerushalmi Beitzah 21").
+
+**Kind**: instance method of [<code>YerushalmiYomiEvent</code>](#YerushalmiYomiEvent)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
+
 <a name="HebrewCalendar"></a>
 
 ## HebrewCalendar
@@ -2427,7 +2476,8 @@ Set `options.il=true` to use the Israeli schedule.
 Additional non-default event types can be specified:
 * Parashat HaShavua - weekly Torah Reading on Saturdays (`options.sedrot`)
 * Counting of the Omer (`options.omer`)
-* Daf Yomi (`options.dafyomi`)
+* Babylonian Talmud Daf Yomi (`options.dafyomi`)
+* Jerusalem Talmud (Yerushalmi) Yomi (`options.yerushalmi`)
 * Mishna Yomi (`options.mishnaYomi`)
 * Shabbat Mevarchim HaChodesh on Saturday before Rosh Chodesh (`options.shabbatMevarchim`)
 * Molad announcement on Saturday before Rosh Chodesh (`options.molad`)
@@ -2442,7 +2492,8 @@ the times are guaranteed to be wrong.
 
 To add candle-lighting options, set `options.candlelighting=true` and set
 `options.location` to an instance of `Location`. By default, candle lighting
-time is 18 minutes before sundown (40 minutes for Jerusalem, 30 minutes for Haifa and Zikhron Ya'akov) and Havdalah is
+time is 18 minutes before sundown (40 minutes for Jerusalem,
+30 minutes for Haifa and Zikhron Ya'akov) and Havdalah is
 calculated according to Tzeit Hakochavim - Nightfall (the point when 3 small stars
 are observable in the night time sky with the naked eye). The default Havdalah
 option (Tzeit Hakochavim) is calculated when the sun is 8.5° below the horizon.
@@ -2746,7 +2797,7 @@ Holiday flags for Event
 | MINOR_FAST | <code>number</code> | <code>256</code> | Minor fasts like Tzom Tammuz, Ta'anit Esther, ... |
 | SPECIAL_SHABBAT | <code>number</code> | <code>512</code> | Shabbat Shekalim, Zachor, ... |
 | PARSHA_HASHAVUA | <code>number</code> | <code>1024</code> | Weekly sedrot on Saturdays |
-| DAF_YOMI | <code>number</code> | <code>2048</code> | Daily page of Talmud |
+| DAF_YOMI | <code>number</code> | <code>2048</code> | Daily page of Talmud (Bavli) |
 | OMER_COUNT | <code>number</code> | <code>4096</code> | Days of the Omer |
 | MODERN_HOLIDAY | <code>number</code> | <code>8192</code> | Yom HaShoah, Yom HaAtzma'ut, ... |
 | MAJOR_FAST | <code>number</code> | <code>16384</code> | Yom Kippur and Tish'a B'Av |
@@ -2759,6 +2810,7 @@ Holiday flags for Event
 | CHOL_HAMOED | <code>number</code> | <code>2097152</code> | Chol haMoed, intermediate days of Pesach or Sukkot |
 | MISHNA_YOMI | <code>number</code> | <code>4194304</code> | Mishna Yomi |
 | YOM_KIPPUR_KATAN | <code>number</code> | <code>8388608</code> | Yom Kippur Katan, minor day of atonement on the day preceeding each Rosh Chodesh |
+| YERUSHALMI_YOMI | <code>number</code> | <code>16777216</code> | Daily page of Jerusalem Talmud (Yerushalmi) |
 
 <a name="parshiot"></a>
 
@@ -2790,6 +2842,30 @@ gematriya(60) // 'ס׳'
 gematriya(3761) // 'ג׳תשס״א'
 gematriya(1123) // 'א׳קכ״ג'
 ```
+<a name="yerushalmiYomi"></a>
+
+## yerushalmiYomi(date, config) ⇒ <code>any</code>
+Using the Vilna edition, the Yerushalmi Daf Yomi program takes
+~4.25 years or 51 months.
+Unlike the Daf Yomi Bavli cycle, this Yerushalmi cycle skips both
+Yom Kippur and Tisha B'Av (returning `null`).
+The page numbers are according to the Vilna
+Edition which is used since 1900.
+
+The Schottenstein edition uses different page numbers and takes
+~6 years to complete.
+
+Throws an exception if the date is before Daf Yomi Yerushalmi
+cycle began (2 February 1980 for Vilna,
+14 November 2022 for Schottenstein).
+
+**Kind**: global function  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| date | [<code>HDate</code>](#HDate) \| <code>Date</code> \| <code>number</code> | Hebrew or Gregorian date |
+| config | <code>any</code> | either vilna or schottenstein |
+
 <a name="ZmanimTimesResult"></a>
 
 ## ZmanimTimesResult : <code>Object</code>
@@ -2872,7 +2948,9 @@ Options to configure which events are returned
 | shabbatMevarchim | <code>boolean</code> | add Shabbat Mevarchim |
 | noSpecialShabbat | <code>boolean</code> | suppress Special Shabbat |
 | noHolidays | <code>boolean</code> | suppress regular holidays |
-| dafyomi | <code>boolean</code> | include Daf Yomi |
+| dafyomi | <code>boolean</code> | Babylonian Talmud Daf Yomi |
+| yerushalmi | <code>boolean</code> | Jerusalem Talmud (Yerushalmi) Yomi |
+| yerushalmiEdition | <code>number</code> | Use 1 for Vilna, 2 for Schottenstein |
 | mishnaYomi | <code>boolean</code> | include Mishna Yomi |
 | omer | <code>boolean</code> | include Days of the Omer |
 | molad | <code>boolean</code> | include event announcing the molad |