@hebcal/core 3.41.3 → 3.42.1

package/hebcal.d.ts

@@ -29,6 +29,11 @@ declare module '@hebcal/core' {
         observedInDiaspora(): boolean;
         observedIn(il: boolean): boolean;
         clone(): Event;
+        readonly date: Date;
+        readonly desc: string;
+        readonly mask: number;
+        readonly emoji?: string;
+        readonly memo?: string;
     }
 
     /**
@@ -292,6 +297,7 @@ declare module '@hebcal/core' {
         tzeit(hdate: Date | HDate, angle?: number): Date;
         /**
          * Builds a city description from geonameid string components
+         * @deprecated
          * @param cityName e.g. 'Tel Aviv' or 'Chicago'
          * @param admin1 e.g. 'England' or 'Massachusetts'
          * @param countryName full country name, e.g. 'Israel' or 'United States'
@@ -603,6 +609,15 @@ declare module '@hebcal/core' {
         hour12?: boolean;
     };
 
+    export type TachanunResult = {
+        /** Tachanun is said at Shacharit */
+        shacharit: boolean;
+        /** Tachanun is said at Mincha */
+        mincha: boolean;
+        /** All congregations say Tachanun on the day */
+        allCongs: boolean;
+    };
+
     /**
      * HebrewCalendar is the main interface to the `@hebcal/core` library.
      * This class is used to calculate holidays, rosh chodesh, candle lighting & havdalah times,
@@ -712,6 +727,40 @@ declare module '@hebcal/core' {
          * created and cached instance.
          */
         static getSedra(hyear: number, il: boolean): Sedra;
+
+        /**
+         * Return a number containing information on what Hallel is said on that day.
+         *
+         * Whole Hallel is said on Chanukah, the first Yom Tov of Pesach, Shavuot, Sukkot,
+         * Yom Ha'atzmaut, and Yom Yerushalayim.
+         *
+         * Half Hallel is said on Rosh Chodesh (not Rosh Hashanah), and the last 6 days of Pesach.
+         *
+         * The number is one of the following values:
+         *
+         * 0 - No Hallel
+         * 1 - Half Hallel
+         * 2 - Whole Hallel
+         */
+        static hallel(hdate: HDate, il: boolean): number;
+
+        /**
+         * Return details on what Tachanun (or Tzidchatcha on Shabbat) is said on `hdate`.
+         *
+         * Tachanun is not said on Rosh Chodesh, the month of Nisan, Lag Baomer,
+         * Rosh Chodesh Sivan until Isru Chag, Tisha B'av, 15 Av, Erev Rosh Hashanah,
+         * Rosh Hashanah, Erev Yom Kippur until after Simchat Torah, Chanukah,
+         * Tu B'shvat, Purim and Shushan Purim, and Purim and Shushan Purim Katan.
+         *
+         * In some congregations Tachanun is not said until from Rosh Chodesh Sivan
+         * until 14th Sivan, Sukkot until after Rosh Chodesh Cheshvan, Pesach Sheini,
+         * Yom Ha'atzmaut, and Yom Yerushalayim.
+         *
+         * Tachanun is not said at Mincha on days before it is not said at Shacharit.
+         *
+         * Tachanun is not said at Shacharit on Shabbat, but is at Mincha, usually.
+         */
+        static tachanun(hdate: HDate, il: boolean): TachanunResult;
     }
 
     /**
@@ -940,6 +989,10 @@ declare module '@hebcal/core' {
         constructor(date: HDate, desc: string, mask: number, eventTime: Date, location: Location, linkedEvent?: Event);
         render(locale?: string): string;
         renderBrief(locale?: string): string;
+        readonly eventTime: Date;
+        readonly location: Location;
+        readonly eventTimeStr: string;
+        readonly linkedEvent?: Event;
     }
     export class CandleLightingEvent extends TimedEvent {
         constructor(date: HDate, mask: number, eventTime: Date, location: Location, linkedEvent?: Event);
@@ -956,6 +1009,7 @@ declare module '@hebcal/core' {
         render(locale?: string): string;
         renderBrief(locale?: string): string;
         getEmoji(): string;
+        readonly havdalahMins?: number;
     }
     export class HebrewDateEvent extends Event {
         constructor(date: HDate, locale?: string);
@@ -970,6 +1024,9 @@ declare module '@hebcal/core' {
         url(): string;
         urlDateSuffix(): string;
         getEmoji(): string;
+        readonly cholHaMoedDay?: number;
+        readonly startEvent?: TimedEvent;
+        readonly endEvent?: TimedEvent;
     }
     export class AsaraBTevetEvent extends HolidayEvent {
         constructor(date: HDate, desc: string, mask?: number, attrs?: any);
@@ -985,12 +1042,13 @@ declare module '@hebcal/core' {
         constructor(date: HDate, monthName: string);
         render(locale?: string): string;
         renderBrief(locale?: string): string;
+        readonly monthName: string;
     }
     export class MoladEvent extends Event {
         constructor(date: HDate, hyear: number, hmonth: number);
         render(locale?: string): string;
         renderBrief(locale?: string): string;
-        molad: Molad;
+        readonly molad: Molad;
     }
     export type OmerSefiraLang = 'en' | 'he' | 'translit';
     export class OmerEvent extends Event {
@@ -1003,18 +1061,19 @@ declare module '@hebcal/core' {
         getTodayIs(locale?: string): string;
         sefira(lang: OmerSefiraLang): string;
         url(): string;
-        weekNumber: number;
-        daysWithinWeeks: number;
-        memo: string;
-        alarm?: Date;
+        readonly weekNumber: number;
+        readonly daysWithinWeeks: number;
+        readonly memo: string;
+        readonly alarm?: Date;
     }
     export class ParshaEvent extends Event {
         constructor(date: HDate, parsha: string[], il: boolean);
         render(locale?: string): string;
         renderBrief(locale?: string): string;
         url(): string;
-        parsha: string[];
-        il: boolean;
+        readonly parsha: string[];
+        readonly il: boolean;
+        readonly num: number | number[];
     }
     export class RoshChodeshEvent extends HolidayEvent {
         constructor(date: HDate, monthName: string);
@@ -1068,5 +1127,6 @@ declare module '@hebcal/core' {
          * Returns a link to sefaria.org
          */
         url(): string;
+        readonly mishnaYomi: MishnaYomi[];
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/core",
-  "version": "3.41.3",
+  "version": "3.42.1",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "contributors": [
     "Eyal Schachter (https://github.com/Scimonster)",
@@ -63,25 +63,25 @@
     "verbose": true
   },
   "devDependencies": {
-    "@babel/core": "^7.18.6",
-    "@babel/preset-env": "^7.18.6",
-    "@babel/register": "^7.18.6",
+    "@babel/core": "^7.18.10",
+    "@babel/preset-env": "^7.18.10",
+    "@babel/register": "^7.18.9",
     "@hebcal/solar-calc": "^1.1.2",
     "@rollup/plugin-babel": "^5.3.1",
-    "@rollup/plugin-commonjs": "^22.0.1",
+    "@rollup/plugin-commonjs": "^22.0.2",
     "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-node-resolve": "^13.3.0",
-    "ava": "^4.3.0",
+    "ava": "^4.3.1",
     "codecov": "^3.8.3",
-    "core-js": "^3.23.3",
-    "eslint": "^8.18.0",
+    "core-js": "^3.24.1",
+    "eslint": "^8.21.0",
     "eslint-config-google": "^0.14.0",
-    "jsdoc": "^3.6.10",
+    "jsdoc": "^3.6.11",
     "jsdoc-to-markdown": "^7.1.1",
     "nyc": "^15.1.0",
-    "rollup": "^2.75.7",
+    "rollup": "^2.77.2",
     "rollup-plugin-terser": "^7.0.2",
     "tsd-jsdoc": "^2.5.0",
-    "ttag-cli": "^1.9.4"
+    "ttag-cli": "^1.10.1"
   }
 }