@hebcal/leyning - npm Package Compare versions

Comparing version 4.9.1 to 4.9.2

leyning.d.ts

@@ -9,13 +9,13 @@ /// <reference types="node"/>
      * Represents an aliyah
-     * @property k - Book (e.g. "Numbers")
-     * @property b - beginning verse (e.g. "28:9")
-     * @property e - ending verse (e.g. "28:15")
-     * @property [v] - number of verses
-     * @property [p] - parsha number (1=Bereshit, 54=Vezot HaBracha)
      */
     export type Aliyah = {
+        /** Book (e.g. "Numbers") */
         k: string;
+        /** beginning verse (e.g. "28:9") */
         b: string;
+        /** ending verse (e.g. "28:15") */
         e: string;
+        /** number of verses */
         v?: number;
+        /** parsha number (1=Bereshit, 54=Vezot HaBracha) */
         p?: number;
@@ -30,10 +30,15 @@ };
      * Leyning for a parsha hashavua or holiday
-     * @property haftara - Haftarah
-     * @property sephardic - Haftarah for Sephardic
      */
     export type Leyning = {
+        /** Such as `Genesis 1:1 - 6:8` */
         summary: string;
+        /** Haftarah, such as `Isaiah 42:5 – 43:11` */
         haftara: string;
+        /** Haftarah for Sephardic, such as `Isaiah 42:5 - 42:21` */
         sephardic?: string;
+        /** Map of aliyot `1` through `7` plus `M` for maftir */
         fullkriyah: AliyotMap;
+        /** Optional map of weekday Torah Readings aliyot `1` through `3` for Monday and Thursday */
+        weekday?: AliyotMap;
+        /** Explanations for special readings, keyed by aliyah number, `M` for maftir or `H` for Haftarah */
         reason?: {
@@ -46,15 +51,15 @@ [key: string]: string;
      * Represents triennial aliyot for a given date
-     * @property aliyot - a map of aliyot 1-7 plus "M"
-     * @property yearNum - year number, 0-2
-     * @property date - Shabbat date for when this parsha is read in this 3-year cycle
-     * @property [readSeparately] - true if a double parsha is read separately in year `yearNum`
-     * @property [date1] - Shabbat date of the first part of a read-separately aliyah pair
-     * @property [date2] - Shabbat date of the second part of a read-separately aliyah pair
      */
     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;
@@ -157,2 +162,3 @@ };
      * CAUTION: Modifies the `aliyot` parameter instead of making a copy.
+     * @deprecated
      * @param aliyot - aliyah map to decorate
@@ -159,0 +165,0 @@ * @param showBook - display the book name in the `verses` field (e.g. for special Maftir)

package.json

 {
   "name": "@hebcal/leyning",
-  "version": "4.9.1",
+  "version": "4.9.2",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
@@ -34,3 +34,3 @@ "keywords": [
   "dependencies": {
-    "@hebcal/core": "^3.26.2"
+    "@hebcal/core": "^3.26.4"
   },
@@ -72,3 +72,3 @@ "scripts": {
     "ava": "^3.15.0",
-    "core-js": "^3.18.0",
+    "core-js": "^3.18.1",
     "eslint": "^7.32.0",
@@ -75,0 +75,0 @@ "eslint-config-google": "^0.14.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

533401

increased by0.09%

Lines of code

6037

increased by0.2%

Dependency changes

• Updated@hebcal/core@^3.26.4