jcal-zmanim 1.2.1 → 1.2.2

package/dist/index.d.cts

@@ -31,8 +31,8 @@ declare class Location {
     static getLakewood(): Location;
 }
 
-type Time = { hour: number, minute: number, second?: number };
-type SunTimes = { sunrise?: Time, sunset?: Time };
+type Time = { hour: number, minute: number, second?: number };
+type SunTimes = { sunrise?: Time, sunset?: Time };
 type ZmanToShow = { id: number, desc: string, eng: string, heb: string, offset?: number, whichDaysFlags?: number };
 
 /**
@@ -176,6 +176,11 @@ declare class jDate {
      * @param {jDate} jd
      * */
     diffMonths(jd: jDate): number;
+    /**Gets the number of full months separating this Jewish Date and the given one.
+     * If the given date is before this one, the number will be negative.
+     * @param {jDate} jd
+     * */
+    diffFullMonths(jd: jDate): number;
     /**Gets the number of years separating this Jewish Date and the given one.
      *
      * Ignores the Day and Month properties:
@@ -185,6 +190,10 @@ declare class jDate {
      * If the given date is before this one, the number will be negative.
      * @param {jDate} jd*/
     diffYears(jd: jDate): number;
+    /**Gets the number of full years separating this Jewish Date and the given one.
+     * If the given date is before this one, the number will be negative.
+     * @param {jDate} jd*/
+    diffFullYears(jd: jDate): number;
     /**
      * Returns the current Jewish date in the format: Thursday, the 3rd of Kislev 5776.
      * @param {boolean} hideDayOfWeek
@@ -309,6 +318,21 @@ declare const DaysOfWeek: Readonly<{
     FRIDAY: 5;
     SHABBOS: 6;
 }>;
+declare const JewishMonthsNames: Readonly<{
+    NISSAN: 1;
+    IYAR: 2;
+    SIVAN: 3;
+    TAMUZ: 4;
+    AV: 5;
+    ELLUL: 6;
+    TISHREI: 7;
+    CHESHVAN: 8;
+    KISLEV: 9;
+    TEVES: 10;
+    SHVAT: 11;
+    ADAR: 12;
+    ADAR_SHEINI: 13;
+}>;
 declare const JewishMonthsEng: string[];
 declare const JewishMonthsHeb: string[];
 declare const SecularMonthsEng: string[];
@@ -895,4 +919,4 @@ declare function getNotifications(date: jDate | Date, time: Time, location: Loca
     tefillahNotes: string[];
 };
 
-export { Dafyomi, DaysOfWeek, DaysOfWeekEng, DaysOfWeekHeb, JewishMonthsEng, JewishMonthsHeb, Location, Locations, Molad, PirkeiAvos, SecularMonthsEng, Sedra, Utils, ZmanTypeIds, ZmanTypes, Zmanim, ZmanimUtils, closestDistanceMatch, closestNameMatch, findLocation, getNotifications, getZmanType, jDate };
+export { Dafyomi, DaysOfWeek, DaysOfWeekEng, DaysOfWeekHeb, JewishMonthsEng, JewishMonthsHeb, JewishMonthsNames, Location, Locations, Molad, PirkeiAvos, SecularMonthsEng, Sedra, Utils, ZmanTypeIds, ZmanTypes, Zmanim, ZmanimUtils, closestDistanceMatch, closestNameMatch, findLocation, getNotifications, getZmanType, jDate };

package/dist/index.d.ts

@@ -31,8 +31,8 @@ declare class Location {
     static getLakewood(): Location;
 }
 
-type Time = { hour: number, minute: number, second?: number };
-type SunTimes = { sunrise?: Time, sunset?: Time };
+type Time = { hour: number, minute: number, second?: number };
+type SunTimes = { sunrise?: Time, sunset?: Time };
 type ZmanToShow = { id: number, desc: string, eng: string, heb: string, offset?: number, whichDaysFlags?: number };
 
 /**
@@ -176,6 +176,11 @@ declare class jDate {
      * @param {jDate} jd
      * */
     diffMonths(jd: jDate): number;
+    /**Gets the number of full months separating this Jewish Date and the given one.
+     * If the given date is before this one, the number will be negative.
+     * @param {jDate} jd
+     * */
+    diffFullMonths(jd: jDate): number;
     /**Gets the number of years separating this Jewish Date and the given one.
      *
      * Ignores the Day and Month properties:
@@ -185,6 +190,10 @@ declare class jDate {
      * If the given date is before this one, the number will be negative.
      * @param {jDate} jd*/
     diffYears(jd: jDate): number;
+    /**Gets the number of full years separating this Jewish Date and the given one.
+     * If the given date is before this one, the number will be negative.
+     * @param {jDate} jd*/
+    diffFullYears(jd: jDate): number;
     /**
      * Returns the current Jewish date in the format: Thursday, the 3rd of Kislev 5776.
      * @param {boolean} hideDayOfWeek
@@ -309,6 +318,21 @@ declare const DaysOfWeek: Readonly<{
     FRIDAY: 5;
     SHABBOS: 6;
 }>;
+declare const JewishMonthsNames: Readonly<{
+    NISSAN: 1;
+    IYAR: 2;
+    SIVAN: 3;
+    TAMUZ: 4;
+    AV: 5;
+    ELLUL: 6;
+    TISHREI: 7;
+    CHESHVAN: 8;
+    KISLEV: 9;
+    TEVES: 10;
+    SHVAT: 11;
+    ADAR: 12;
+    ADAR_SHEINI: 13;
+}>;
 declare const JewishMonthsEng: string[];
 declare const JewishMonthsHeb: string[];
 declare const SecularMonthsEng: string[];
@@ -895,4 +919,4 @@ declare function getNotifications(date: jDate | Date, time: Time, location: Loca
     tefillahNotes: string[];
 };
 
-export { Dafyomi, DaysOfWeek, DaysOfWeekEng, DaysOfWeekHeb, JewishMonthsEng, JewishMonthsHeb, Location, Locations, Molad, PirkeiAvos, SecularMonthsEng, Sedra, Utils, ZmanTypeIds, ZmanTypes, Zmanim, ZmanimUtils, closestDistanceMatch, closestNameMatch, findLocation, getNotifications, getZmanType, jDate };
+export { Dafyomi, DaysOfWeek, DaysOfWeekEng, DaysOfWeekHeb, JewishMonthsEng, JewishMonthsHeb, JewishMonthsNames, Location, Locations, Molad, PirkeiAvos, SecularMonthsEng, Sedra, Utils, ZmanTypeIds, ZmanTypes, Zmanim, ZmanimUtils, closestDistanceMatch, closestNameMatch, findLocation, getNotifications, getZmanType, jDate };

package/dist/index.js

@@ -598,6 +598,19 @@ var jDate = class _jDate {
     }
     return months;
   }
+  /**Gets the number of full months separating this Jewish Date and the given one.
+   * If the given date is before this one, the number will be negative.
+   * @param {jDate} jd
+   * */
+  diffFullMonths(jd) {
+    let months = this.diffMonths(jd);
+    if (months >= 0 && this.Day > jd.Day) {
+      months--;
+    } else if (months < 0 && this.Day < jd.Day) {
+      months++;
+    }
+    return months;
+  }
   /**Gets the number of years separating this Jewish Date and the given one.
    *
    * Ignores the Day and Month properties:
@@ -607,7 +620,23 @@ var jDate = class _jDate {
    * If the given date is before this one, the number will be negative.
    * @param {jDate} jd*/
   diffYears(jd) {
-    return jd.Year - this.Year;
+    let diff = jd.Year - this.Year;
+    if (this.Month < jd.Month || this.Month === jd.Month && this.Day < jd.Day) {
+      diff--;
+    }
+    return diff;
+  }
+  /**Gets the number of full years separating this Jewish Date and the given one.
+   * If the given date is before this one, the number will be negative.
+   * @param {jDate} jd*/
+  diffFullYears(jd) {
+    let diff = jd.Year - this.Year;
+    if (diff >= 0 && (this.Month > jd.Month || this.Month === jd.Month && this.Day > jd.Day)) {
+      diff--;
+    } else if (diff < 0 && (this.Month < jd.Month || this.Month === jd.Month && this.Day < jd.Day)) {
+      diff++;
+    }
+    return diff;
   }
   /**
    * Returns the current Jewish date in the format: Thursday, the 3rd of Kislev 5776.
@@ -1137,6 +1166,21 @@ var DaysOfWeek = Object.freeze({
   FRIDAY: 5,
   SHABBOS: 6
 });
+var JewishMonthsNames = Object.freeze({
+  NISSAN: 1,
+  IYAR: 2,
+  SIVAN: 3,
+  TAMUZ: 4,
+  AV: 5,
+  ELLUL: 6,
+  TISHREI: 7,
+  CHESHVAN: 8,
+  KISLEV: 9,
+  TEVES: 10,
+  SHVAT: 11,
+  ADAR: 12,
+  ADAR_SHEINI: 13
+});
 var JewishMonthsEng = [
   "",
   "Nissan",
@@ -2578,14 +2622,14 @@ function getNotifications(date, time, location, english, showGaonShir, showDafYo
       addTefillahNote("No Tachnun", '\u05D0"\u05D0 \u05EA\u05D7\u05E0\u05D5\u05DF');
     } else if (isAfternoon) {
       addTefillahNote("No Tzidkascha", '\u05D0"\u05D0 \u05E6\u05D3\u05E7\u05EA\u05DA');
-    } else if (!(month === 1 && day > 21 || month === 2 || month === 3 && day < 6)) {
+    } else if (!(month === JewishMonthsNames.NISSAN && day > 21 || month === JewishMonthsNames.IYAR || month === JewishMonthsNames.SIVAN && day < 6)) {
       addTefillahNote("No Av Harachamim", '\u05D0"\u05D0 \u05D0\u05D1 \u05D4\u05E8\u05D7\u05DE\u05D9\u05DD');
     }
   }
   if (showDafYomi !== false) {
     addDayNote(jdate.getDafYomi(), jdate.getDafyomiHeb());
   }
-  if (isNotBeinHasmashos && (month === 1 && day > 15 || month === 2 || month === 3 && day < 6)) {
+  if (isNotBeinHasmashos && (month === JewishMonthsNames.NISSAN && day > 15 || month === JewishMonthsNames.IYAR || month === JewishMonthsNames.SIVAN && day < 6)) {
     const dayOfSefirah = jdate.getDayOfOmer();
     if (dayOfSefirah > 0) {
       addTefillahNote(Utils.getOmerNusach(dayOfSefirah, "ashkenaz"));
@@ -2607,19 +2651,19 @@ function getShabbosNotifications() {
     isDaytime,
     isAfternoon
   } = dayInfo;
-  if (month === 1 && day > 7 && day < 15) {
+  if (month === JewishMonthsNames.NISSAN && day > 7 && day < 15) {
     addDayNote("Shabbos Hagadol", "\u05E9\u05D1\u05EA \u05D4\u05D2\u05D3\u05D5\u05DC");
-  } else if (month === 7 && day > 2 && day < 10) {
+  } else if (month === JewishMonthsNames.TISHREI && day > 2 && day < 10) {
     addDayNote("Shabbos Shuva", "\u05E9\u05D1\u05EA \u05E9\u05D5\u05D1\u05D4");
-  } else if (month === 5 && day > 2 && day < 10) {
+  } else if (month === JewishMonthsNames.AV && day > 2 && day < 10) {
     addDayNote("Shabbos Chazon", "\u05E9\u05D1\u05EA \u05D7\u05D6\u05D5\u05DF");
-  } else if (month === (isLeapYear ? 12 : 11) && day > 24 || month === (isLeapYear ? 13 : 12) && day === 1) {
+  } else if (month === (isLeapYear ? JewishMonthsNames.ADAR : JewishMonthsNames.SHVAT) && day > 24 || month === (isLeapYear ? JewishMonthsNames.ADAR_SHEINI : JewishMonthsNames.ADAR) && day === 1) {
     addDayNote("Parshas Shkalim", "\u05E4\u05E8\u05E9\u05EA \u05E9\u05E7\u05DC\u05D9\u05DD");
-  } else if (month === (isLeapYear ? 13 : 12) && day > 7 && day < 14) {
+  } else if (month === (isLeapYear ? JewishMonthsNames.ADAR_SHEINI : JewishMonthsNames.ADAR) && day > 7 && day < 14) {
     addDayNote("Parshas Zachor", "\u05E4\u05E8\u05E9\u05EA \u05D6\u05DB\u05D5\u05E8");
-  } else if (month === (isLeapYear ? 13 : 12) && day > 16 && day < 24) {
+  } else if (month === (isLeapYear ? JewishMonthsNames.ADAR_SHEINI : JewishMonthsNames.ADAR) && day > 16 && day < 24) {
     addDayNote("Parshas Parah", "\u05E4\u05E8\u05E9\u05EA \u05E4\u05E8\u05D4");
-  } else if (month === (isLeapYear ? 13 : 12) && day > 23 && day < 30 || month === 1 && day === 1) {
+  } else if (month === (isLeapYear ? JewishMonthsNames.ADAR_SHEINI : JewishMonthsNames.ADAR) && day > 23 && day < 30 || month === JewishMonthsNames.NISSAN && day === 1) {
     addDayNote("Parshas Hachodesh", "\u05E4\u05E8\u05E9\u05EA \u05D4\u05D7\u05D5\u05D3\u05E9");
   }
   if (isMorning && !isYomTov) {
@@ -2630,25 +2674,25 @@ function getShabbosNotifications() {
         `\u05E7\u05D4"\u05EA \u05E4\u05E8\u05E9\u05EA ${sedra.toStringHeb()}`
       );
     }
-    if (month !== 6 && day > 22 && day < 30) {
+    if (month !== JewishMonthsNames.ELLUL && day > 22 && day < 30) {
       const nextMonth = jdate.addMonths(1);
       addTefillahNote(
         "The molad will be " + Molad.getString(nextMonth.Year, nextMonth.Month),
         "\u05D4\u05DE\u05D5\u05DC\u05D3 \u05D9\u05D4\u05D9\u05D4 \u05D1" + Molad.getStringHeb(nextMonth.Year, nextMonth.Month)
       );
       addTefillahNote("Bircas Hachodesh", "\u05DE\u05D1\u05E8\u05DB\u05D9\u05DD \u05D4\u05D7\u05D5\u05D3\u05E9");
-      if (month !== 1 && month !== 2) {
+      if (month !== JewishMonthsNames.NISSAN && month !== JewishMonthsNames.IYAR) {
         addTefillahNote("No Av Harachamim", '\u05D0"\u05D0 \u05D0\u05D1 \u05D4\u05E8\u05D7\u05DE\u05D9\u05DD');
       }
     }
   }
-  if (month !== 7 && (day === 1 || day === 30)) {
+  if (month !== JewishMonthsNames.TISHREI && (day === 1 || day === 30)) {
     addDayNote("Rosh Chodesh", "\u05E8\u05D0\u05E9 \u05D7\u05D5\u05D3\u05E9");
     addTefillahNote("Ya`aleh Viyavo", "\u05D9\u05E2\u05DC\u05D4 \u05D5\u05D9\u05D1\u05D0");
     if (showGaonShirShelYom && isDaytime) {
       addTefillahNote("Barchi Nafshi", '\u05E9\u05D9\u05E8 \u05E9\u05DC \u05D9\u05D5\u05DD - \u05E7\u05D9"\u05D3 - \u05D1\u05E8\u05DB\u05D9 \u05E0\u05E4\u05E9\u05D9');
     }
-    if (isDaytime && month !== 10 && !(month === 9 && day === 30)) {
+    if (isDaytime && month !== JewishMonthsNames.TEVES && !(month === JewishMonthsNames.KISLEV && day === 30)) {
       addTefillahNote("Chatzi Hallel", "\u05D7\u05E6\u05D9 \u05D4\u05DC\u05DC");
     }
     addTefillahNote("No Av Harachamim", '\u05D0"\u05D0 \u05D0\u05D1 \u05D4\u05E8\u05D7\u05DE\u05D9\u05DD');
@@ -2658,14 +2702,14 @@ function getShabbosNotifications() {
       addTefillahNote("\u05E9\u05D9\u05E8 \u05E9\u05DC \u05D9\u05D5\u05DD - \u05DE\u05D6\u05DE\u05D5\u05E8 \u05E9\u05D9\u05E8 \u05DC\u05D9\u05D5\u05DD \u05D4\u05E9\u05D1\u05EA");
     }
   }
-  if (isAfternoon && !(month === 7 && day === 10)) {
+  if (isAfternoon && !(month === JewishMonthsNames.TISHREI && day === 10)) {
     const sedra = jdate.addDays(1).getSedra(israel);
     addTefillahNote(
       "Kriyas Hatorah Mincha Parshas " + sedra.sedras[0].eng,
       '\u05E7\u05D4"\u05EA \u05D1\u05DE\u05E0\u05D7\u05D4 \u05E4\u05E8\u05E9\u05EA ' + sedra.sedras[0].heb
     );
   }
-  if (isAfternoon && (month === 1 && day > 21 || month <= 6 && !(month === 5 && [8, 9].includes(day)))) {
+  if (isAfternoon && (month === JewishMonthsNames.NISSAN && day > 21 || month <= JewishMonthsNames.ELLUL && !(month === JewishMonthsNames.AV && [8, 9].includes(day)))) {
     const prakim = PirkeiAvos.getPrakim(jdate, israel);
     if (prakim.length > 0) {
       addDayNote(
@@ -2690,12 +2734,12 @@ function getWeekDayNotifications() {
   } = dayInfo;
   if (isNightTime && dow === DaysOfWeek.SUNDAY) {
     addTefillahNote(
-      month === 1 && day === 15 || month === 3 && day === 6 ? "\u05D5\u05EA\u05D5\u05D3\u05D9\u05E2\u05D9\u05E0\u05D5" : "\u05D0\u05EA\u05D4 \u05D7\u05D5\u05E0\u05E0\u05EA\u05E0\u05D5"
+      month === JewishMonthsNames.NISSAN && day === 15 || month === JewishMonthsNames.SIVAN && day === 6 ? "\u05D5\u05EA\u05D5\u05D3\u05D9\u05E2\u05D9\u05E0\u05D5" : "\u05D0\u05EA\u05D4 \u05D7\u05D5\u05E0\u05E0\u05EA\u05E0\u05D5"
     );
-    if (month === 6 && day > 22 || month === 7 && day < 22 && day !== 3 || month === 1 && day > 8 && day < 15 || month === 3 && day < 6) {
+    if (month === JewishMonthsNames.ELLUL && day > 22 || month === JewishMonthsNames.TISHREI && day < 22 && day !== 3 || month === JewishMonthsNames.NISSAN && day > 8 && day < 15 || month === JewishMonthsNames.SIVAN && day < 6) {
       addTefillahNote("No Vihi Noam", '\u05D0"\u05D0 \u05D5\u05D9\u05D4\u05D9 \u05E0\u05D5\u05E2\u05DD');
     }
-  } else if (isNightTime && (month === 1 && (day === 16 || day === 22) || month === 3 && day === 7 || month === 7 && [3, 11, 16, 23].includes(day))) {
+  } else if (isNightTime && (month === JewishMonthsNames.NISSAN && (day === 16 || day === 22) || month === JewishMonthsNames.SIVAN && day === 7 || month === JewishMonthsNames.TISHREI && [3, 11, 16, 23].includes(day))) {
     addTefillahNote("Ata Chonantanu", "\u05D0\u05EA\u05D4 \u05D7\u05D5\u05E0\u05E0\u05EA\u05E0\u05D5");
   }
   if (isMorning && !isYomTov && (dow === DaysOfWeek.MONDAY || dow === DaysOfWeek.THURSDAY) && !hasOwnKriyasHatorah(jdate, location)) {
@@ -2707,20 +2751,20 @@ function getWeekDayNotifications() {
       );
     }
   }
-  if (month !== 7 && day === 1 || day === 30) {
+  if (month !== JewishMonthsNames.TISHREI && day === 1 || day === 30) {
     dayInfo.noTachnun = true;
     addDayNote("Rosh Chodesh", "\u05E8\u05D0\u05E9 \u05D7\u05D5\u05D3\u05E9");
     addTefillahNote("Ya`aleh Viyavo", "\u05D9\u05E2\u05DC\u05D4 \u05D5\u05D9\u05D1\u05D0");
     if (showGaonShirShelYom && isDaytime) {
       addTefillahNote("Barchi Nafshi", '\u05E9\u05D9\u05E8 \u05E9\u05DC \u05D9\u05D5\u05DD - \u05E7\u05D9"\u05D3 - \u05D1\u05E8\u05DB\u05D9 \u05E0\u05E4\u05E9\u05D9');
     }
-    if (isDaytime && month !== 10 && !(month === 9 && day === 30)) {
+    if (isDaytime && month !== JewishMonthsNames.TEVES && !(month === JewishMonthsNames.KISLEV && day === 30)) {
       addTefillahNote("Chatzi Hallel", "\u05D7\u05E6\u05D9 \u05D4\u05DC\u05DC");
       if (isMorning && dow !== DaysOfWeek.SHABBOS) {
         noLaminatzeach();
       }
     }
-  } else if (month !== 6 && (dow < DaysOfWeek.FRIDAY && day === 29 || dow === DaysOfWeek.THURSDAY && day === 28) && isAfternoon) {
+  } else if (month !== JewishMonthsNames.ELLUL && (dow < DaysOfWeek.FRIDAY && day === 29 || dow === DaysOfWeek.THURSDAY && day === 28) && isAfternoon) {
     addTefillahNote("Yom Kippur Kattan", '\u05D9\u05D5"\u05DB \u05E7\u05D8\u05DF');
   }
   if (jdate.hasEiruvTavshilin(israel)) {
@@ -3363,7 +3407,7 @@ function getAroundTheYearNotifications() {
       break;
     case 12:
     case 13:
-      if (month === 12 && isLeapYear) {
+      if (month === JewishMonthsNames.ADAR && isLeapYear) {
         if ((day === 13 && isAfternoon || [14, 15].includes(day)) && isDaytime) {
           addDayNote(
             day === 14 ? showEnglish ? "Purim Katan" : "\u05E4\u05D5\u05E8\u05D9\u05DD \u05E7\u05D8\u05DF" : showEnglish ? "Shushan Purim Katan" : "\u05E9\u05D5\u05E9\u05DF \u05E4\u05D5\u05E8\u05D9\u05DD \u05E7\u05D8\u05DF"
@@ -3487,7 +3531,7 @@ function hasOwnKriyasHatorah(jdate, location) {
       return Day === 10 || Day < 3 || Day === 3 && jDate.isShortKislev(jdate.Year);
     case 12:
     case 13:
-      return Month === (jDate.isJdLeapY(jdate.Year) ? 13 : 12) && (Day === 13 || Day === (location.Name === "\u05D9\u05E8\u05D5\u05E9\u05DC\u05D9\u05DD" ? 15 : 14));
+      return Month === (jDate.isJdLeapY(jdate.Year) ? JewishMonthsNames.ADAR_SHEINI : JewishMonthsNames.ADAR) && (Day === 13 || Day === (location.Name === "\u05D9\u05E8\u05D5\u05E9\u05DC\u05D9\u05DD" ? 15 : 14));
     default:
       return false;
   }
@@ -3499,6 +3543,7 @@ export {
   DaysOfWeekHeb,
   JewishMonthsEng,
   JewishMonthsHeb,
+  JewishMonthsNames,
   Location,
   Locations,
   Molad,