@hebcal/core 5.4.1 → 5.4.3

package/dist/candles.d.ts

@@ -3,18 +3,19 @@ import { CalOptions } from './CalOptions';
 import { Location } from './location';
 import { Event } from './event';
 import { HolidayEvent } from './HolidayEvent';
+import { TimedEvent } from './TimedEvent';
 /**
  * @private
  */
-export declare function makeCandleEvent(ev: Event | undefined, hd: HDate, options: CalOptions, isFriday: boolean, isSaturday: boolean): Event | null;
+export declare function makeCandleEvent(ev: Event | undefined, hd: HDate, options: CalOptions, isFriday: boolean, isSaturday: boolean): TimedEvent | undefined;
 /**
  * Makes a pair of events representing fast start and end times
  * @private
  */
 export declare function makeFastStartEnd(ev: HolidayEvent, options: CalOptions): HolidayEvent;
-export declare class ChanukahEvent extends HolidayEvent {
-    readonly eventTime: Date;
-    readonly eventTimeStr: string;
+export declare class TimedChanukahEvent extends HolidayEvent {
+    eventTime: Date;
+    eventTimeStr: string;
     readonly location: Location;
     constructor(date: HDate, desc: string, mask: number, eventTime: Date, location: Location);
 }
@@ -24,4 +25,4 @@ export declare class ChanukahEvent extends HolidayEvent {
  * Another source suggests 4.6667 degrees below horizon.
  * @private
  */
-export declare function makeWeekdayChanukahCandleLighting(ev: Event, hd: HDate, options: CalOptions): ChanukahEvent | null;
+export declare function makeWeekdayChanukahCandleLighting(ev: HolidayEvent, hd: HDate, options: CalOptions): TimedChanukahEvent | null;

package/dist/event.d.ts

@@ -1,4 +1,5 @@
 import { HDate } from '@hebcal/hdate';
+import './locale';
 /**
  * Holiday flags for Event
  * @readonly

package/dist/he.po.d.ts

@@ -0,0 +1,292 @@
+declare const _default: {
+    headers: {
+        "plural-forms": string;
+    };
+    contexts: {
+        "": {
+            Shabbat: string[];
+            "Daf Yomi": string[];
+            Parashat: string[];
+            "Achrei Mot": string[];
+            Balak: string[];
+            Bamidbar: string[];
+            Bechukotai: string[];
+            "Beha'alotcha": string[];
+            Behar: string[];
+            Bereshit: string[];
+            Beshalach: string[];
+            Bo: string[];
+            "Chayei Sara": string[];
+            Chukat: string[];
+            Devarim: string[];
+            Eikev: string[];
+            Emor: string[];
+            "Ha'azinu": string[];
+            Kedoshim: string[];
+            "Ki Tavo": string[];
+            "Ki Teitzei": string[];
+            "Ki Tisa": string[];
+            Korach: string[];
+            "Lech-Lecha": string[];
+            Masei: string[];
+            Matot: string[];
+            Metzora: string[];
+            Miketz: string[];
+            Mishpatim: string[];
+            Nasso: string[];
+            Nitzavim: string[];
+            Noach: string[];
+            Pekudei: string[];
+            Pinchas: string[];
+            "Re'eh": string[];
+            "Sh'lach": string[];
+            Shemot: string[];
+            Shmini: string[];
+            Shoftim: string[];
+            Tazria: string[];
+            Terumah: string[];
+            Tetzaveh: string[];
+            Toldot: string[];
+            Tzav: string[];
+            Vaera: string[];
+            Vaetchanan: string[];
+            Vayakhel: string[];
+            Vayechi: string[];
+            Vayeilech: string[];
+            Vayera: string[];
+            Vayeshev: string[];
+            Vayetzei: string[];
+            Vayigash: string[];
+            Vayikra: string[];
+            Vayishlach: string[];
+            "Vezot Haberakhah": string[];
+            Yitro: string[];
+            "Asara B'Tevet": string[];
+            "Candle lighting": string[];
+            Chanukah: string[];
+            "Chanukah: 1 Candle": string[];
+            "Chanukah: 2 Candles": string[];
+            "Chanukah: 3 Candles": string[];
+            "Chanukah: 4 Candles": string[];
+            "Chanukah: 5 Candles": string[];
+            "Chanukah: 6 Candles": string[];
+            "Chanukah: 7 Candles": string[];
+            "Chanukah: 8 Candles": string[];
+            "Chanukah: 8th Day": string[];
+            "Days of the Omer": string[];
+            Omer: string[];
+            "day of the Omer": string[];
+            "Erev Pesach": string[];
+            "Erev Purim": string[];
+            "Erev Rosh Hashana": string[];
+            "Erev Shavuot": string[];
+            "Erev Simchat Torah": string[];
+            "Erev Sukkot": string[];
+            "Erev Tish'a B'Av": string[];
+            "Erev Yom Kippur": string[];
+            Havdalah: string[];
+            "Lag BaOmer": string[];
+            "Leil Selichot": string[];
+            Pesach: string[];
+            "Pesach I": string[];
+            "Pesach II": string[];
+            "Pesach II (CH''M)": string[];
+            "Pesach III (CH''M)": string[];
+            "Pesach IV (CH''M)": string[];
+            "Pesach Sheni": string[];
+            "Pesach V (CH''M)": string[];
+            "Pesach VI (CH''M)": string[];
+            "Pesach VII": string[];
+            "Pesach VIII": string[];
+            Purim: string[];
+            "Purim Katan": string[];
+            "Rosh Chodesh %s": string[];
+            "Rosh Chodesh": string[];
+            "Rosh Hashana": string[];
+            "Rosh Hashana I": string[];
+            "Rosh Hashana II": string[];
+            "Shabbat Chazon": string[];
+            "Shabbat HaChodesh": string[];
+            "Shabbat HaGadol": string[];
+            "Shabbat Machar Chodesh": string[];
+            "Shabbat Nachamu": string[];
+            "Shabbat Parah": string[];
+            "Shabbat Rosh Chodesh": string[];
+            "Shabbat Shekalim": string[];
+            "Shabbat Shuva": string[];
+            "Shabbat Zachor": string[];
+            Shavuot: string[];
+            "Shavuot I": string[];
+            "Shavuot II": string[];
+            "Shmini Atzeret": string[];
+            "Shushan Purim": string[];
+            Sigd: string[];
+            "Simchat Torah": string[];
+            Sukkot: string[];
+            "Sukkot I": string[];
+            "Sukkot II": string[];
+            "Sukkot II (CH''M)": string[];
+            "Sukkot III (CH''M)": string[];
+            "Sukkot IV (CH''M)": string[];
+            "Sukkot V (CH''M)": string[];
+            "Sukkot VI (CH''M)": string[];
+            "Sukkot VII (Hoshana Raba)": string[];
+            "Ta'anit Bechorot": string[];
+            "Ta'anit Esther": string[];
+            "Tish'a B'Av": string[];
+            "Tu B'Av": string[];
+            "Tu BiShvat": string[];
+            "Tu B'Shvat": string[];
+            "Tzom Gedaliah": string[];
+            "Tzom Tammuz": string[];
+            "Yom HaAtzma'ut": string[];
+            "Yom HaShoah": string[];
+            "Yom HaZikaron": string[];
+            "Yom Kippur": string[];
+            "Yom Yerushalayim": string[];
+            "Yom HaAliyah": string[];
+            "Yom HaAliyah School Observance": string[];
+            "Pesach I (on Shabbat)": string[];
+            "Pesach Chol ha-Moed Day 1": string[];
+            "Pesach Chol ha-Moed Day 2": string[];
+            "Pesach Chol ha-Moed Day 3": string[];
+            "Pesach Chol ha-Moed Day 4": string[];
+            "Pesach Chol ha-Moed Day 5": string[];
+            "Pesach Shabbat Chol ha-Moed": string[];
+            "Shavuot II (on Shabbat)": string[];
+            "Rosh Hashana I (on Shabbat)": string[];
+            "Yom Kippur (on Shabbat)": string[];
+            "Yom Kippur (Mincha, Traditional)": string[];
+            "Yom Kippur (Mincha, Alternate)": string[];
+            "Sukkot I (on Shabbat)": string[];
+            "Sukkot Chol ha-Moed Day 1": string[];
+            "Sukkot Chol ha-Moed Day 2": string[];
+            "Sukkot Chol ha-Moed Day 3": string[];
+            "Sukkot Chol ha-Moed Day 4": string[];
+            "Sukkot Chol ha-Moed Day 5": string[];
+            "Sukkot Shabbat Chol ha-Moed": string[];
+            "Sukkot Final Day (Hoshana Raba)": string[];
+            "Rosh Chodesh Adar": string[];
+            "Rosh Chodesh Adar I": string[];
+            "Rosh Chodesh Adar II": string[];
+            "Rosh Chodesh Av": string[];
+            "Rosh Chodesh Cheshvan": string[];
+            "Rosh Chodesh Elul": string[];
+            "Rosh Chodesh Iyyar": string[];
+            "Rosh Chodesh Kislev": string[];
+            "Rosh Chodesh Nisan": string[];
+            "Rosh Chodesh Sh'vat": string[];
+            "Rosh Chodesh Sivan": string[];
+            "Rosh Chodesh Tamuz": string[];
+            "Rosh Chodesh Tevet": string[];
+            min: string[];
+            "Fast begins": string[];
+            "Fast ends": string[];
+            "Rosh Hashana LaBehemot": string[];
+            "Tish'a B'Av (observed)": string[];
+            "Shabbat Mevarchim Chodesh": string[];
+            "Shabbat Shirah": string[];
+            "Chatzot HaLailah": string[];
+            "Alot haShachar": string[];
+            Misheyakir: string[];
+            "Misheyakir Machmir": string[];
+            Dawn: string[];
+            Sunrise: string[];
+            "Kriat Shema, sof zeman": string[];
+            "Tefilah, sof zeman": string[];
+            "Kriat Shema, sof zeman (MGA)": string[];
+            "Tefilah, sof zeman (MGA)": string[];
+            "Chatzot hayom": string[];
+            "Mincha Gedolah": string[];
+            "Mincha Ketanah": string[];
+            "Plag HaMincha": string[];
+            Dusk: string[];
+            Sunset: string[];
+            "Nightfall - End of ordained fasts": string[];
+            "Tzeit HaKochavim": string[];
+            Lovingkindness: string[];
+            Might: string[];
+            Beauty: string[];
+            Eternity: string[];
+            Splendor: string[];
+            Foundation: string[];
+            Majesty: string[];
+            day: string[];
+            "Chanukah Day 1": string[];
+            "Chanukah Day 2": string[];
+            "Chanukah Day 3": string[];
+            "Chanukah Day 4": string[];
+            "Chanukah Day 5": string[];
+            "Chanukah Day 6": string[];
+            "Chanukah Day 7": string[];
+            "Chanukah Day 7 (on Rosh Chodesh)": string[];
+            "Chanukah Day 8": string[];
+            "Chanukah Day 1 (on Shabbat)": string[];
+            "Chanukah Day 2 (on Shabbat)": string[];
+            "Chanukah Day 3 (on Shabbat)": string[];
+            "Chanukah Day 4 (on Shabbat)": string[];
+            "Chanukah Day 5 (on Shabbat)": string[];
+            "Chanukah Day 7 (on Shabbat)": string[];
+            "Chanukah Day 8 (on Shabbat)": string[];
+            "Shabbat Rosh Chodesh Chanukah": string[];
+            "Yom Kippur Katan": string[];
+            "Family Day": string[];
+            "Yitzhak Rabin Memorial Day": string[];
+            "Jabotinsky Day": string[];
+            "Herzl Day": string[];
+            "Ben-Gurion Day": string[];
+            "Hebrew Language Day": string[];
+            "Birkat Hachamah": string[];
+            "Shushan Purim Katan": string[];
+            "Purim Meshulash": string[];
+            "after sunset": string[];
+            Yerushalmi: string[];
+            "Chag HaBanot": string[];
+            Joshua: string[];
+            Judges: string[];
+            "I Samuel": string[];
+            "II Samuel": string[];
+            "I Kings": string[];
+            "II Kings": string[];
+            Isaiah: string[];
+            Jeremiah: string[];
+            Ezekiel: string[];
+            Hosea: string[];
+            Joel: string[];
+            Amos: string[];
+            Obadiah: string[];
+            Jonah: string[];
+            Micah: string[];
+            Nachum: string[];
+            Habakkuk: string[];
+            Zephaniah: string[];
+            Haggai: string[];
+            Zechariah: string[];
+            Malachi: string[];
+            Psalms: string[];
+            Proverbs: string[];
+            Job: string[];
+            "Song of Songs": string[];
+            Ruth: string[];
+            Lamentations: string[];
+            Ecclesiastes: string[];
+            Esther: string[];
+            Daniel: string[];
+            Ezra: string[];
+            Nehemiah: string[];
+            "I Chronicles": string[];
+            "II Chronicles": string[];
+            "Yom Kippur (Mincha)": string[];
+            "Tish'a B'Av (Mincha)": string[];
+            "Asara B'Tevet (Mincha)": string[];
+            "Ta'anit Bechorot (Mincha)": string[];
+            "Ta'anit Esther (Mincha)": string[];
+            "Tzom Gedaliah (Mincha)": string[];
+            "Tzom Tammuz (Mincha)": string[];
+            Molad: string[];
+            chalakim: string[];
+            "Pirkei Avot": string[];
+        };
+    };
+};
+export default _default;

package/dist/hebcal.d.ts

@@ -1,10 +1,18 @@
+import { HDate } from '@hebcal/hdate';
+import './locale';
+import { CalOptions } from './CalOptions';
+import { Event } from './event';
+import { Sedra } from './sedra';
+import { HolidayYearMap } from './holidays';
+import { HolidayEvent } from './HolidayEvent';
+import { TachanunResult } from './tachanun';
 /**
  * HebrewCalendar is the main interface to the `@hebcal/core` library.
  * This namespace is used to calculate holidays, rosh chodesh, candle lighting & havdalah times,
  * Parashat HaShavua, Daf Yomi, days of the omer, and the molad.
  * Event names can be rendered in several languges using the `locale` option.
  */
-export class HebrewCalendar {
+export declare class HebrewCalendar {
     /**
      * Calculates holidays and other Hebrew calendar events based on {@link CalOptions}.
      *
@@ -114,7 +122,7 @@ export class HebrewCalendar {
      * @param {CalOptions} [options={}]
      * @return {Event[]}
      */
-    static calendar(options?: import("./CalOptions").CalOptions | undefined): Event[];
+    static calendar(options?: CalOptions): Event[];
     /**
      * Calculates a birthday or anniversary (non-yahrzeit).
      * `hyear` must be after original `gdate` of anniversary.
@@ -139,9 +147,9 @@ export class HebrewCalendar {
      * console.log(hd.greg().toLocaleDateString('en-US')); // '3/26/2020'
      * @param {number} hyear Hebrew year
      * @param {Date|HDate} gdate Gregorian or Hebrew date of event
-     * @return {HDate} anniversary occurring in `hyear`
+     * @return {HDate | undefined} anniversary occurring in `hyear`
      */
-    static getBirthdayOrAnniversary(hyear: number, gdate: Date | HDate): HDate;
+    static getBirthdayOrAnniversary(hyear: number, gdate: Date | HDate): HDate | undefined;
     /**
      * Calculates yahrzeit.
      * `hyear` must be after original `gdate` of death.
@@ -174,32 +182,32 @@ export class HebrewCalendar {
      * console.log(hd.greg().toLocaleDateString('en-US')); // '2/25/2020'
      * @param {number} hyear Hebrew year
      * @param {Date|HDate} gdate Gregorian or Hebrew date of death
-     * @return {HDate} anniversary occurring in hyear
+     * @return {HDate | undefined} anniversary occurring in hyear
      */
-    static getYahrzeit(hyear: number, gdate: Date | HDate): HDate;
+    static getYahrzeit(hyear: number, gdate: Date | HDate): HDate | undefined;
     /**
      * Lower-level holidays interface, which returns a `Map` of `Event`s indexed by
      * `HDate.toString()`. These events must filtered especially for `flags.IL_ONLY`
      * or `flags.CHUL_ONLY` depending on Israel vs. Diaspora holiday scheme.
      * @function
      * @param {number} year Hebrew year
-     * @return {Map<string,Event[]>}
+     * @return {HolidayYearMap}
      */
-    static getHolidaysForYear(year: number): Map<string, Event[]>;
+    static getHolidaysForYear(year: number): HolidayYearMap;
     /**
      * Returns an array of holidays for the year
      * @param {number} year Hebrew year
      * @param {boolean} il use the Israeli schedule for holidays
-     * @return {Event[]}
+     * @return {HolidayEvent[]}
      */
-    static getHolidaysForYearArray(year: number, il: boolean): Event[];
+    static getHolidaysForYearArray(year: number, il: boolean): HolidayEvent[];
     /**
      * Returns an array of Events on this date (or `undefined` if no events)
      * @param {HDate|Date|number} date Hebrew Date, Gregorian date, or absolute R.D. day number
      * @param {boolean} [il] use the Israeli schedule for holidays
-     * @return {Event[]}
+     * @return {HolidayEvent[] | undefined}
      */
-    static getHolidaysOnDate(date: HDate | Date | number, il?: boolean | undefined): Event[];
+    static getHolidaysOnDate(date: HDate | Date | number, il?: boolean): HolidayEvent[] | undefined;
     /**
      * Eruv Tavshilin
      * @param {Date | HDate} date
@@ -270,20 +278,3 @@ export class HebrewCalendar {
      */
     static tachanun(hdate: HDate, il: boolean): TachanunResult;
 }
-export type CalOptions = import('./CalOptions').CalOptions;
-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;
-};
-export type Event = import('./event').Event;
-import { HDate } from '@hebcal/hdate';

package/dist/holidays.d.ts

@@ -1,32 +1,9 @@
+import { HolidayEvent } from './HolidayEvent';
+export type HolidayYearMap = Map<string, HolidayEvent[]>;
 /**
  * Lower-level holidays interface, which returns a `Map` of `Event`s indexed by
  * `HDate.toString()`. These events must filtered especially for `flags.IL_ONLY`
  * or `flags.CHUL_ONLY` depending on Israel vs. Diaspora holiday scheme.
  * @private
- * @param {number} year Hebrew year
- * @return {Map<string,Event[]>}
  */
-export function getHolidaysForYear_(year: number): Map<string, Event[]>;
-/** Represents Rosh Chodesh, the beginning of a new month */
-export class RoshChodeshEvent extends HolidayEvent {
-    /**
-     * Constructs Rosh Chodesh event
-     * @param {HDate} date Hebrew date event occurs
-     * @param {string} monthName Hebrew month name (not translated)
-     */
-    constructor(date: HDate, monthName: string);
-}
-/** Represents Rosh Hashana, the Jewish New Year */
-export class RoshHashanaEvent extends HolidayEvent {
-    /**
-     * @private
-     * @param {HDate} date Hebrew date event occurs
-     * @param {number} hyear Hebrew year
-     * @param {number} mask optional holiday flags
-     */
-    private constructor();
-    hyear: number;
-}
-export const NISAN: number;
-import { HolidayEvent } from './HolidayEvent';
-import { HDate } from '@hebcal/hdate';
+export declare function getHolidaysForYear_(year: number): HolidayYearMap;