@hebcal/leyning 4.17.0 → 4.18.2

package/README.md

@@ -23,6 +23,7 @@ the third section of the parashah.
 
 [Modification of the Triennial Cycle Readings for Combined Parashot in Certain Years](https://www.rabbinicalassembly.org/sites/default/files/2021-09/cohen-triennial.pdf), Rabbi Miles B. Cohen
 
+Update August 2022: Incorporated [An Emendation to Richard Eisenberg’s Complete Triennial System for Reading Torah, to Address a Rare Situation](https://www.rabbinicalassembly.org/sites/default/files/public/halakhah/teshuvot/2011-2020/heller-triennial-emendation.pdf), Rabbi Joshua Heller, 2012
 
 ## Installation
 ```bash
@@ -105,7 +106,17 @@ of full kriyah aliyot, special Maftir, special Haftarah</p>
 <dd><p>Looks up regular leyning for a weekly parsha with no special readings</p>
 </dd>
 <dt><a href="#getLeyningForParshaHaShavua">getLeyningForParshaHaShavua(ev, [il])</a> ⇒ <code><a href="#Leyning">Leyning</a></code></dt>
-<dd><p>Looks up leyning for a regular Shabbat parsha.</p>
+<dd><p>Looks up leyning for a regular Shabbat parsha, including any special
+maftir or Haftara.</p>
+</dd>
+<dt><a href="#getLeyningOnDate">getLeyningOnDate(hdate, il)</a> ⇒ <code><a href="#Leyning">Leyning</a></code></dt>
+<dd><p>Looks up leyning for a regular Shabbat, Monday/Thursday weekday or holiday.</p>
+<p>If <code>hdate</code> coincides with a holiday that has Torah reading, returns the
+reading for that day (see <a href="#getLeyningForHoliday">getLeyningForHoliday</a>)</p>
+<p>Otherwise, if <code>hdate</code> is a Saturday, returns <a href="#getLeyningForParshaHaShavua">getLeyningForParshaHaShavua</a></p>
+<p>Otherwise, if <code>hdate</code> is a Monday or Thursday, returns <a href="#Leyning">Leyning</a> for the
+Parashat haShavua, containing only the <code>weekday</code> aliyot (no <code>fullkriyah</code>).</p>
+<p>Otherwise, returns <code>undefined</code>.</p>
 </dd>
 <dt><a href="#getTriennial">getTriennial(year)</a> ⇒ <code><a href="#Triennial">Triennial</a></code></dt>
 <dd><p>Calculates the 3-year readings for a given year</p>
@@ -113,6 +124,9 @@ of full kriyah aliyot, special Maftir, special Haftarah</p>
 <dt><a href="#getTriennialForParshaHaShavua">getTriennialForParshaHaShavua(ev, [context])</a> ⇒ <code><a href="#TriennialAliyot">TriennialAliyot</a></code> | <code>Object.&lt;string, Aliyah&gt;</code></dt>
 <dd><p>Looks up the triennial leyning for this Parashat HaShavua</p>
 </dd>
+<dt><a href="#getTriennialHaftaraForHoliday">getTriennialHaftaraForHoliday(key, yearNum)</a> ⇒ <code>Object</code></dt>
+<dd><p>Looks up the alternative triennial Haftara for a holiday</p>
+</dd>
 </dl>
 
 ## Typedefs
@@ -313,7 +327,8 @@ Looks up regular leyning for a weekly parsha with no special readings
 <a name="getLeyningForParshaHaShavua"></a>
 
 ## getLeyningForParshaHaShavua(ev, [il]) ⇒ [<code>Leyning</code>](#Leyning)
-Looks up leyning for a regular Shabbat parsha.
+Looks up leyning for a regular Shabbat parsha, including any special
+maftir or Haftara.
 
 **Kind**: global function  
 **Returns**: [<code>Leyning</code>](#Leyning) - map of aliyot  
@@ -323,6 +338,29 @@ Looks up leyning for a regular Shabbat parsha.
 | ev | <code>Event</code> |  | the Hebcal event associated with this leyning |
 | [il] | <code>boolean</code> | <code>false</code> | in Israel |
 
+<a name="getLeyningOnDate"></a>
+
+## getLeyningOnDate(hdate, il) ⇒ [<code>Leyning</code>](#Leyning)
+Looks up leyning for a regular Shabbat, Monday/Thursday weekday or holiday.
+
+If `hdate` coincides with a holiday that has Torah reading, returns the
+reading for that day (see [getLeyningForHoliday](#getLeyningForHoliday))
+
+Otherwise, if `hdate` is a Saturday, returns [getLeyningForParshaHaShavua](#getLeyningForParshaHaShavua)
+
+Otherwise, if `hdate` is a Monday or Thursday, returns [Leyning](#Leyning) for the
+Parashat haShavua, containing only the `weekday` aliyot (no `fullkriyah`).
+
+Otherwise, returns `undefined`.
+
+**Kind**: global function  
+**Returns**: [<code>Leyning</code>](#Leyning) - map of aliyot  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| hdate | <code>HDate</code> | Hebrew Date |
+| il | <code>boolean</code> | in Israel |
+
 <a name="getTriennial"></a>
 
 ## getTriennial(year) ⇒ [<code>Triennial</code>](#Triennial)
@@ -347,6 +385,18 @@ Looks up the triennial leyning for this Parashat HaShavua
 | ev | <code>Event</code> |  |  |
 | [context] | <code>boolean</code> | <code>false</code> | returns a reading wrapper object which includes `date`, `yearNum` and `aliyot` |
 
+<a name="getTriennialHaftaraForHoliday"></a>
+
+## getTriennialHaftaraForHoliday(key, yearNum) ⇒ <code>Object</code>
+Looks up the alternative triennial Haftara for a holiday
+
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| key | <code>string</code> | 
+| yearNum | <code>number</code> | 
+
 <a name="Aliyah"></a>
 
 ## Aliyah : <code>Object</code>