@hebcal/leyning 4.18.0 → 4.19.0

package/README.md

@@ -106,10 +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 or holiday</p>
+<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>
@@ -128,6 +135,9 @@ of full kriyah aliyot, special Maftir, special Haftarah</p>
 <dt><a href="#Aliyah">Aliyah</a> : <code>Object</code></dt>
 <dd><p>Represents an aliyah</p>
 </dd>
+<dt><a href="#LeyningNames">LeyningNames</a> : <code>Object</code></dt>
+<dd><p>Name of the parsha hashavua or holiday</p>
+</dd>
 <dt><a href="#Leyning">Leyning</a> : <code>Object</code></dt>
 <dd><p>Leyning for a parsha hashavua or holiday</p>
 </dd>
@@ -320,7 +330,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  
@@ -333,7 +344,17 @@ Looks up leyning for a regular Shabbat parsha.
 <a name="getLeyningOnDate"></a>
 
 ## getLeyningOnDate(hdate, il) ⇒ [<code>Leyning</code>](#Leyning)
-Looks up leyning for a regular Shabbat or holiday
+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  
@@ -395,6 +416,19 @@ Represents an aliyah
 | [v] | <code>number</code> | number of verses |
 | [p] | <code>number</code> | parsha number (1=Bereshit, 54=Vezot HaBracha) |
 
+<a name="LeyningNames"></a>
+
+## LeyningNames : <code>Object</code>
+Name of the parsha hashavua or holiday
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| en | <code>string</code> | English |
+| he | <code>string</code> | Hebrew (with nikud) |
+
 <a name="Leyning"></a>
 
 ## Leyning : <code>Object</code>
@@ -405,16 +439,19 @@ Leyning for a parsha hashavua or holiday
 
 | Name | Type | Description |
 | --- | --- | --- |
-| summary | <code>string</code> |  |
-| haft | [<code>Aliyah</code>](#Aliyah) | Haftarah |
-| haftara | <code>string</code> | Haftarah |
-| [haftaraNumV] | <code>number</code> |  |
-| [seph] | [<code>Aliyah</code>](#Aliyah) | Haftarah for Sephardic |
-| [sephardic] | <code>string</code> | Haftarah for Sephardic |
-| [sephardicNumV] | <code>number</code> |  |
-| fullkriyah | <code>Object.&lt;string, Aliyah&gt;</code> |  |
-| [weekday] | <code>Object.&lt;string, Aliyah&gt;</code> |  |
-| [reason] | <code>Object</code> |  |
+| name | [<code>LeyningNames</code>](#LeyningNames) |  |
+| [parsha] | <code>Array.&lt;string&gt;</code> | An array of either 1 (regular) or 2 (doubled parsha).    `undefined` for holiday readings |
+| [parshaNum] | <code>num</code> | 1 for Bereshit, 2 for Noach, etc. `undefined` for holiday readings |
+| summary | <code>string</code> | Such as `Genesis 1:1 - 6:8` |
+| haft | [<code>Aliyah</code>](#Aliyah) \| [<code>Array.&lt;Aliyah&gt;</code>](#Aliyah) | Haftarah object(s) |
+| haftara | <code>string</code> | Haftarah, such as `Isaiah 42:5 – 43:11` |
+| [haftaraNumV] | <code>number</code> | Number of verses in the Haftarah |
+| [seph] | [<code>Aliyah</code>](#Aliyah) \| [<code>Array.&lt;Aliyah&gt;</code>](#Aliyah) | Haftarah object(s) for Sephardim |
+| [sephardic] | <code>string</code> | Haftarah for Sephardim, such as `Isaiah 42:5 - 42:21` |
+| [sephardicNumV] | <code>number</code> | Number of verses in the Haftarah for Sephardim |
+| fullkriyah | <code>Object.&lt;string, Aliyah&gt;</code> | Map of aliyot `1` through `7` plus `M` for maftir |
+| [weekday] | <code>Object.&lt;string, Aliyah&gt;</code> | Optional map of weekday Torah Readings    aliyot `1` through `3` for Monday and Thursday |
+| [reason] | <code>Object</code> | Explanations for special readings,    keyed by aliyah number, `M` for maftir or `haftara` for Haftarah |
 
 <a name="TriennialAliyot"></a>