@hebcal/triennial - npm Package Compare versions

Comparing version 1.2.0 to 1.3.0

package.json

 {
   "name": "@hebcal/triennial",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Javascript Triennial Torah Readings",
@@ -29,4 +29,4 @@ "main": "./dist/index.js",
   "dependencies": {
-    "@hebcal/core": "^4.0.0",
-    "@hebcal/leyning": "^7.3.0"
+    "@hebcal/core": "^4.0.3",
+    "@hebcal/leyning": "^7.4.1"
   },
@@ -48,18 +48,18 @@ "typings": "types.d.ts",
   "devDependencies": {
-    "@babel/core": "^7.21.5",
-    "@babel/preset-env": "^7.21.5",
+    "@babel/core": "^7.22.1",
+    "@babel/preset-env": "^7.22.2",
     "@babel/register": "^7.21.0",
     "@rollup/plugin-babel": "^6.0.3",
-    "@rollup/plugin-commonjs": "^24.1.0",
+    "@rollup/plugin-commonjs": "^25.0.0",
     "@rollup/plugin-json": "^6.0.0",
     "@rollup/plugin-node-resolve": "^15.0.2",
-    "@rollup/plugin-terser": "^0.4.1",
-    "ava": "^5.2.0",
-    "core-js": "^3.30.1",
-    "eslint": "^8.39.0",
+    "@rollup/plugin-terser": "^0.4.3",
+    "ava": "^5.3.0",
+    "core-js": "^3.30.2",
+    "eslint": "^8.41.0",
     "eslint-config-google": "^0.14.0",
     "jsdoc": "^4.0.2",
     "jsdoc-to-markdown": "^8.0.0",
-    "rollup": "^3.21.0"
+    "rollup": "^3.23.0"
   }
 }

README.md

@@ -57,11 +57,11 @@ # @hebcal/triennial
 <dl>
-<dt><a href="#getTriennial">getTriennial(year)</a> ⇒ <code><a href="#Triennial">Triennial</a></code></dt>
+<dt><a href="#getTriennial">getTriennial(year, [il])</a> ⇒ <code><a href="#Triennial">Triennial</a></code></dt>
 <dd><p>Calculates the 3-year readings for a given year</p>
 </dd>
-<dt><a href="#getTriennialForParshaHaShavua">getTriennialForParshaHaShavua(ev)</a> ⇒ <code><a href="#TriennialAliyot">TriennialAliyot</a></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>
+<dt><a href="#getTriennialForParshaHaShavua">getTriennialForParshaHaShavua(ev, [il])</a> ⇒ <code><a href="#TriennialAliyot">TriennialAliyot</a></code></dt>
+<dd><p>Looks up the triennial leyning for this Parashat HaShavua</p>
+</dd>
 </dl>
@@ -85,3 +85,3 @@
 * [Triennial](#Triennial)
-    * [new Triennial([hebrewYear])](#new_Triennial_new)
+    * [new Triennial([hebrewYear], [il])](#new_Triennial_new)
     * _instance_
@@ -97,9 +97,10 @@ * [.getReading(parsha, yearNum)](#Triennial+getReading) ⇒ <code>Object.&lt;string, Aliyah&gt;</code>
 
-### new Triennial([hebrewYear])
-Builds a Triennial object
+### new Triennial([hebrewYear], [il])
+Calculates Triennial schedule for entire Hebrew year
 
 
-| Param | Type | Description |
-| --- | --- | --- |
-| [hebrewYear] | <code>number</code> | Hebrew Year (default current year) |
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| [hebrewYear] | <code>number</code> |  | Hebrew Year (default current year) |
+| [il] | <code>boolean</code> | <code>false</code> | Israel (default false) |
 
@@ -149,3 +150,3 @@ <a name="Triennial+getReading"></a>
 
-## getTriennial(year) ⇒ [<code>Triennial</code>](#Triennial)
+## getTriennial(year, [il]) ⇒ [<code>Triennial</code>](#Triennial)
 Calculates the 3-year readings for a given year
@@ -155,18 +156,7 @@
 
-| Param | Type | Description |
-| --- | --- | --- |
-| year | <code>number</code> | Hebrew year |
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| year | <code>number</code> |  | Hebrew year |
+| [il] | <code>boolean</code> | <code>false</code> | Israel |
 
-<a name="getTriennialForParshaHaShavua"></a>
-
-## getTriennialForParshaHaShavua(ev) ⇒ [<code>TriennialAliyot</code>](#TriennialAliyot)
-Looks up the triennial leyning for this Parashat HaShavua
-
-**Kind**: global function  
-**Returns**: [<code>TriennialAliyot</code>](#TriennialAliyot) - a map of aliyot 1-7 plus "M"  
-
-| Param | Type |
-| --- | --- |
-| ev | <code>Event</code> | 
-
 <a name="getTriennialHaftaraForHoliday"></a>
@@ -184,2 +174,15 @@
 
+<a name="getTriennialForParshaHaShavua"></a>
+
+## getTriennialForParshaHaShavua(ev, [il]) ⇒ [<code>TriennialAliyot</code>](#TriennialAliyot)
+Looks up the triennial leyning for this Parashat HaShavua
+
+**Kind**: global function  
+**Returns**: [<code>TriennialAliyot</code>](#TriennialAliyot) - a map of aliyot 1-7 plus "M"  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| ev | <code>Event</code> |  |  |
+| [il] | <code>boolean</code> | <code>false</code> | Israel |
+
 <a name="TriennialAliyot"></a>
@@ -186,0 +189,0 @@

types.d.ts

@@ -30,3 +30,8 @@ /// <reference types="node"/>
     export class Triennial {
-        constructor(hebrewYear: number);
+        /**
+         * Calculates Triennial schedule for entire Hebrew year
+         * @param hebrewYear - Hebrew Year (default current year)
+         * @param il - Israel (default false)
+         */
+        constructor(hebrewYear: number, il?: boolean);
         getReading(parsha: string, yearNum: number): TriennialAliyot;
@@ -50,4 +55,5 @@ getStartYear(): number;
      * @param year - Hebrew year
+     * @param il - Israel (default false)
      */
-    export function getTriennial(year: number): Triennial;
+    export function getTriennial(year: number, il?: boolean): Triennial;
 
@@ -59,3 +65,3 @@ /**
      */
-    export function getTriennialForParshaHaShavua(ev: Event): TriennialAliyot;
+    export function getTriennialForParshaHaShavua(ev: Event, il?: boolean): TriennialAliyot;
 
@@ -62,0 +68,0 @@ export function getTriennialHaftaraForHoliday(holiday: string, yearNum: number): any;

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

331672

increased by1.02%

Lines of code

3498

increased by1.01%

Number of lines in readme file

199

increased by1.53%

Dependency changes

• Updated@hebcal/core@^4.0.3

• Updated@hebcal/leyning@^7.4.1