@hebcal/leyning - npm Package Compare versions

Comparing version 4.10.0 to 4.10.1

leyning.d.ts

@@ -70,2 +70,7 @@ /// <reference types="node"/>
     /**
+     * Makes a summary of the leyning, like "Genesis 6:9-11:32"
+     */
+    export function makeLeyningSummary(aliyot: AliyotMap): string;
+
+    /**
      * Based on the event date, type and title, finds the relevant leyning key
@@ -157,2 +162,3 @@ * @param e - event
     export const holidayReadings: any;
+    export const BOOK: string[];
 
@@ -159,0 +165,0 @@ export function writeTriennialCsv(stream: WriteStream, hyear: number): void;

package.json

 {
   "name": "@hebcal/leyning",
-  "version": "4.10.0",
+  "version": "4.10.1",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
@@ -34,3 +34,3 @@ "keywords": [
   "dependencies": {
-    "@hebcal/core": "^3.26.4"
+    "@hebcal/core": "^3.26.7"
   },
@@ -68,14 +68,14 @@ "scripts": {
     "@rollup/plugin-babel": "^5.3.0",
-    "@rollup/plugin-commonjs": "^20.0.0",
+    "@rollup/plugin-commonjs": "^21.0.1",
     "@rollup/plugin-json": "^4.1.0",
-    "@rollup/plugin-node-resolve": "^13.0.5",
+    "@rollup/plugin-node-resolve": "^13.0.6",
     "ava": "^3.15.0",
-    "core-js": "^3.18.2",
-    "eslint": "^7.32.0",
+    "core-js": "^3.19.0",
+    "eslint": "^8.0.0",
     "eslint-config-google": "^0.14.0",
     "jsdoc": "^3.6.7",
-    "jsdoc-to-markdown": "^7.0.1",
-    "rollup": "^2.58.0",
+    "jsdoc-to-markdown": "^7.1.0",
+    "rollup": "^2.58.3",
     "rollup-plugin-terser": "^7.0.2"
   }
 }

README.md

@@ -58,3 +58,3 @@ # @hebcal/leyning
 <dl>
-<dt><a href="#addSefariaLinksToLeyning">addSefariaLinksToLeyning(aliyot, showBook)</a></dt>
+<dt><del><a href="#addSefariaLinksToLeyning">addSefariaLinksToLeyning(aliyot, showBook)</a></del></dt>
 <dd><p>Makes Sefaria links by adding <code>href</code>, <code>verses</code> and <code>num</code> attributes to each aliyah.
@@ -71,3 +71,4 @@ CAUTION: Modifies the <code>aliyot</code> parameter instead of making a copy.</p>
 <dt><a href="#makeLeyningSummary">makeLeyningSummary(aliyot)</a> ⇒ <code>string</code></dt>
-<dd></dd>
+<dd><p>Makes a summary of the leyning, like &quot;Genesis 6:9-11:32&quot;</p>
+</dd>
 <dt><a href="#getLeyningForHolidayKey">getLeyningForHolidayKey(key)</a> ⇒ <code><a href="#Leyning">Leyning</a></code></dt>
@@ -78,11 +79,2 @@ <dd><p>Looks up leyning for a given holiday key. Key should be an
 </dd>
-<dt><a href="#getHaftaraKey">getHaftaraKey(parsha)</a> ⇒ <code>string</code></dt>
-<dd><p>on doubled parshiot, read only the second Haftarah
-except for Nitzavim-Vayelech</p>
-</dd>
-<dt><a href="#getChanukahShabbatKey">getChanukahShabbatKey(e, key)</a> ⇒ <code>string</code></dt>
-<dd></dd>
-<dt><a href="#getHolidayEvents">getHolidayEvents(hd, il)</a> ⇒ <code>Array.&lt;Event&gt;</code></dt>
-<dd><p>Filters out Rosh Chodesh and events that don&#39;t occur in this location</p>
-</dd>
 <dt><a href="#getLeyningForParsha">getLeyningForParsha(parsha)</a> ⇒ <code><a href="#Leyning">Leyning</a></code></dt>
@@ -100,5 +92,2 @@ <dd><p>Looks up regular leyning for a weekly parsha with no special readings</p>
 </dd>
-<dt><a href="#getDoubledName">getDoubledName(id)</a> ⇒ <code>string</code></dt>
-<dd><p>takes a 0-based (Bereshit=0) parsha ID</p>
-</dd>
 <dt><a href="#getTriennial">getTriennial(year)</a> ⇒ <code><a href="#Triennial">Triennial</a></code></dt>
@@ -138,2 +127,3 @@ <dd><p>Calculates the 3-year readings for a given year</p>
         * [.getStartYear()](#Triennial+getStartYear) ⇒ <code>number</code>
+        * [.debug()](#Triennial+debug) ⇒ <code>string</code>
     * _static_
@@ -168,2 +158,6 @@ * [.getYearNumber(year)](#Triennial.getYearNumber) ⇒ <code>number</code>
 **Kind**: instance method of [<code>Triennial</code>](#Triennial)  
+<a name="Triennial+debug"></a>
+
+### triennial.debug() ⇒ <code>string</code>
+**Kind**: instance method of [<code>Triennial</code>](#Triennial)  
 <a name="Triennial.getYearNumber"></a>
@@ -199,3 +193,5 @@
 
-## addSefariaLinksToLeyning(aliyot, showBook)
+## ~~addSefariaLinksToLeyning(aliyot, showBook)~~
+***Deprecated***
+
 Makes Sefaria links by adding `href`, `verses` and `num` attributes to each aliyah.
@@ -241,2 +237,4 @@ CAUTION: Modifies the `aliyot` parameter instead of making a copy.
 ## makeLeyningSummary(aliyot) ⇒ <code>string</code>
+Makes a summary of the leyning, like "Genesis 6:9-11:32"
+
 **Kind**: global function  
@@ -262,36 +260,2 @@
 
-<a name="getHaftaraKey"></a>
-
-## getHaftaraKey(parsha) ⇒ <code>string</code>
-on doubled parshiot, read only the second Haftarah
-except for Nitzavim-Vayelech
-
-**Kind**: global function  
-
-| Param | Type |
-| --- | --- |
-| parsha | <code>Array.&lt;string&gt;</code> | 
-
-<a name="getChanukahShabbatKey"></a>
-
-## getChanukahShabbatKey(e, key) ⇒ <code>string</code>
-**Kind**: global function  
-
-| Param | Type |
-| --- | --- |
-| e | <code>Event</code> | 
-| key | <code>string</code> | 
-
-<a name="getHolidayEvents"></a>
-
-## getHolidayEvents(hd, il) ⇒ <code>Array.&lt;Event&gt;</code>
-Filters out Rosh Chodesh and events that don't occur in this location
-
-**Kind**: global function  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| hd | <code>HDate</code> | Hebrew date |
-| il | <code>boolean</code> | in Israel |
-
 <a name="getLeyningForParsha"></a>
@@ -309,2 +273,6 @@
 
+<a name="getLeyningForParsha..result"></a>
+
+### getLeyningForParsha~result : [<code>Leyning</code>](#Leyning)
+**Kind**: inner constant of [<code>getLeyningForParsha</code>](#getLeyningForParsha)  
 <a name="getLeyningForParshaHaShavua"></a>
@@ -346,13 +314,2 @@
 
-<a name="getDoubledName"></a>
-
-## getDoubledName(id) ⇒ <code>string</code>
-takes a 0-based (Bereshit=0) parsha ID
-
-**Kind**: global function  
-
-| Param | Type |
-| --- | --- |
-| id | <code>number</code> | 
-
 <a name="getTriennial"></a>
@@ -410,4 +367,7 @@
 | haftara | <code>string</code> | Haftarah |
-| sephardic | <code>string</code> | Haftarah for Sephardic |
+| [haftaraNumV] | <code>number</code> |  |
+| [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> |  |
@@ -414,0 +374,0 @@

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

541981

increased by0.62%

Lines of code

6264

increased by1.66%

Worsened metrics

Number of lines in readme file

379

decreased by-9.55%

Dependency changes

• Updated@hebcal/core@^3.26.7