@hebcal/leyning - npm Package Compare versions

Comparing version 4.20.1 to 5.0.0

leyning.d.ts

@@ -31,4 +31,7 @@ /// <reference types="node"/>
     export type Leyning = {
+        /** Name of the parsha hashavua or holiday */
         name: {
+            /** English */
             en: string;
+            /** Hebrew (with nikud) */
             he: string;
@@ -83,20 +86,2 @@ };
     /**
-     * Represents triennial aliyot for a given date
-     */
-    export type TriennialAliyot = {
-        /** Map of aliyot `1` through `7` plus `M` for maftir */
-        aliyot: AliyotMap;
-        /** year number, 0-2 */
-        yearNum: number;
-        /** Shabbat date for when this parsha is read in this 3-year cycle */
-        date: Date;
-        /** true if a double parsha is read separately in year `yearNum` */
-        readSeparately?: boolean;
-        /** Shabbat date of the first part of a read-separately aliyah pair */
-        date1?: Date;
-        /** Shabbat date of the second part of a read-separately aliyah pair */
-        date2?: Date;
-    };
-
-    /**
      * Makes a summary of the leyning, like "Genesis 6:9-11:32"
@@ -159,2 +144,20 @@ */
     /**
+     * Represents triennial aliyot for a given date
+     */
+    export type TriennialAliyot = {
+        /** Map of aliyot `1` through `7` plus `M` for maftir */
+        aliyot: AliyotMap;
+        /** year number, 0-2 */
+        yearNum: number;
+        /** Shabbat date for when this parsha is read in this 3-year cycle */
+        date: Date;
+        /** true if a double parsha is read separately in year `yearNum` */
+        readSeparately?: boolean;
+        /** Shabbat date of the first part of a read-separately aliyah pair */
+        date1?: Date;
+        /** Shabbat date of the second part of a read-separately aliyah pair */
+        date2?: Date;
+    };
+
+    /**
      * Triennial Torah readings
@@ -188,11 +191,11 @@ */
      * @param ev - the Hebcal event associated with this parsha
-     * @param [context] returns a reading wrapper object which includes `date`, `yearNum` and `aliyot`
      * @returns a map of aliyot 1-7 plus "M"
      */
-    export function getTriennialForParshaHaShavua(ev: Event, context?: boolean): AliyotMap|TriennialAliyot;
+    export function getTriennialForParshaHaShavua(ev: Event): TriennialAliyot;
 
     export function getTriennialHaftaraForHoliday(holiday: string, yearNum: number): any;
 
-    export const parshiyot: any;
-    export const holidayReadings: any;
+    /**
+     * Names of the books of the Torah. BOOK[1] === 'Genesis'
+     */
     export const BOOK: string[];
@@ -202,11 +205,2 @@
     export function writeFullKriyahCsv(stream: WriteStream, hyear: number, il: boolean): void;
-
-    /**
-     * Makes Sefaria links by adding `href`, `verses` and `num` attributes to each aliyah.
-     * CAUTION: Modifies the `aliyot` parameter instead of making a copy.
-     * @deprecated
-     * @param aliyot - aliyah map to decorate
-     * @param showBook - display the book name in the `verses` field (e.g. for special Maftir)
-     */
-    export function addSefariaLinksToLeyning(aliyot: AliyotMap, showBook: boolean): void;
 }

package.json

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

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

Worsened metrics

Total package byte prevSize

604296

decreased by-9.27%

Lines of code

7169

decreased by-12.68%

No dependency changes