@hebcal/core 3.50.3 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -91,12 +91,6 @@ holidays. <code>@hebcal/core</code> supports four locales by default</p>
91
91
  <dt><a href="#OmerEvent">OmerEvent</a></dt>
92
92
  <dd><p>Represents a day 1-49 of counting the Omer from Pesach to Shavuot</p>
93
93
  </dd>
94
- <dt><a href="#DafYomi">DafYomi</a></dt>
95
- <dd><p>Returns the Daf Yomi for given date</p>
96
- </dd>
97
- <dt><a href="#DafYomiEvent">DafYomiEvent</a></dt>
98
- <dd><p>Event wrapper around a DafYomi instance</p>
99
- </dd>
100
94
  <dt><a href="#Sedra">Sedra</a></dt>
101
95
  <dd><p>Represents Parashah HaShavua for an entire Hebrew year</p>
102
96
  </dd>
@@ -116,22 +110,9 @@ we subclass HolidayEvent to override the <code>url()</code> method.</p>
116
110
  <dt><a href="#MevarchimChodeshEvent">MevarchimChodeshEvent</a></dt>
117
111
  <dd><p>Represents Mevarchim haChodesh, the announcement of the new month</p>
118
112
  </dd>
119
- <dt><a href="#MishnaYomiIndex">MishnaYomiIndex</a></dt>
120
- <dd><p>A program of daily learning in which participants study two Mishnahs
121
- each day in order to finish the entire Mishnah in ~6 years.</p>
122
- </dd>
123
- <dt><a href="#MishnaYomiEvent">MishnaYomiEvent</a></dt>
124
- <dd><p>Event wrapper around a Mishna Yomi instance</p>
125
- </dd>
126
- <dt><a href="#NachYomiIndex">NachYomiIndex</a></dt>
127
- <dd><p>A daily regimen of learning the books of Nevi&#39;im (Prophets)
128
- and Ketuvim (Writings).</p>
129
- </dd>
130
- <dt><a href="#NachYomiEvent">NachYomiEvent</a></dt>
131
- <dd><p>Event wrapper around a Nach Yomi instance</p>
132
- </dd>
133
- <dt><a href="#YerushalmiYomiEvent">YerushalmiYomiEvent</a></dt>
134
- <dd><p>Event wrapper around a Yerushalmi Yomi result</p>
113
+ <dt><a href="#DailyLearning">DailyLearning</a></dt>
114
+ <dd><p>Plug-ins for daily learning calendars such as Daf Yomi, Mishna Yomi, Nach Yomi, etc.</p>
115
+ <p>Learning schedules are provided by the <code>@hebcal/learning</code> package.</p>
135
116
  </dd>
136
117
  <dt><a href="#HebrewCalendar">HebrewCalendar</a></dt>
137
118
  <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
151
132
  <dd><p>The 54 parshiyot of the Torah as transilterated strings
152
133
  parshiot[0] == &#39;Bereshit&#39;, parshiot[1] == &#39;Noach&#39;, parshiot[53] == &quot;Ha&#39;Azinu&quot;.</p>
153
134
  </dd>
154
- <dt><a href="#vilna">vilna</a></dt>
155
- <dd><p>Yerushalmi Yomi configuration for Vilna Edition</p>
156
- </dd>
157
- <dt><a href="#schottenstein">schottenstein</a></dt>
158
- <dd><p>Yerushalmi Yomi configuration for Schottenstein Edition</p>
159
- </dd>
160
135
  </dl>
161
136
 
162
137
  ## Functions
@@ -167,19 +142,6 @@ parshiot[0] == &#39;Bereshit&#39;, parshiot[1] == &#39;Noach&#39;, parshiot[53]
167
142
  <p>When specifying years of the Hebrew calendar in the present millennium,
168
143
  we omit the thousands (which is presently 5 [ה]).</p>
169
144
  </dd>
170
- <dt><a href="#yerushalmiYomi">yerushalmiYomi(date, config)</a> ⇒ <code>any</code></dt>
171
- <dd><p>Using the Vilna edition, the Yerushalmi Daf Yomi program takes
172
- ~4.25 years or 51 months.
173
- Unlike the Daf Yomi Bavli cycle, this Yerushalmi cycle skips both
174
- Yom Kippur and Tisha B&#39;Av (returning <code>null</code>).
175
- The page numbers are according to the Vilna
176
- Edition which is used since 1900.</p>
177
- <p>The Schottenstein edition uses different page numbers and takes
178
- ~6 years to complete.</p>
179
- <p>Throws an exception if the date is before Daf Yomi Yerushalmi
180
- cycle began (2 February 1980 for Vilna,
181
- 14 November 2022 for Schottenstein).</p>
182
- </dd>
183
145
  </dl>
184
146
 
185
147
  ## Typedefs
@@ -190,12 +152,6 @@ cycle began (2 February 1980 for Vilna,
190
152
  <dt><a href="#SedraResult">SedraResult</a> : <code>Object</code></dt>
191
153
  <dd><p>Result of Sedra.lookup</p>
192
154
  </dd>
193
- <dt><a href="#MishnaYomi">MishnaYomi</a> : <code>Object</code></dt>
194
- <dd><p>Describes a mishna to be read</p>
195
- </dd>
196
- <dt><a href="#NachYomi">NachYomi</a> : <code>Object</code></dt>
197
- <dd><p>Describes a chapter to be read</p>
198
- </dd>
199
155
  <dt><a href="#CalOptions">CalOptions</a> : <code>Object</code></dt>
200
156
  <dd><p>Options to configure which events are returned</p>
201
157
  </dd>
@@ -260,7 +216,7 @@ Register locale translations.
260
216
  | Param | Type | Description |
261
217
  | --- | --- | --- |
262
218
  | locale | <code>string</code> | Locale name (i.e.: `'he'`, `'fr'`) |
263
- | data | <code>LocaleDate</code> | parsed data from a `.po` file. |
219
+ | data | <code>LocaleData</code> | parsed data from a `.po` file. |
264
220
 
265
221
  <a name="Locale.useLocale"></a>
266
222
 
@@ -329,7 +285,7 @@ Represents a Hebrew date
329
285
  * [.abs()](#HDate+abs) ⇒ <code>number</code>
330
286
  * [.getMonthName()](#HDate+getMonthName) ⇒ <code>string</code>
331
287
  * [.render([locale], [showYear])](#HDate+render) ⇒ <code>string</code>
332
- * [.renderGematriya()](#HDate+renderGematriya) ⇒ <code>string</code>
288
+ * [.renderGematriya([suppressNikud])](#HDate+renderGematriya) ⇒ <code>string</code>
333
289
  * [.before(day)](#HDate+before) ⇒ [<code>HDate</code>](#HDate)
334
290
  * [.onOrBefore(dow)](#HDate+onOrBefore) ⇒ [<code>HDate</code>](#HDate)
335
291
  * [.nearest(dow)](#HDate+nearest) ⇒ [<code>HDate</code>](#HDate)
@@ -477,10 +433,15 @@ console.log(hd.render('he')); // '15 חֶשְׁוָן, 5769'
477
433
  ```
478
434
  <a name="HDate+renderGematriya"></a>
479
435
 
480
- ### hDate.renderGematriya() ⇒ <code>string</code>
436
+ ### hDate.renderGematriya([suppressNikud]) ⇒ <code>string</code>
481
437
  Renders this Hebrew date in Hebrew gematriya, regardless of locale.
482
438
 
483
439
  **Kind**: instance method of [<code>HDate</code>](#HDate)
440
+
441
+ | Param | Type | Default |
442
+ | --- | --- | --- |
443
+ | [suppressNikud] | <code>boolean</code> | <code>false</code> |
444
+
484
445
  **Example**
485
446
  ```js
486
447
  import {HDate, months} from '@hebcal/core';
@@ -843,6 +804,7 @@ Represents an Event with a title, date, and flags
843
804
  * [.observedIn(il)](#Event+observedIn) ⇒ <code>boolean</code>
844
805
  * ~~[.getAttrs()](#Event+getAttrs) ⇒ <code>Object</code>~~
845
806
  * [.clone()](#Event+clone) ⇒ [<code>Event</code>](#Event)
807
+ * [.getCategories()](#Event+getCategories) ⇒ <code>Array.&lt;string&gt;</code>
846
808
 
847
809
  <a name="new_Event_new"></a>
848
810
 
@@ -985,6 +947,12 @@ ev2.observedIn(true); // true
985
947
  ### event.clone() ⇒ [<code>Event</code>](#Event)
986
948
  Makes a clone of this Event object
987
949
 
950
+ **Kind**: instance method of [<code>Event</code>](#Event)
951
+ <a name="Event+getCategories"></a>
952
+
953
+ ### event.getCategories() ⇒ <code>Array.&lt;string&gt;</code>
954
+ Returns a list of event categories
955
+
988
956
  **Kind**: instance method of [<code>Event</code>](#Event)
989
957
  <a name="HebrewDateEvent"></a>
990
958
 
@@ -1575,6 +1543,7 @@ An event that has an `eventTime` and `eventTimeStr`
1575
1543
  * [new TimedEvent(date, desc, mask, eventTime, location, linkedEvent)](#new_TimedEvent_new)
1576
1544
  * [.render([locale])](#TimedEvent+render) ⇒ <code>string</code>
1577
1545
  * [.renderBrief([locale])](#TimedEvent+renderBrief) ⇒ <code>string</code>
1546
+ * [.getCategories()](#TimedEvent+getCategories) ⇒ <code>Array.&lt;string&gt;</code>
1578
1547
 
1579
1548
  <a name="new_TimedEvent_new"></a>
1580
1549
 
@@ -1609,6 +1578,10 @@ Returns translation of "Candle lighting" without the time.
1609
1578
  | --- | --- | --- |
1610
1579
  | [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
1611
1580
 
1581
+ <a name="TimedEvent+getCategories"></a>
1582
+
1583
+ ### timedEvent.getCategories() ⇒ <code>Array.&lt;string&gt;</code>
1584
+ **Kind**: instance method of [<code>TimedEvent</code>](#TimedEvent)
1612
1585
  <a name="HavdalahEvent"></a>
1613
1586
 
1614
1587
  ## HavdalahEvent
@@ -1861,97 +1834,6 @@ Returns translation of "Omer day 22" without ordinal numbers.
1861
1834
 
1862
1835
  ### omerEvent.url() ⇒ <code>string</code>
1863
1836
  **Kind**: instance method of [<code>OmerEvent</code>](#OmerEvent)
1864
- <a name="DafYomi"></a>
1865
-
1866
- ## DafYomi
1867
- Returns the Daf Yomi for given date
1868
-
1869
- **Kind**: global class
1870
-
1871
- * [DafYomi](#DafYomi)
1872
- * [new DafYomi(gregdate)](#new_DafYomi_new)
1873
- * [.getBlatt()](#DafYomi+getBlatt) ⇒ <code>number</code>
1874
- * [.getName()](#DafYomi+getName) ⇒ <code>string</code>
1875
- * [.render([locale])](#DafYomi+render) ⇒ <code>string</code>
1876
-
1877
- <a name="new_DafYomi_new"></a>
1878
-
1879
- ### new DafYomi(gregdate)
1880
- Initializes a daf yomi instance
1881
-
1882
-
1883
- | Param | Type | Description |
1884
- | --- | --- | --- |
1885
- | gregdate | <code>Date</code> \| [<code>HDate</code>](#HDate) \| <code>number</code> | Gregorian date |
1886
-
1887
- <a name="DafYomi+getBlatt"></a>
1888
-
1889
- ### dafYomi.getBlatt() ⇒ <code>number</code>
1890
- **Kind**: instance method of [<code>DafYomi</code>](#DafYomi)
1891
- <a name="DafYomi+getName"></a>
1892
-
1893
- ### dafYomi.getName() ⇒ <code>string</code>
1894
- **Kind**: instance method of [<code>DafYomi</code>](#DafYomi)
1895
- <a name="DafYomi+render"></a>
1896
-
1897
- ### dafYomi.render([locale]) ⇒ <code>string</code>
1898
- Formats (with translation) the dafyomi result as a string like "Pesachim 34"
1899
-
1900
- **Kind**: instance method of [<code>DafYomi</code>](#DafYomi)
1901
-
1902
- | Param | Type | Description |
1903
- | --- | --- | --- |
1904
- | [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
1905
-
1906
- <a name="DafYomiEvent"></a>
1907
-
1908
- ## DafYomiEvent
1909
- Event wrapper around a DafYomi instance
1910
-
1911
- **Kind**: global class
1912
-
1913
- * [DafYomiEvent](#DafYomiEvent)
1914
- * [new DafYomiEvent(date)](#new_DafYomiEvent_new)
1915
- * [.render([locale])](#DafYomiEvent+render) ⇒ <code>string</code>
1916
- * [.renderBrief([locale])](#DafYomiEvent+renderBrief) ⇒ <code>string</code>
1917
- * [.url()](#DafYomiEvent+url) ⇒ <code>string</code>
1918
-
1919
- <a name="new_DafYomiEvent_new"></a>
1920
-
1921
- ### new DafYomiEvent(date)
1922
-
1923
- | Param | Type |
1924
- | --- | --- |
1925
- | date | [<code>HDate</code>](#HDate) |
1926
-
1927
- <a name="DafYomiEvent+render"></a>
1928
-
1929
- ### dafYomiEvent.render([locale]) ⇒ <code>string</code>
1930
- Returns Daf Yomi name including the 'Daf Yomi: ' prefix (e.g. "Daf Yomi: Pesachim 107").
1931
-
1932
- **Kind**: instance method of [<code>DafYomiEvent</code>](#DafYomiEvent)
1933
-
1934
- | Param | Type | Description |
1935
- | --- | --- | --- |
1936
- | [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
1937
-
1938
- <a name="DafYomiEvent+renderBrief"></a>
1939
-
1940
- ### dafYomiEvent.renderBrief([locale]) ⇒ <code>string</code>
1941
- Returns Daf Yomi name without the 'Daf Yomi: ' prefix (e.g. "Pesachim 107").
1942
-
1943
- **Kind**: instance method of [<code>DafYomiEvent</code>](#DafYomiEvent)
1944
-
1945
- | Param | Type | Description |
1946
- | --- | --- | --- |
1947
- | [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
1948
-
1949
- <a name="DafYomiEvent+url"></a>
1950
-
1951
- ### dafYomiEvent.url() ⇒ <code>string</code>
1952
- Returns a link to sefaria.org or dafyomi.org
1953
-
1954
- **Kind**: instance method of [<code>DafYomiEvent</code>](#DafYomiEvent)
1955
1837
  <a name="Sedra"></a>
1956
1838
 
1957
1839
  ## Sedra
@@ -2106,6 +1988,7 @@ Represents a built-in holiday like Pesach, Purim or Tu BiShvat
2106
1988
  * [.url()](#HolidayEvent+url) ⇒ <code>string</code>
2107
1989
  * [.urlDateSuffix()](#HolidayEvent+urlDateSuffix) ⇒ <code>string</code>
2108
1990
  * [.getEmoji()](#HolidayEvent+getEmoji) ⇒ <code>string</code>
1991
+ * [.getCategories()](#HolidayEvent+getCategories) ⇒ <code>Array.&lt;string&gt;</code>
2109
1992
 
2110
1993
  <a name="new_HolidayEvent_new"></a>
2111
1994
 
@@ -2136,6 +2019,10 @@ Constructs Holiday event
2136
2019
 
2137
2020
  ### holidayEvent.getEmoji() ⇒ <code>string</code>
2138
2021
  **Kind**: instance method of [<code>HolidayEvent</code>](#HolidayEvent)
2022
+ <a name="HolidayEvent+getCategories"></a>
2023
+
2024
+ ### holidayEvent.getCategories() ⇒ <code>Array.&lt;string&gt;</code>
2025
+ **Kind**: instance method of [<code>HolidayEvent</code>](#HolidayEvent)
2139
2026
  <a name="RoshChodeshEvent"></a>
2140
2027
 
2141
2028
  ## RoshChodeshEvent
@@ -2245,193 +2132,44 @@ Returns (translated) description of this event
2245
2132
  | --- | --- | --- |
2246
2133
  | [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
2247
2134
 
2248
- <a name="MishnaYomiIndex"></a>
2135
+ <a name="DailyLearning"></a>
2249
2136
 
2250
- ## MishnaYomiIndex
2251
- A program of daily learning in which participants study two Mishnahs
2252
- each day in order to finish the entire Mishnah in ~6 years.
2137
+ ## DailyLearning
2138
+ Plug-ins for daily learning calendars such as Daf Yomi, Mishna Yomi, Nach Yomi, etc.
2253
2139
 
2254
- **Kind**: global class
2255
-
2256
- * [MishnaYomiIndex](#MishnaYomiIndex)
2257
- * [new MishnaYomiIndex()](#new_MishnaYomiIndex_new)
2258
- * [.days](#MishnaYomiIndex+days) : [<code>Array.&lt;MishnaYomi&gt;</code>](#MishnaYomi)
2259
- * [.lookup(date)](#MishnaYomiIndex+lookup) ⇒ [<code>Array.&lt;MishnaYomi&gt;</code>](#MishnaYomi)
2260
-
2261
- <a name="new_MishnaYomiIndex_new"></a>
2262
-
2263
- ### new MishnaYomiIndex()
2264
- Initializes a Mishna Yomi instance
2265
-
2266
- <a name="MishnaYomiIndex+days"></a>
2267
-
2268
- ### mishnaYomiIndex.days : [<code>Array.&lt;MishnaYomi&gt;</code>](#MishnaYomi)
2269
- **Kind**: instance property of [<code>MishnaYomiIndex</code>](#MishnaYomiIndex)
2270
- <a name="MishnaYomiIndex+lookup"></a>
2271
-
2272
- ### mishnaYomiIndex.lookup(date) ⇒ [<code>Array.&lt;MishnaYomi&gt;</code>](#MishnaYomi)
2273
- Looks up a Mishna Yomi
2274
-
2275
- **Kind**: instance method of [<code>MishnaYomiIndex</code>](#MishnaYomiIndex)
2276
-
2277
- | Param | Type | Description |
2278
- | --- | --- | --- |
2279
- | date | <code>Date</code> \| [<code>HDate</code>](#HDate) \| <code>number</code> | Gregorian date |
2280
-
2281
- <a name="MishnaYomiEvent"></a>
2282
-
2283
- ## MishnaYomiEvent
2284
- Event wrapper around a Mishna Yomi instance
2140
+ Learning schedules are provided by the `@hebcal/learning` package.
2285
2141
 
2286
2142
  **Kind**: global class
2287
2143
 
2288
- * [MishnaYomiEvent](#MishnaYomiEvent)
2289
- * [new MishnaYomiEvent(date, mishnaYomi)](#new_MishnaYomiEvent_new)
2290
- * [.render([locale])](#MishnaYomiEvent+render) ⇒ <code>string</code>
2291
- * [.url()](#MishnaYomiEvent+url) ⇒ <code>string</code>
2292
-
2293
- <a name="new_MishnaYomiEvent_new"></a>
2144
+ * [DailyLearning](#DailyLearning)
2145
+ * [.addCalendar(name, calendar)](#DailyLearning.addCalendar)
2146
+ * [.lookup(name, hd)](#DailyLearning.lookup) ⇒ [<code>Event</code>](#Event)
2294
2147
 
2295
- ### new MishnaYomiEvent(date, mishnaYomi)
2148
+ <a name="DailyLearning.addCalendar"></a>
2296
2149
 
2297
- | Param | Type |
2298
- | --- | --- |
2299
- | date | [<code>HDate</code>](#HDate) |
2300
- | mishnaYomi | [<code>Array.&lt;MishnaYomi&gt;</code>](#MishnaYomi) |
2150
+ ### DailyLearning.addCalendar(name, calendar)
2151
+ Register a new learning calendar.
2301
2152
 
2302
- <a name="MishnaYomiEvent+render"></a>
2303
-
2304
- ### mishnaYomiEvent.render([locale]) ⇒ <code>string</code>
2305
- Returns Mishna Yomi name (e.g. "Bava Metzia 10:5-6" or "Berakhot 9:5-Peah 1:1").
2306
-
2307
- **Kind**: instance method of [<code>MishnaYomiEvent</code>](#MishnaYomiEvent)
2308
-
2309
- | Param | Type | Description |
2310
- | --- | --- | --- |
2311
- | [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
2312
-
2313
- <a name="MishnaYomiEvent+url"></a>
2314
-
2315
- ### mishnaYomiEvent.url() ⇒ <code>string</code>
2316
- Returns a link to sefaria.org
2317
-
2318
- **Kind**: instance method of [<code>MishnaYomiEvent</code>](#MishnaYomiEvent)
2319
- <a name="NachYomiIndex"></a>
2320
-
2321
- ## NachYomiIndex
2322
- A daily regimen of learning the books of Nevi'im (Prophets)
2323
- and Ketuvim (Writings).
2324
-
2325
- **Kind**: global class
2326
-
2327
- * [NachYomiIndex](#NachYomiIndex)
2328
- * [new NachYomiIndex()](#new_NachYomiIndex_new)
2329
- * [.lookup(date)](#NachYomiIndex+lookup) ⇒ [<code>NachYomi</code>](#NachYomi)
2330
-
2331
- <a name="new_NachYomiIndex_new"></a>
2332
-
2333
- ### new NachYomiIndex()
2334
- Initializes a Nach Yomi instance
2335
-
2336
- <a name="NachYomiIndex+lookup"></a>
2337
-
2338
- ### nachYomiIndex.lookup(date) ⇒ [<code>NachYomi</code>](#NachYomi)
2339
- Looks up a Mishna Yomi
2340
-
2341
- **Kind**: instance method of [<code>NachYomiIndex</code>](#NachYomiIndex)
2342
-
2343
- | Param | Type | Description |
2344
- | --- | --- | --- |
2345
- | date | <code>Date</code> \| [<code>HDate</code>](#HDate) \| <code>number</code> | Gregorian date |
2346
-
2347
- <a name="NachYomiEvent"></a>
2348
-
2349
- ## NachYomiEvent
2350
- Event wrapper around a Nach Yomi instance
2351
-
2352
- **Kind**: global class
2353
-
2354
- * [NachYomiEvent](#NachYomiEvent)
2355
- * [new NachYomiEvent(date, nachYomi)](#new_NachYomiEvent_new)
2356
- * [.render([locale])](#NachYomiEvent+render) ⇒ <code>string</code>
2357
- * [.url()](#NachYomiEvent+url) ⇒ <code>string</code>
2358
-
2359
- <a name="new_NachYomiEvent_new"></a>
2360
-
2361
- ### new NachYomiEvent(date, nachYomi)
2153
+ **Kind**: static method of [<code>DailyLearning</code>](#DailyLearning)
2362
2154
 
2363
2155
  | Param | Type |
2364
2156
  | --- | --- |
2365
- | date | [<code>HDate</code>](#HDate) |
2366
- | nachYomi | [<code>NachYomi</code>](#NachYomi) |
2367
-
2368
- <a name="NachYomiEvent+render"></a>
2369
-
2370
- ### nachYomiEvent.render([locale]) ⇒ <code>string</code>
2371
- Returns name of tractate and page (e.g. "Beitzah 21").
2372
-
2373
- **Kind**: instance method of [<code>NachYomiEvent</code>](#NachYomiEvent)
2374
-
2375
- | Param | Type | Description |
2376
- | --- | --- | --- |
2377
- | [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
2378
-
2379
- <a name="NachYomiEvent+url"></a>
2380
-
2381
- ### nachYomiEvent.url() ⇒ <code>string</code>
2382
- Returns a link to sefaria.org
2383
-
2384
- **Kind**: instance method of [<code>NachYomiEvent</code>](#NachYomiEvent)
2385
- <a name="YerushalmiYomiEvent"></a>
2386
-
2387
- ## YerushalmiYomiEvent
2388
- Event wrapper around a Yerushalmi Yomi result
2389
-
2390
- **Kind**: global class
2157
+ | name | <code>string</code> |
2158
+ | calendar | <code>function</code> |
2391
2159
 
2392
- * [YerushalmiYomiEvent](#YerushalmiYomiEvent)
2393
- * [new YerushalmiYomiEvent(date, daf)](#new_YerushalmiYomiEvent_new)
2394
- * [.render([locale])](#YerushalmiYomiEvent+render) ⇒ <code>string</code>
2395
- * [.renderBrief([locale])](#YerushalmiYomiEvent+renderBrief) ⇒ <code>string</code>
2396
- * [.url()](#YerushalmiYomiEvent+url) ⇒ <code>string</code>
2160
+ <a name="DailyLearning.lookup"></a>
2397
2161
 
2398
- <a name="new_YerushalmiYomiEvent_new"></a>
2162
+ ### DailyLearning.lookup(name, hd) ⇒ [<code>Event</code>](#Event)
2163
+ Returns an event from daily calendar for a given date. Returns `null` if there
2164
+ is no learning from this calendar on this date.
2399
2165
 
2400
- ### new YerushalmiYomiEvent(date, daf)
2166
+ **Kind**: static method of [<code>DailyLearning</code>](#DailyLearning)
2401
2167
 
2402
2168
  | Param | Type |
2403
2169
  | --- | --- |
2404
- | date | [<code>HDate</code>](#HDate) |
2405
- | daf | <code>any</code> |
2406
-
2407
- <a name="YerushalmiYomiEvent+render"></a>
2408
-
2409
- ### yerushalmiYomiEvent.render([locale]) ⇒ <code>string</code>
2410
- Returns name of tractate and page (e.g. "Yerushalmi Beitzah 21").
2411
-
2412
- **Kind**: instance method of [<code>YerushalmiYomiEvent</code>](#YerushalmiYomiEvent)
2413
-
2414
- | Param | Type | Description |
2415
- | --- | --- | --- |
2416
- | [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
2417
-
2418
- <a name="YerushalmiYomiEvent+renderBrief"></a>
2419
-
2420
- ### yerushalmiYomiEvent.renderBrief([locale]) ⇒ <code>string</code>
2421
- Returns name of tractate and page (e.g. "Beitzah 21").
2422
-
2423
- **Kind**: instance method of [<code>YerushalmiYomiEvent</code>](#YerushalmiYomiEvent)
2424
-
2425
- | Param | Type | Description |
2426
- | --- | --- | --- |
2427
- | [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
2428
-
2429
- <a name="YerushalmiYomiEvent+url"></a>
2430
-
2431
- ### yerushalmiYomiEvent.url() ⇒ <code>string</code>
2432
- Returns a link to sefaria.org
2170
+ | name | <code>string</code> |
2171
+ | hd | [<code>HDate</code>](#HDate) |
2433
2172
 
2434
- **Kind**: instance method of [<code>YerushalmiYomiEvent</code>](#YerushalmiYomiEvent)
2435
2173
  <a name="HebrewCalendar"></a>
2436
2174
 
2437
2175
  ## HebrewCalendar
@@ -2488,14 +2226,16 @@ Set `options.il=true` to use the Israeli schedule.
2488
2226
  Additional non-default event types can be specified:
2489
2227
  * Parashat HaShavua - weekly Torah Reading on Saturdays (`options.sedrot`)
2490
2228
  * Counting of the Omer (`options.omer`)
2491
- * Babylonian Talmud Daf Yomi (`options.dafyomi`)
2492
- * Jerusalem Talmud (Yerushalmi) Yomi (`options.yerushalmi`)
2493
- * Mishna Yomi (`options.mishnaYomi`)
2494
- * Nach Yomi (`options.nachYomi`)
2495
2229
  * Shabbat Mevarchim HaChodesh on Saturday before Rosh Chodesh (`options.shabbatMevarchim`)
2496
2230
  * Molad announcement on Saturday before Rosh Chodesh (`options.molad`)
2497
2231
  * Yom Kippur Katan (`options.yomKippurKatan`)
2498
2232
 
2233
+ Daily Study of texts:
2234
+ * Babylonian Talmud Daf Yomi (`options.dailyLearning.dafYomi`)
2235
+ * Jerusalem Talmud (Yerushalmi) Yomi (`options.dailyLearning.yerushalmi`)
2236
+ * Mishna Yomi (`options.dailyLearning.mishnaYomi`)
2237
+ * Nach Yomi (`options.dailyLearning.nachYomi`)
2238
+
2499
2239
  Candle-lighting and Havdalah times are approximated using latitude and longitude
2500
2240
  specified by the [Location](#Location) class. The `Location` class contains a small
2501
2241
  database of cities with their associated geographic information and time-zone information.
@@ -2928,20 +2668,6 @@ Clamen, Software--Practice and Experience, Volume 23, Number 4
2928
2668
  The 54 parshiyot of the Torah as transilterated strings
2929
2669
  parshiot[0] == 'Bereshit', parshiot[1] == 'Noach', parshiot[53] == "Ha'Azinu".
2930
2670
 
2931
- **Kind**: global constant
2932
- **Read only**: true
2933
- <a name="vilna"></a>
2934
-
2935
- ## vilna
2936
- Yerushalmi Yomi configuration for Vilna Edition
2937
-
2938
- **Kind**: global constant
2939
- **Read only**: true
2940
- <a name="schottenstein"></a>
2941
-
2942
- ## schottenstein
2943
- Yerushalmi Yomi configuration for Schottenstein Edition
2944
-
2945
2671
  **Kind**: global constant
2946
2672
  **Read only**: true
2947
2673
  <a name="gematriya"></a>
@@ -2966,30 +2692,6 @@ gematriya(60) // 'ס׳'
2966
2692
  gematriya(3761) // 'ג׳תשס״א'
2967
2693
  gematriya(1123) // 'א׳קכ״ג'
2968
2694
  ```
2969
- <a name="yerushalmiYomi"></a>
2970
-
2971
- ## yerushalmiYomi(date, config) ⇒ <code>any</code>
2972
- Using the Vilna edition, the Yerushalmi Daf Yomi program takes
2973
- ~4.25 years or 51 months.
2974
- Unlike the Daf Yomi Bavli cycle, this Yerushalmi cycle skips both
2975
- Yom Kippur and Tisha B'Av (returning `null`).
2976
- The page numbers are according to the Vilna
2977
- Edition which is used since 1900.
2978
-
2979
- The Schottenstein edition uses different page numbers and takes
2980
- ~6 years to complete.
2981
-
2982
- Throws an exception if the date is before Daf Yomi Yerushalmi
2983
- cycle began (2 February 1980 for Vilna,
2984
- 14 November 2022 for Schottenstein).
2985
-
2986
- **Kind**: global function
2987
-
2988
- | Param | Type | Description |
2989
- | --- | --- | --- |
2990
- | date | [<code>HDate</code>](#HDate) \| <code>Date</code> \| <code>number</code> | Hebrew or Gregorian date |
2991
- | config | <code>any</code> | either vilna or schottenstein |
2992
-
2993
2695
  <a name="ZmanimTimesResult"></a>
2994
2696
 
2995
2697
  ## ZmanimTimesResult : <code>Object</code>
@@ -3030,32 +2732,6 @@ Result of Sedra.lookup
3030
2732
  | chag | <code>boolean</code> | True if this is a regular parasha HaShavua Torah reading, false if it's a special holiday reading |
3031
2733
  | 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]` |
3032
2734
 
3033
- <a name="MishnaYomi"></a>
3034
-
3035
- ## MishnaYomi : <code>Object</code>
3036
- Describes a mishna to be read
3037
-
3038
- **Kind**: global typedef
3039
- **Properties**
3040
-
3041
- | Name | Type | Description |
3042
- | --- | --- | --- |
3043
- | k | <code>string</code> | tractate name in Sephardic transliteration (e.g. "Berakhot", "Moed Katan") |
3044
- | v | <code>string</code> | verse (e.g. "2:1") |
3045
-
3046
- <a name="NachYomi"></a>
3047
-
3048
- ## NachYomi : <code>Object</code>
3049
- Describes a chapter to be read
3050
-
3051
- **Kind**: global typedef
3052
- **Properties**
3053
-
3054
- | Name | Type | Description |
3055
- | --- | --- | --- |
3056
- | k | <code>string</code> | book name in Sephardic transliteration (e.g. "Berakhot", "Moed Katan") |
3057
- | v | <code>number</code> | chapter (e.g. "2:1") |
3058
-
3059
2735
  <a name="CalOptions"></a>
3060
2736
 
3061
2737
  ## CalOptions : <code>Object</code>
@@ -3085,11 +2761,6 @@ Options to configure which events are returned
3085
2761
  | shabbatMevarchim | <code>boolean</code> | add Shabbat Mevarchim |
3086
2762
  | noSpecialShabbat | <code>boolean</code> | suppress Special Shabbat |
3087
2763
  | noHolidays | <code>boolean</code> | suppress regular holidays |
3088
- | dafyomi | <code>boolean</code> | Babylonian Talmud Daf Yomi |
3089
- | yerushalmi | <code>boolean</code> | Jerusalem Talmud (Yerushalmi) Yomi |
3090
- | yerushalmiEdition | <code>number</code> | Use 1 for Vilna, 2 for Schottenstein |
3091
- | mishnaYomi | <code>boolean</code> | include Mishna Yomi |
3092
- | nachYomi | <code>boolean</code> | include Nach Yomi |
3093
2764
  | omer | <code>boolean</code> | include Days of the Omer |
3094
2765
  | molad | <code>boolean</code> | include event announcing the molad |
3095
2766
  | ashkenazi | <code>boolean</code> | use Ashkenazi transliterations for event titles (default Sephardi transliterations) |
@@ -3099,6 +2770,7 @@ Options to configure which events are returned
3099
2770
  | mask | <code>number</code> | use bitmask from `flags` to filter events |
3100
2771
  | 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) |
3101
2772
  | 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. |
2773
+ | 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). |
3102
2774
 
3103
2775
  <a name="TachanunResult"></a>
3104
2776