@hebcal/leyning - npm Package Compare versions

Comparing version 4.18.1 to 4.18.2

leyning.d.ts

@@ -64,3 +64,13 @@ /// <reference types="node"/>
     /**
-     * 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 {@link getLeyningForHoliday})
+     *
+     * Otherwise, if `hdate` is a Saturday, returns {@link getLeyningForParshaHaShavua}
+     *
+     * Otherwise, if `hdate` is a Monday or Thursday, returns {@link Leyning} for the
+     * Parashat haShavua, containing only the `weekday` aliyot (no `fullkriyah`).
+     *
+     * Otherwise, returns `undefined`.
      * @param hdate Hebrew Date
@@ -97,7 +107,7 @@ * @param il in Israel
      * Based on the event date, type and title, finds the relevant leyning key
-     * @param e - event
+     * @param ev - the Hebcal holiday event
      * @param [il] - true if Israel holiday scheme
      * @returns key to look up in holiday-reading.json
      */
-    export function getLeyningKeyForEvent(e: Event, il?: boolean): string;
+    export function getLeyningKeyForEvent(ev: Event, il?: boolean): string;
 
@@ -107,7 +117,7 @@ /**
      * of full kriyah aliyot, special Maftir, special Haftarah
-     * @param e - the Hebcal event associated with this leyning
+     * @param ev - the Hebcal event associated with this leyning
      * @param [il] - true if Israel holiday scheme
      * @returns map of aliyot
      */
-    export function getLeyningForHoliday(e: Event, il?: boolean): Leyning;
+    export function getLeyningForHoliday(ev: Event, il?: boolean): Leyning;
 
@@ -124,8 +134,9 @@ /**
     /**
-     * Looks up leyning for a regular Shabbat parsha.
-     * @param e - the Hebcal event associated with this leyning
+     * Looks up leyning for a regular Shabbat parsha, including any special
+     * maftir or Haftara.
+     * @param ev - the Hebcal event associated with this leyning
      * @param [il] - in Israel
      * @returns map of aliyot
      */
-    export function getLeyningForParshaHaShavua(e: Event, il?: boolean): Leyning;
+    export function getLeyningForParshaHaShavua(ev: Event, il?: boolean): Leyning;
 
@@ -132,0 +143,0 @@ /**

package.json

 {
   "name": "@hebcal/leyning",
-  "version": "4.18.1",
+  "version": "4.18.2",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -109,6 +109,13 @@ # @hebcal/leyning
 <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>
@@ -324,3 +331,4 @@ <dt><a href="#getTriennial">getTriennial(year)</a> ⇒ <code><a href="#Triennial">Triennial</a></code></dt>
 ## 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.
 
@@ -338,4 +346,14 @@ **Kind**: global function
 ## 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  
@@ -342,0 +360,0 @@ **Returns**: [<code>Leyning</code>](#Leyning) - map of aliyot

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

678069

increased by1.05%

Lines of code

8215

increased by1.9%

Number of lines in readme file

453

increased by4.14%

No dependency changes