@hebcal/core 5.3.9 → 5.3.11

package/hebcal.d.ts

@@ -119,6 +119,9 @@ declare module '@hebcal/core' {
          * Gets the Hebrew month (1=NISAN, 7=TISHREI) of this Hebrew date
          */
         getMonth(): number;
+        /**
+         * The Tishrei-based month of the date. 1 is Tishrei, 7 is Nisan, 13 is Elul in a leap year
+         */
         getTishreiMonth(): number;
         /**
          * Number of days in the month of this Hebrew date
@@ -160,12 +163,51 @@ declare module '@hebcal/core' {
          */
         renderGematriya(suppressNikud?: boolean): string;
 
+        /**
+         * Returns an `HDate` representing the a dayNumber before the current date.
+         * @example
+         * new HDate(new Date('Wednesday February 19, 2014')).before(6).greg() // Sat Feb 15 2014
+         * @param {number} day day of week (Sunday=0, Saturday=6)
+         */
         before(day: number): HDate;
+        /**
+         * Returns an `HDate` representing the a dayNumber on or before the current date.
+         * @example
+         * new HDate(new Date('Wednesday February 19, 2014')).onOrBefore(6).greg() // Sat Feb 15 2014
+         * new HDate(new Date('Saturday February 22, 2014')).onOrBefore(6).greg() // Sat Feb 22 2014
+         * new HDate(new Date('Sunday February 23, 2014')).onOrBefore(6).greg() // Sat Feb 22 2014
+         * @param {number} day day of week (Sunday=0, Saturday=6)
+         */
         onOrBefore(day: number): HDate;
+        /**
+         * Returns an `HDate` representing the nearest dayNumber to the current date
+         * @example
+         * new HDate(new Date('Wednesday February 19, 2014')).nearest(6).greg() // Sat Feb 22 2014
+         * new HDate(new Date('Tuesday February 18, 2014')).nearest(6).greg() // Sat Feb 15 2014
+         * @param {number} day day of week (Sunday=0, Saturday=6)
+         */
         nearest(day: number): HDate;
+        /**
+         * Returns an `HDate` representing the a dayNumber on or after the current date.
+         * @example
+         * new HDate(new Date('Wednesday February 19, 2014')).onOrAfter(6).greg() // Sat Feb 22 2014
+         * new HDate(new Date('Saturday February 22, 2014')).onOrAfter(6).greg() // Sat Feb 22 2014
+         * new HDate(new Date('Sunday February 23, 2014')).onOrAfter(6).greg() // Sat Mar 01 2014
+         * @param {number} day day of week (Sunday=0, Saturday=6)
+         */
         onOrAfter(day: number): HDate;
+        /**
+         * Returns an `HDate` representing the a dayNumber after the current date.
+         * @example
+         * new HDate(new Date('Wednesday February 19, 2014')).after(6).greg() // Sat Feb 22 2014
+         * new HDate(new Date('Saturday February 22, 2014')).after(6).greg() // Sat Mar 01 2014
+         * new HDate(new Date('Sunday February 23, 2014')).after(6).greg() // Sat Mar 01 2014
+         * @param {number} day day of week (Sunday=0, Saturday=6)
+         */
         after(day: number): HDate;
+        /** Returns the next Hebrew date */
         next(): HDate;
+        /** Returns the previous Hebrew date */
         prev(): HDate;
         /**
          * Returns a cloned HDate object with a specified amount of time added
@@ -188,6 +230,9 @@ declare module '@hebcal/core' {
          */
         deltaDays(other: HDate): number;
 
+        /**
+         * Compares this date to another date, returning `true` if the dates match.
+         */
         isSameDate(other: HDate): boolean;
 
         /**
@@ -268,6 +313,16 @@ declare module '@hebcal/core' {
          */
         static monthFromName(c: string | number): number;
 
+        /**
+         * Note: Applying this function to d+6 gives us the DAYNAME on or after an
+         * absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to
+         * absolute date d, applying it to d-1 gives the DAYNAME previous to absolute
+         * date d, and applying it to d+7 gives the DAYNAME following absolute date d.
+         * @param {number} dayOfWeek - Day of Week (0=Sunday, 6=Saturday)
+         * @param {number} abs - R.D. number of days
+         */
+        static dayOnOrBefore(dayOfWeek: number, abs: number): number;
+
         /**
          * Construct a new instance of `HDate` from a Gematriya-formatted string
          * @example
@@ -1226,4 +1281,81 @@ declare module '@hebcal/core' {
          */
         static lookup(name: string, hd: HDate): Event;
     }
+
+    export const enum holidayDesc {
+        ASARA_BTEVET = "Asara B'Tevet",
+        BIRKAT_HACHAMAH = 'Birkat Hachamah',
+        CHAG_HABANOT = 'Chag HaBanot',
+        CHANUKAH_8TH_DAY = 'Chanukah: 8th Day',
+        EREV_TISHA_BAV = "Erev Tish'a B'Av",
+        LEIL_SELICHOT = 'Leil Selichot',
+        PURIM_KATAN = 'Purim Katan',
+        PURIM_MESHULASH = 'Purim Meshulash',
+        SHABBAT_CHAZON = 'Shabbat Chazon',
+        SHABBAT_HACHODESH = 'Shabbat HaChodesh',
+        SHABBAT_HAGADOL = 'Shabbat HaGadol',
+        SHABBAT_NACHAMU = 'Shabbat Nachamu',
+        SHABBAT_PARAH = 'Shabbat Parah',
+        SHABBAT_SHEKALIM = 'Shabbat Shekalim',
+        SHABBAT_SHIRAH = 'Shabbat Shirah',
+        SHABBAT_SHUVA = 'Shabbat Shuva',
+        SHABBAT_ZACHOR = 'Shabbat Zachor',
+        SHUSHAN_PURIM_KATAN = 'Shushan Purim Katan',
+        TAANIT_BECHOROT = "Ta'anit Bechorot",
+        TAANIT_ESTHER = "Ta'anit Esther",
+        TISHA_BAV = "Tish'a B'Av",
+        TZOM_GEDALIAH = 'Tzom Gedaliah',
+        TZOM_TAMMUZ = 'Tzom Tammuz',
+        YOM_HAATZMA_UT = "Yom HaAtzma'ut",
+        YOM_HASHOAH = 'Yom HaShoah',
+        YOM_HAZIKARON = 'Yom HaZikaron',
+        BEN_GURION_DAY = 'Ben-Gurion Day',
+        CHANUKAH_1_CANDLE = 'Chanukah: 1 Candle',
+        EREV_PESACH = 'Erev Pesach',
+        EREV_PURIM = 'Erev Purim',
+        EREV_ROSH_HASHANA = 'Erev Rosh Hashana',
+        EREV_SHAVUOT = 'Erev Shavuot',
+        EREV_SUKKOT = 'Erev Sukkot',
+        EREV_YOM_KIPPUR = 'Erev Yom Kippur',
+        FAMILY_DAY = 'Family Day',
+        HEBREW_LANGUAGE_DAY = 'Hebrew Language Day',
+        HERZL_DAY = 'Herzl Day',
+        JABOTINSKY_DAY = 'Jabotinsky Day',
+        LAG_BAOMER = 'Lag BaOmer',
+        PESACH_I = 'Pesach I',
+        PESACH_II = 'Pesach II',
+        PESACH_III_CHM = "Pesach III (CH''M)",
+        PESACH_II_CHM = "Pesach II (CH''M)",
+        PESACH_IV_CHM = "Pesach IV (CH''M)",
+        PESACH_SHENI = 'Pesach Sheni',
+        PESACH_VII = 'Pesach VII',
+        PESACH_VIII = 'Pesach VIII',
+        PESACH_VI_CHM = "Pesach VI (CH''M)",
+        PESACH_V_CHM = "Pesach V (CH''M)",
+        PURIM = 'Purim',
+        ROSH_HASHANA_II = 'Rosh Hashana II',
+        ROSH_HASHANA_LABEHEMOT = 'Rosh Hashana LaBehemot',
+        SHAVUOT = 'Shavuot',
+        SHAVUOT_I = 'Shavuot I',
+        SHAVUOT_II = 'Shavuot II',
+        SHMINI_ATZERET = 'Shmini Atzeret',
+        SHUSHAN_PURIM = 'Shushan Purim',
+        SIGD = 'Sigd',
+        SIMCHAT_TORAH = 'Simchat Torah',
+        SUKKOT_I = 'Sukkot I',
+        SUKKOT_II = 'Sukkot II',
+        SUKKOT_III_CHM = "Sukkot III (CH''M)",
+        SUKKOT_II_CHM = "Sukkot II (CH''M)",
+        SUKKOT_IV_CHM = "Sukkot IV (CH''M)",
+        SUKKOT_VII_HOSHANA_RABA = 'Sukkot VII (Hoshana Raba)',
+        SUKKOT_VI_CHM = "Sukkot VI (CH''M)",
+        SUKKOT_V_CHM = "Sukkot V (CH''M)",
+        TU_BAV = "Tu B'Av",
+        TU_BISHVAT = 'Tu BiShvat',
+        YITZHAK_RABIN_MEMORIAL_DAY = 'Yitzhak Rabin Memorial Day',
+        YOM_HAALIYAH = 'Yom HaAliyah',
+        YOM_HAALIYAH_SCHOOL_OBSERVANCE = 'Yom HaAliyah School Observance',
+        YOM_KIPPUR = 'Yom Kippur',
+        YOM_YERUSHALAYIM = 'Yom Yerushalayim'
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/core",
-  "version": "5.3.9",
+  "version": "5.3.11",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "contributors": [
     "Eyal Schachter (https://github.com/Scimonster)",

package/po/he.po

@@ -926,3 +926,6 @@ msgstr "מוֹלָד הָלְּבָנָה"
 
 msgid "chalakim"
 msgstr "חֲלָקִים"
+
+msgid "Pirkei Avot"
+msgstr "פִּרְקֵי אָבוֹת"