@hebcal/core 3.50.4 → 4.0.0

package/README.md

@@ -91,12 +91,6 @@ holidays. <code>@hebcal/core</code> supports four locales by default</p>
 <dt><a href="#OmerEvent">OmerEvent</a></dt>
 <dd><p>Represents a day 1-49 of counting the Omer from Pesach to Shavuot</p>
 </dd>
-<dt><a href="#DafYomi">DafYomi</a></dt>
-<dd><p>Returns the Daf Yomi for given date</p>
-</dd>
-<dt><a href="#DafYomiEvent">DafYomiEvent</a></dt>
-<dd><p>Event wrapper around a DafYomi instance</p>
-</dd>
 <dt><a href="#Sedra">Sedra</a></dt>
 <dd><p>Represents Parashah HaShavua for an entire Hebrew year</p>
 </dd>
@@ -116,22 +110,9 @@ we subclass HolidayEvent to override the <code>url()</code> method.</p>
 <dt><a href="#MevarchimChodeshEvent">MevarchimChodeshEvent</a></dt>
 <dd><p>Represents Mevarchim haChodesh, the announcement of the new month</p>
 </dd>
-<dt><a href="#MishnaYomiIndex">MishnaYomiIndex</a></dt>
-<dd><p>A program of daily learning in which participants study two Mishnahs
-each day in order to finish the entire Mishnah in ~6 years.</p>
-</dd>
-<dt><a href="#MishnaYomiEvent">MishnaYomiEvent</a></dt>
-<dd><p>Event wrapper around a Mishna Yomi instance</p>
-</dd>
-<dt><a href="#NachYomiIndex">NachYomiIndex</a></dt>
-<dd><p>A daily regimen of learning the books of Nevi&#39;im (Prophets)
-and Ketuvim (Writings).</p>
-</dd>
-<dt><a href="#NachYomiEvent">NachYomiEvent</a></dt>
-<dd><p>Event wrapper around a Nach Yomi instance</p>
-</dd>
-<dt><a href="#YerushalmiYomiEvent">YerushalmiYomiEvent</a></dt>
-<dd><p>Event wrapper around a Yerushalmi Yomi result</p>
+<dt><a href="#DailyLearning">DailyLearning</a></dt>
+<dd><p>Plug-ins for daily learning calendars such as Daf Yomi, Mishna Yomi, Nach Yomi, etc.</p>
+<p>Learning schedules are provided by the <code>@hebcal/learning</code> package.</p>
 </dd>
 <dt><a href="#HebrewCalendar">HebrewCalendar</a></dt>
 <dd><p>HebrewCalendar is the main interface to the <code>@hebcal/core</code> library.
@@ -151,12 +132,6 @@ Event names can be rendered in several languges using the <code>locale</code> op
 <dd><p>The 54 parshiyot of the Torah as transilterated strings
 parshiot[0] == &#39;Bereshit&#39;, parshiot[1] == &#39;Noach&#39;, parshiot[53] == &quot;Ha&#39;Azinu&quot;.</p>
 </dd>
-<dt><a href="#vilna">vilna</a></dt>
-<dd><p>Yerushalmi Yomi configuration for Vilna Edition</p>
-</dd>
-<dt><a href="#schottenstein">schottenstein</a></dt>
-<dd><p>Yerushalmi Yomi configuration for Schottenstein Edition</p>
-</dd>
 </dl>
 
 ## Functions
@@ -167,19 +142,6 @@ 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
@@ -190,12 +152,6 @@ cycle began (2 February 1980 for Vilna,
 <dt><a href="#SedraResult">SedraResult</a> : <code>Object</code></dt>
 <dd><p>Result of Sedra.lookup</p>
 </dd>
-<dt><a href="#MishnaYomi">MishnaYomi</a> : <code>Object</code></dt>
-<dd><p>Describes a mishna to be read</p>
-</dd>
-<dt><a href="#NachYomi">NachYomi</a> : <code>Object</code></dt>
-<dd><p>Describes a chapter to be read</p>
-</dd>
 <dt><a href="#CalOptions">CalOptions</a> : <code>Object</code></dt>
 <dd><p>Options to configure which events are returned</p>
 </dd>
@@ -260,7 +216,7 @@ Register locale translations.
 | Param | Type | Description |
 | --- | --- | --- |
 | locale | <code>string</code> | Locale name (i.e.: `'he'`, `'fr'`) |
-| data | <code>LocaleDate</code> | parsed data from a `.po` file. |
+| data | <code>LocaleData</code> | parsed data from a `.po` file. |
 
 <a name="Locale.useLocale"></a>
 
@@ -848,6 +804,7 @@ Represents an Event with a title, date, and flags
     * [.observedIn(il)](#Event+observedIn) ⇒ <code>boolean</code>
     * ~~[.getAttrs()](#Event+getAttrs) ⇒ <code>Object</code>~~
     * [.clone()](#Event+clone) ⇒ [<code>Event</code>](#Event)
+    * [.getCategories()](#Event+getCategories) ⇒ <code>Array.&lt;string&gt;</code>
 
 <a name="new_Event_new"></a>
 
@@ -990,6 +947,12 @@ ev2.observedIn(true); // true
 ### event.clone() ⇒ [<code>Event</code>](#Event)
 Makes a clone of this Event object
 
+**Kind**: instance method of [<code>Event</code>](#Event)  
+<a name="Event+getCategories"></a>
+
+### event.getCategories() ⇒ <code>Array.&lt;string&gt;</code>
+Returns a list of event categories
+
 **Kind**: instance method of [<code>Event</code>](#Event)  
 <a name="HebrewDateEvent"></a>
 
@@ -1580,6 +1543,7 @@ An event that has an `eventTime` and `eventTimeStr`
     * [new TimedEvent(date, desc, mask, eventTime, location, linkedEvent)](#new_TimedEvent_new)
     * [.render([locale])](#TimedEvent+render) ⇒ <code>string</code>
     * [.renderBrief([locale])](#TimedEvent+renderBrief) ⇒ <code>string</code>
+    * [.getCategories()](#TimedEvent+getCategories) ⇒ <code>Array.&lt;string&gt;</code>
 
 <a name="new_TimedEvent_new"></a>
 
@@ -1614,6 +1578,10 @@ Returns translation of "Candle lighting" without the time.
 | --- | --- | --- |
 | [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
 
+<a name="TimedEvent+getCategories"></a>
+
+### timedEvent.getCategories() ⇒ <code>Array.&lt;string&gt;</code>
+**Kind**: instance method of [<code>TimedEvent</code>](#TimedEvent)  
 <a name="HavdalahEvent"></a>
 
 ## HavdalahEvent
@@ -1866,97 +1834,6 @@ Returns translation of "Omer day 22" without ordinal numbers.
 
 ### omerEvent.url() ⇒ <code>string</code>
 **Kind**: instance method of [<code>OmerEvent</code>](#OmerEvent)  
-<a name="DafYomi"></a>
-
-## DafYomi
-Returns the Daf Yomi for given date
-
-**Kind**: global class  
-
-* [DafYomi](#DafYomi)
-    * [new DafYomi(date)](#new_DafYomi_new)
-    * [.getBlatt()](#DafYomi+getBlatt) ⇒ <code>number</code>
-    * [.getName()](#DafYomi+getName) ⇒ <code>string</code>
-    * [.render([locale])](#DafYomi+render) ⇒ <code>string</code>
-
-<a name="new_DafYomi_new"></a>
-
-### new DafYomi(date)
-Initializes a daf yomi instance
-
-
-| Param | Type | Description |
-| --- | --- | --- |
-| date | <code>Date</code> \| [<code>HDate</code>](#HDate) \| <code>number</code> | Gregorian or Hebrew date |
-
-<a name="DafYomi+getBlatt"></a>
-
-### dafYomi.getBlatt() ⇒ <code>number</code>
-**Kind**: instance method of [<code>DafYomi</code>](#DafYomi)  
-<a name="DafYomi+getName"></a>
-
-### dafYomi.getName() ⇒ <code>string</code>
-**Kind**: instance method of [<code>DafYomi</code>](#DafYomi)  
-<a name="DafYomi+render"></a>
-
-### dafYomi.render([locale]) ⇒ <code>string</code>
-Formats (with translation) the dafyomi result as a string like "Pesachim 34"
-
-**Kind**: instance method of [<code>DafYomi</code>](#DafYomi)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
-
-<a name="DafYomiEvent"></a>
-
-## DafYomiEvent
-Event wrapper around a DafYomi instance
-
-**Kind**: global class  
-
-* [DafYomiEvent](#DafYomiEvent)
-    * [new DafYomiEvent(date)](#new_DafYomiEvent_new)
-    * [.render([locale])](#DafYomiEvent+render) ⇒ <code>string</code>
-    * [.renderBrief([locale])](#DafYomiEvent+renderBrief) ⇒ <code>string</code>
-    * [.url()](#DafYomiEvent+url) ⇒ <code>string</code>
-
-<a name="new_DafYomiEvent_new"></a>
-
-### new DafYomiEvent(date)
-
-| Param | Type |
-| --- | --- |
-| date | [<code>HDate</code>](#HDate) | 
-
-<a name="DafYomiEvent+render"></a>
-
-### dafYomiEvent.render([locale]) ⇒ <code>string</code>
-Returns Daf Yomi name including the 'Daf Yomi: ' prefix (e.g. "Daf Yomi: Pesachim 107").
-
-**Kind**: instance method of [<code>DafYomiEvent</code>](#DafYomiEvent)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
-
-<a name="DafYomiEvent+renderBrief"></a>
-
-### dafYomiEvent.renderBrief([locale]) ⇒ <code>string</code>
-Returns Daf Yomi name without the 'Daf Yomi: ' prefix (e.g. "Pesachim 107").
-
-**Kind**: instance method of [<code>DafYomiEvent</code>](#DafYomiEvent)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
-
-<a name="DafYomiEvent+url"></a>
-
-### dafYomiEvent.url() ⇒ <code>string</code>
-Returns a link to sefaria.org or dafyomi.org
-
-**Kind**: instance method of [<code>DafYomiEvent</code>](#DafYomiEvent)  
 <a name="Sedra"></a>
 
 ## Sedra
@@ -2111,6 +1988,7 @@ Represents a built-in holiday like Pesach, Purim or Tu BiShvat
     * [.url()](#HolidayEvent+url) ⇒ <code>string</code>
     * [.urlDateSuffix()](#HolidayEvent+urlDateSuffix) ⇒ <code>string</code>
     * [.getEmoji()](#HolidayEvent+getEmoji) ⇒ <code>string</code>
+    * [.getCategories()](#HolidayEvent+getCategories) ⇒ <code>Array.&lt;string&gt;</code>
 
 <a name="new_HolidayEvent_new"></a>
 
@@ -2141,6 +2019,10 @@ Constructs Holiday event
 
 ### holidayEvent.getEmoji() ⇒ <code>string</code>
 **Kind**: instance method of [<code>HolidayEvent</code>](#HolidayEvent)  
+<a name="HolidayEvent+getCategories"></a>
+
+### holidayEvent.getCategories() ⇒ <code>Array.&lt;string&gt;</code>
+**Kind**: instance method of [<code>HolidayEvent</code>](#HolidayEvent)  
 <a name="RoshChodeshEvent"></a>
 
 ## RoshChodeshEvent
@@ -2250,193 +2132,44 @@ Returns (translated) description of this event
 | --- | --- | --- |
 | [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
 
-<a name="MishnaYomiIndex"></a>
-
-## MishnaYomiIndex
-A program of daily learning in which participants study two Mishnahs
-each day in order to finish the entire Mishnah in ~6 years.
-
-**Kind**: global class  
-
-* [MishnaYomiIndex](#MishnaYomiIndex)
-    * [new MishnaYomiIndex()](#new_MishnaYomiIndex_new)
-    * [.days](#MishnaYomiIndex+days) : [<code>Array.&lt;MishnaYomi&gt;</code>](#MishnaYomi)
-    * [.lookup(date)](#MishnaYomiIndex+lookup) ⇒ [<code>Array.&lt;MishnaYomi&gt;</code>](#MishnaYomi)
-
-<a name="new_MishnaYomiIndex_new"></a>
-
-### new MishnaYomiIndex()
-Initializes a Mishna Yomi instance
-
-<a name="MishnaYomiIndex+days"></a>
-
-### mishnaYomiIndex.days : [<code>Array.&lt;MishnaYomi&gt;</code>](#MishnaYomi)
-**Kind**: instance property of [<code>MishnaYomiIndex</code>](#MishnaYomiIndex)  
-<a name="MishnaYomiIndex+lookup"></a>
-
-### mishnaYomiIndex.lookup(date) ⇒ [<code>Array.&lt;MishnaYomi&gt;</code>](#MishnaYomi)
-Looks up a Mishna Yomi
-
-**Kind**: instance method of [<code>MishnaYomiIndex</code>](#MishnaYomiIndex)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| date | <code>Date</code> \| [<code>HDate</code>](#HDate) \| <code>number</code> | Gregorian date |
+<a name="DailyLearning"></a>
 
-<a name="MishnaYomiEvent"></a>
+## DailyLearning
+Plug-ins for daily learning calendars such as Daf Yomi, Mishna Yomi, Nach Yomi, etc.
 
-## MishnaYomiEvent
-Event wrapper around a Mishna Yomi instance
+Learning schedules are provided by the `@hebcal/learning` package.
 
 **Kind**: global class  
 
-* [MishnaYomiEvent](#MishnaYomiEvent)
-    * [new MishnaYomiEvent(date, mishnaYomi)](#new_MishnaYomiEvent_new)
-    * [.render([locale])](#MishnaYomiEvent+render) ⇒ <code>string</code>
-    * [.url()](#MishnaYomiEvent+url) ⇒ <code>string</code>
+* [DailyLearning](#DailyLearning)
+    * [.addCalendar(name, calendar)](#DailyLearning.addCalendar)
+    * [.lookup(name, hd)](#DailyLearning.lookup) ⇒ [<code>Event</code>](#Event)
 
-<a name="new_MishnaYomiEvent_new"></a>
+<a name="DailyLearning.addCalendar"></a>
 
-### new MishnaYomiEvent(date, mishnaYomi)
-
-| Param | Type |
-| --- | --- |
-| date | [<code>HDate</code>](#HDate) | 
-| mishnaYomi | [<code>Array.&lt;MishnaYomi&gt;</code>](#MishnaYomi) | 
-
-<a name="MishnaYomiEvent+render"></a>
-
-### mishnaYomiEvent.render([locale]) ⇒ <code>string</code>
-Returns Mishna Yomi name (e.g. "Bava Metzia 10:5-6" or "Berakhot 9:5-Peah 1:1").
-
-**Kind**: instance method of [<code>MishnaYomiEvent</code>](#MishnaYomiEvent)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
+### DailyLearning.addCalendar(name, calendar)
+Register a new learning calendar.
 
-<a name="MishnaYomiEvent+url"></a>
-
-### mishnaYomiEvent.url() ⇒ <code>string</code>
-Returns a link to sefaria.org
-
-**Kind**: instance method of [<code>MishnaYomiEvent</code>](#MishnaYomiEvent)  
-<a name="NachYomiIndex"></a>
-
-## NachYomiIndex
-A daily regimen of learning the books of Nevi'im (Prophets)
-and Ketuvim (Writings).
-
-**Kind**: global class  
-
-* [NachYomiIndex](#NachYomiIndex)
-    * [new NachYomiIndex()](#new_NachYomiIndex_new)
-    * [.lookup(date)](#NachYomiIndex+lookup) ⇒ [<code>NachYomi</code>](#NachYomi)
-
-<a name="new_NachYomiIndex_new"></a>
-
-### new NachYomiIndex()
-Initializes a Nach Yomi instance
-
-<a name="NachYomiIndex+lookup"></a>
-
-### nachYomiIndex.lookup(date) ⇒ [<code>NachYomi</code>](#NachYomi)
-Looks up a Mishna Yomi
-
-**Kind**: instance method of [<code>NachYomiIndex</code>](#NachYomiIndex)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| date | <code>Date</code> \| [<code>HDate</code>](#HDate) \| <code>number</code> | Gregorian date |
-
-<a name="NachYomiEvent"></a>
-
-## NachYomiEvent
-Event wrapper around a Nach Yomi instance
-
-**Kind**: global class  
-
-* [NachYomiEvent](#NachYomiEvent)
-    * [new NachYomiEvent(date, nachYomi)](#new_NachYomiEvent_new)
-    * [.render([locale])](#NachYomiEvent+render) ⇒ <code>string</code>
-    * [.url()](#NachYomiEvent+url) ⇒ <code>string</code>
-
-<a name="new_NachYomiEvent_new"></a>
-
-### new NachYomiEvent(date, nachYomi)
+**Kind**: static method of [<code>DailyLearning</code>](#DailyLearning)  
 
 | Param | Type |
 | --- | --- |
-| date | [<code>HDate</code>](#HDate) | 
-| nachYomi | [<code>NachYomi</code>](#NachYomi) | 
-
-<a name="NachYomiEvent+render"></a>
-
-### nachYomiEvent.render([locale]) ⇒ <code>string</code>
-Returns name of tractate and page (e.g. "Beitzah 21").
-
-**Kind**: instance method of [<code>NachYomiEvent</code>](#NachYomiEvent)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
-
-<a name="NachYomiEvent+url"></a>
-
-### nachYomiEvent.url() ⇒ <code>string</code>
-Returns a link to sefaria.org
-
-**Kind**: instance method of [<code>NachYomiEvent</code>](#NachYomiEvent)  
-<a name="YerushalmiYomiEvent"></a>
-
-## YerushalmiYomiEvent
-Event wrapper around a Yerushalmi Yomi result
-
-**Kind**: global class  
+| name | <code>string</code> | 
+| calendar | <code>function</code> | 
 
-* [YerushalmiYomiEvent](#YerushalmiYomiEvent)
-    * [new YerushalmiYomiEvent(date, daf)](#new_YerushalmiYomiEvent_new)
-    * [.render([locale])](#YerushalmiYomiEvent+render) ⇒ <code>string</code>
-    * [.renderBrief([locale])](#YerushalmiYomiEvent+renderBrief) ⇒ <code>string</code>
-    * [.url()](#YerushalmiYomiEvent+url) ⇒ <code>string</code>
+<a name="DailyLearning.lookup"></a>
 
-<a name="new_YerushalmiYomiEvent_new"></a>
+### DailyLearning.lookup(name, hd) ⇒ [<code>Event</code>](#Event)
+Returns an event from daily calendar for a given date. Returns `null` if there
+is no learning from this calendar on this date.
 
-### new YerushalmiYomiEvent(date, daf)
+**Kind**: static method of [<code>DailyLearning</code>](#DailyLearning)  
 
 | 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="YerushalmiYomiEvent+renderBrief"></a>
-
-### yerushalmiYomiEvent.renderBrief([locale]) ⇒ <code>string</code>
-Returns name of tractate and page (e.g. "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="YerushalmiYomiEvent+url"></a>
-
-### yerushalmiYomiEvent.url() ⇒ <code>string</code>
-Returns a link to sefaria.org
+| name | <code>string</code> | 
+| hd | [<code>HDate</code>](#HDate) | 
 
-**Kind**: instance method of [<code>YerushalmiYomiEvent</code>](#YerushalmiYomiEvent)  
 <a name="HebrewCalendar"></a>
 
 ## HebrewCalendar
@@ -2493,14 +2226,16 @@ 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`)
-* Babylonian Talmud Daf Yomi (`options.dafyomi`)
-* Jerusalem Talmud (Yerushalmi) Yomi (`options.yerushalmi`)
-* Mishna Yomi (`options.mishnaYomi`)
-* Nach Yomi (`options.nachYomi`)
 * Shabbat Mevarchim HaChodesh on Saturday before Rosh Chodesh (`options.shabbatMevarchim`)
 * Molad announcement on Saturday before Rosh Chodesh (`options.molad`)
 * Yom Kippur Katan (`options.yomKippurKatan`)
 
+Daily Study of texts:
+* Babylonian Talmud Daf Yomi (`options.dailyLearning.dafYomi`)
+* Jerusalem Talmud (Yerushalmi) Yomi (`options.dailyLearning.yerushalmi`)
+* Mishna Yomi (`options.dailyLearning.mishnaYomi`)
+* Nach Yomi (`options.dailyLearning.nachYomi`)
+
 Candle-lighting and Havdalah times are approximated using latitude and longitude
 specified by the [Location](#Location) class. The `Location` class contains a small
 database of cities with their associated geographic information and time-zone information.
@@ -2933,20 +2668,6 @@ Clamen, Software--Practice and Experience, Volume 23, Number 4
 The 54 parshiyot of the Torah as transilterated strings
 parshiot[0] == 'Bereshit', parshiot[1] == 'Noach', parshiot[53] == "Ha'Azinu".
 
-**Kind**: global constant  
-**Read only**: true  
-<a name="vilna"></a>
-
-## vilna
-Yerushalmi Yomi configuration for Vilna Edition
-
-**Kind**: global constant  
-**Read only**: true  
-<a name="schottenstein"></a>
-
-## schottenstein
-Yerushalmi Yomi configuration for Schottenstein Edition
-
 **Kind**: global constant  
 **Read only**: true  
 <a name="gematriya"></a>
@@ -2971,30 +2692,6 @@ 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>
@@ -3035,32 +2732,6 @@ Result of Sedra.lookup
 | chag | <code>boolean</code> | True if this is a regular parasha HaShavua     Torah reading, false if it's a special holiday reading |
 | num | <code>number</code> \| <code>Array.&lt;number&gt;</code> | the parsha number (or numbers) using 1-indexing.     A `number` for a regular (single) parsha, and a `number[]` for a doubled parsha.     For Parashat *Bereshit*, `num` would be equal to `1`, and for     *Matot-Masei* it would be `[42, 43]` |
 
-<a name="MishnaYomi"></a>
-
-## MishnaYomi : <code>Object</code>
-Describes a mishna to be read
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| k | <code>string</code> | tractate name in Sephardic transliteration (e.g. "Berakhot", "Moed Katan") |
-| v | <code>string</code> | verse (e.g. "2:1") |
-
-<a name="NachYomi"></a>
-
-## NachYomi : <code>Object</code>
-Describes a chapter to be read
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| k | <code>string</code> | book name in Sephardic transliteration (e.g. "Berakhot", "Moed Katan") |
-| v | <code>number</code> | chapter (e.g. "2:1") |
-
 <a name="CalOptions"></a>
 
 ## CalOptions : <code>Object</code>
@@ -3090,11 +2761,6 @@ 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> | 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 |
-| nachYomi | <code>boolean</code> | include Nach Yomi |
 | omer | <code>boolean</code> | include Days of the Omer |
 | molad | <code>boolean</code> | include event announcing the molad |
 | ashkenazi | <code>boolean</code> | use Ashkenazi transliterations for event titles (default Sephardi transliterations) |
@@ -3104,6 +2770,7 @@ Options to configure which events are returned
 | mask | <code>number</code> | use bitmask from `flags` to filter events |
 | yomKippurKatan | <code>boolean</code> | include Yom Kippur Katan (default `false`).      יוֹם כִּפּוּר קָטָן is a minor day of atonement occurring monthly on the day preceeding each Rosh Chodesh.      Yom Kippur Katan is omitted in Elul (on the day before Rosh Hashanah),      Tishrei (Yom Kippur has just passed), Kislev (due to Chanukah)      and Nisan (fasting not permitted during Nisan).      When Rosh Chodesh occurs on Shabbat or Sunday, Yom Kippur Katan is observed on the preceding Thursday.      See [Wikipedia Yom Kippur Katan practices](https://en.wikipedia.org/wiki/Yom_Kippur_Katan#Practices) |
 | hour12 | <code>boolean</code> | Whether to use 12-hour time (as opposed to 24-hour time).      Possible values are `true` and `false`; the default is locale dependent. |
+| dailyLearning | <code>Object.&lt;string, any&gt;</code> | map of options to enable daily study calendars      such as `dafYomi`, `mishnaYomi`, `nachYomi` with value `true`. For `yerushalmi`      the value should be a `number` for edition (`1` for Vilna, `2` for Schottenstein). |
 
 <a name="TachanunResult"></a>