@hebcal/core 6.0.8 → 6.2.0

package/dist/event.d.ts

@@ -1,188 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import './locale';
-/**
- * Holiday flags for Event. These flags are typically
- * combined using bitwise arithmetic to form a mask.
- * @readonly
- * @enum {number}
- */
-export declare const flags: {
-    /** Chag, yontiff, yom tov */
-    readonly CHAG: 1;
-    /** Light candles 18 minutes before sundown */
-    readonly LIGHT_CANDLES: 2;
-    /** End of holiday (end of Yom Tov)  */
-    readonly YOM_TOV_ENDS: 4;
-    /** Observed only in the Diaspora (chutz l'aretz)  */
-    readonly CHUL_ONLY: 8;
-    /** Observed only in Israel */
-    readonly IL_ONLY: 16;
-    /** Light candles in the evening at Tzeit time (3 small stars) */
-    readonly LIGHT_CANDLES_TZEIS: 32;
-    /** Candle-lighting for Chanukah */
-    readonly CHANUKAH_CANDLES: 64;
-    /** Rosh Chodesh, beginning of a new Hebrew month */
-    readonly ROSH_CHODESH: 128;
-    /** Minor fasts like Tzom Tammuz, Ta'anit Esther, ... */
-    readonly MINOR_FAST: 256;
-    /** Shabbat Shekalim, Zachor, ... */
-    readonly SPECIAL_SHABBAT: 512;
-    /** Weekly sedrot on Saturdays */
-    readonly PARSHA_HASHAVUA: 1024;
-    /** Daily page of Talmud (Bavli) */
-    readonly DAF_YOMI: 2048;
-    /** Days of the Omer */
-    readonly OMER_COUNT: 4096;
-    /** Yom HaShoah, Yom HaAtzma'ut, ... */
-    readonly MODERN_HOLIDAY: 8192;
-    /** Yom Kippur and Tish'a B'Av */
-    readonly MAJOR_FAST: 16384;
-    /** On the Saturday before Rosh Chodesh */
-    readonly SHABBAT_MEVARCHIM: 32768;
-    /** Molad */
-    readonly MOLAD: 65536;
-    /** Yahrzeit or Hebrew Anniversary */
-    readonly USER_EVENT: 131072;
-    /** Daily Hebrew date ("11th of Sivan, 5780") */
-    readonly HEBREW_DATE: 262144;
-    /** A holiday that's not major, modern, rosh chodesh, or a fast day */
-    readonly MINOR_HOLIDAY: 524288;
-    /** Evening before a major or minor holiday */
-    readonly EREV: 1048576;
-    /** Chol haMoed, intermediate days of Pesach or Sukkot */
-    readonly CHOL_HAMOED: 2097152;
-    /** Mishna Yomi */
-    readonly MISHNA_YOMI: 4194304;
-    /** Yom Kippur Katan, minor day of atonement on the day preceeding each Rosh Chodesh */
-    readonly YOM_KIPPUR_KATAN: 8388608;
-    /** Daily page of Jerusalem Talmud (Yerushalmi) */
-    readonly YERUSHALMI_YOMI: 16777216;
-    /** Nach Yomi */
-    readonly NACH_YOMI: 33554432;
-    /** Daily Learning */
-    readonly DAILY_LEARNING: 67108864;
-    /** Yizkor */
-    readonly YIZKOR: 134217728;
-};
-/**
- * Represents an Event with a title, date, and flags.
- *
- * Events are used to represent holidays, candle-lighting times,
- * Torah readings, and more.
- *
- * To get the title of the event a language other than English
- * with Sephardic transliterations, use the `render()` method.
- */
-export declare class Event {
-    /** Hebrew date of this event */
-    readonly date: HDate;
-    /**
-     * Untranslated title of this event. Note that these description
-     * strings are always in English and will remain stable across releases.
-     * To get the title of the event in another language, use the
-     * `render()` method.
-     */
-    readonly desc: string;
-    /** Bitmask of optional event flags. See {@link flags} */
-    readonly mask: number;
-    /** Optional emoji character such as ✡️, 🕯️, 🕎, 🕍, 🌒 */
-    emoji?: string;
-    /** Optional longer description or memo text */
-    memo?: string;
-    /** Alarms are used by iCalendar feeds */
-    alarm?: Date | string | boolean;
-    /**
-     * Constructs Event
-     * @param date Hebrew date event occurs
-     * @param desc Description (not translated)
-     * @param [mask=0] optional bitmask of holiday flags (see {@link flags})
-     * @param [attrs={}] optional additional attributes (e.g. `eventTimeStr`, `cholHaMoedDay`)
-     */
-    constructor(date: HDate, desc: string, mask?: number, attrs?: object);
-    /**
-     * Hebrew date of this event
-     */
-    getDate(): HDate;
-    /**
-     * Gregorian date of this event
-     */
-    greg(): Date;
-    /**
-     * Untranslated title of this event. Note that these description
-     * strings are always in English and will remain stable across releases.
-     * To get the title of the event in another language, use the
-     * `render()` method.
-     */
-    getDesc(): string;
-    /**
-     * Bitmask of optional event flags. See {@link flags}
-     */
-    getFlags(): number;
-    /**
-     * Returns (translated) description of this event
-     * @example
-     * const ev = new Event(new HDate(6, 'Sivan', 5749), 'Shavuot', flags.CHAG);
-     * ev.render('en'); // 'Shavuot'
-     * ev.render('he'); // 'שָׁבוּעוֹת'
-     * ev.render('ashkenazi'); // 'Shavuos'
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    render(locale?: string): string;
-    /**
-     * Returns a brief (translated) description of this event.
-     * For most events, this is the same as render(). For some events, it procudes
-     * a shorter text (e.g. without a time or added description).
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    renderBrief(locale?: string): string;
-    /**
-     * Optional holiday-specific Emoji or `null`.
-     */
-    getEmoji(): string | null;
-    /**
-     * Returns a simplified (untranslated) description for this event. For example,
-     * the `HolidayEvent` class supports
-     * "Erev Pesach" => "Pesach", and "Sukkot III (CH''M)" => "Sukkot".
-     * For many holidays the basename and the event description are the same.
-     */
-    basename(): string;
-    /**
-     * Returns a URL to hebcal.com or sefaria.org for more detail on the event.
-     * Returns `undefined` for events with no detail page.
-     */
-    url(): string | undefined;
-    /**
-     * Is this event observed in Israel?
-     * @example
-     * const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
-     * ev1.observedInIsrael(); // false
-     * const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
-     * ev2.observedInIsrael(); // true
-     */
-    observedInIsrael(): boolean;
-    /**
-     * Is this event observed in the Diaspora?
-     * @example
-     * const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
-     * ev1.observedInDiaspora(); // true
-     * const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
-     * ev2.observedInDiaspora(); // true
-     */
-    observedInDiaspora(): boolean;
-    /**
-     * Is this event observed in Israel/Diaspora?
-     * @example
-     * const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
-     * ev1.observedIn(false); // true
-     * ev1.observedIn(true); // false
-     * const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
-     * ev2.observedIn(false); // true
-     * ev2.observedIn(true); // true
-     * @param il
-     */
-    observedIn(il: boolean): boolean;
-    /**
-     * Returns a list of event categories
-     */
-    getCategories(): string[];
-}

package/dist/getStartAndEnd.d.ts

@@ -1,6 +0,0 @@
-import { CalOptions } from './CalOptions';
-/**
- * Parse options object to determine start & end days
- * @private
- */
-export declare function getStartAndEnd(options: CalOptions): number[];

package/dist/hallel.d.ts

@@ -1,6 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import { Event } from './event';
-/**
- * @private
- */
-export declare function hallel_(events: Event[], hdate: HDate): number;

package/dist/he-x-NoNikud.po.d.ts

@@ -1,16 +0,0 @@
-declare const _default: {
-    headers: {
-        "plural-forms": string;
-        language: string;
-    };
-    contexts: {
-        "": {
-            Korach: string[];
-            Chukat: string[];
-            "Erev Yom Kippur": string[];
-            "Yom Kippur": string[];
-            "Yom Kippur Katan": string[];
-        };
-    };
-};
-export default _default;

package/dist/he.po.d.ts

@@ -1,195 +0,0 @@
-declare const _default: {
-    headers: {
-        "plural-forms": string;
-        language: string;
-    };
-    contexts: {
-        "": {
-            Shabbat: 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[];
-            "Pesach Shabbat Chol ha-Moed": 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 Nachamu": string[];
-            "Shabbat Parah": 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[];
-            "Sukkot Shabbat Chol ha-Moed": 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[];
-            "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 Tammuz": 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[];
-            Lovingkindness: string[];
-            Might: string[];
-            Beauty: string[];
-            Eternity: string[];
-            Splendor: string[];
-            Foundation: string[];
-            Majesty: string[];
-            day: string[];
-            "Yom Kippur Katan": string[];
-            Yizkor: 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[];
-            "Chag HaBanot": string[];
-            Molad: string[];
-            chalakim: string[];
-        };
-    };
-};
-export default _default;

package/dist/hebcal.d.ts

@@ -1,260 +0,0 @@
-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 declare class HebrewCalendar {
-    private constructor();
-    /**
-     * Calculates holidays and other Hebrew calendar events based on {@link CalOptions}.
-     *
-     * Each holiday is represented by an {@link Event} object which includes a date,
-     * a description, flags and optional attributes.
-     * If given no options, returns holidays for the Diaspora for the current Gregorian year.
-     *
-     * The date range returned by this function can be controlled by:
-     * * `options.year` - Gregorian (e.g. 1993) or Hebrew year (e.g. 5749)
-     * * `options.isHebrewYear` - to interpret `year` as Hebrew year
-     * * `options.numYears` - generate calendar for multiple years (default 1)
-     * * `options.month` - Gregorian or Hebrew month (to filter results to a single month)
-     *
-     * Alternatively, specify start and end days with `Date` or {@link HDate} instances:
-     * * `options.start` - use specific start date (requires `end` date)
-     * * `options.end` - use specific end date (requires `start` date)
-     *
-     * Unless `options.noHolidays == true`, default holidays include:
-     * * Major holidays - Rosh Hashana, Yom Kippur, Pesach, Sukkot, etc.
-     * * Minor holidays - Purim, Chanukah, Tu BiShvat, Lag BaOmer, etc.
-     * * Minor fasts - Ta'anit Esther, Tzom Gedaliah, etc. (unless `options.noMinorFast`)
-     * * Special Shabbatot - Shabbat Shekalim, Zachor, etc. (unless `options.noSpecialShabbat`)
-     * * Modern Holidays - Yom HaShoah, Yom HaAtzma'ut, etc. (unless `options.noModern`)
-     * * Rosh Chodesh (unless `options.noRoshChodesh`)
-     *
-     * Holiday and Torah reading schedules differ between Israel and the Disapora.
-     * Set `options.il=true` to use the Israeli schedule.
-     *
-     * Additional non-default event types can be specified:
-     * * Parashat HaShavua - weekly Torah Reading on Saturdays (`options.sedrot`)
-     * * Counting of the Omer (`options.omer`)
-     * * Shabbat Mevarchim HaChodesh on Saturday before Rosh Chodesh (`options.shabbatMevarchim`)
-     * * Molad announcement on Saturday before Rosh Chodesh (`options.molad`)
-     * * Yom Kippur Katan (`options.yomKippurKatan`)
-     * * Yizkor (`options.yizkor`)
-     *
-     * Daily Study of texts are supported by the
-     * {@link https://github.com/hebcal/hebcal-learning @hebcal/learning} package,
-     * for example:
-     * * Babylonian Talmud Daf Yomi (`options.dailyLearning.dafYomi`)
-     * * Jerusalem Talmud (Yerushalmi) Yomi (`options.dailyLearning.yerushalmi`)
-     * * Mishna Yomi (`options.dailyLearning.mishnaYomi`)
-     * * Nach Yomi (`options.dailyLearning.nachYomi`)
-     *
-     * Candle-lighting and Havdalah times are approximated using latitude and longitude
-     * specified by the {@link Location} class. The `Location` class contains a small
-     * database of cities with their associated geographic information and time-zone information.
-     * If you ever have any doubts about Hebcal's times, consult your local halachic authority.
-     * If you enter geographic coordinates above the arctic circle or antarctic circle,
-     * the times are guaranteed to be wrong.
-     *
-     * To add candle-lighting options, set `options.candlelighting=true` and set
-     * `options.location` to an instance of `Location`. By default, candle lighting
-     * time is 18 minutes before sundown (40 minutes for Jerusalem,
-     * 30 minutes for Haifa and Zikhron Ya'akov) and Havdalah is
-     * calculated according to Tzeit Hakochavim - Nightfall (the point when 3 small stars
-     * are observable in the night time sky with the naked eye). The default Havdalah
-     * option (Tzeit Hakochavim) is calculated when the sun is 8.5° below the horizon.
-     * These defaults can be changed using these options:
-     * * `options.candleLightingMins` - minutes before sundown to light candles
-     * * `options.havdalahMins` - minutes after sundown for Havdalah (typical values are 42, 50, or 72).
-     *    Havdalah times are suppressed when `options.havdalahMins=0`.
-     * * `options.havdalahDeg` - degrees for solar depression for Havdalah.
-     *    Default is 8.5 degrees for 3 small stars. Use 7.083 degrees for 3 medium-sized stars.
-     *    Havdalah times are suppressed when `options.havdalahDeg=0`.
-     *
-     * If both `options.candlelighting=true` and `options.location` is specified,
-     * Chanukah candle-lighting times and minor fast start/end times will also be generated.
-     * Chanukah candle-lighting is at Bein HaShmashos (13.5 minutes before
-     * the sun is 7.083° below the horizon in the evening)
-     * on weekdays, at regular candle-lighting time on Fridays, and at regular Havdalah time on
-     * Saturday night (see above).
-     *
-     * Minor fasts begin at Alot HaShachar (sun is 16.1° below the horizon in the morning) and
-     * end when 3 medium-sized stars are observable in the night sky (sun is 7.083° below the horizon
-     * in the evening).
-     *
-     * Two options also exist for generating an Event with the Hebrew date:
-     * * `options.addHebrewDates` - print the Hebrew date for the entire date range
-     * * `options.addHebrewDatesForEvents` - print the Hebrew date for dates with some events
-     *
-     * Lastly, translation and transliteration of event titles is controlled by
-     * `options.locale` and the {@link Locale} API.
-     * `@hebcal/core` supports three locales by default:
-     * * `en` - default, Sephardic transliterations (e.g. "Shabbat")
-     * * `ashkenazi` - Ashkenazi transliterations (e.g. "Shabbos")
-     * * `he` - Hebrew (e.g. "שַׁבָּת")
-     *
-     * Additional locales (such as `ru` or `fr`) are supported by the
-     * {@link https://github.com/hebcal/hebcal-locales @hebcal/locales} package
-     *
-     * @example
-     * import {HebrewCalendar, HDate, Location, Event} from '@hebcal/core';
-     * const options: CalOptions = {
-     *   year: 1981,
-     *   isHebrewYear: false,
-     *   candlelighting: true,
-     *   location: Location.lookup('San Francisco'),
-     *   sedrot: true,
-     *   omer: true,
-     * };
-     * const events = HebrewCalendar.calendar(options);
-     * for (const ev of events) {
-     *   const hd = ev.getDate();
-     *   const date = hd.greg();
-     *   console.log(date.toLocaleDateString(), ev.render('en'), hd.toString());
-     * }
-     */
-    static calendar(options?: CalOptions): Event[];
-    /**
-     * Calculates a birthday or anniversary (non-yahrzeit).
-     * `hyear` must be after original `gdate` of anniversary.
-     * Returns `undefined` when requested year preceeds or is same as original year.
-     *
-     * Hebcal uses the algorithm defined in "Calendrical Calculations"
-     * by Edward M. Reingold and Nachum Dershowitz.
-     *
-     * The birthday of someone born in Adar of an ordinary year or Adar II of
-     * a leap year is also always in the last month of the year, be that Adar
-     * or Adar II. The birthday in an ordinary year of someone born during the
-     * first 29 days of Adar I in a leap year is on the corresponding day of Adar;
-     * in a leap year, the birthday occurs in Adar I, as expected.
-     *
-     * Someone born on the thirtieth day of Marcheshvan, Kislev, or Adar I
-     * has his birthday postponed until the first of the following month in
-     * years where that day does not occur. [Calendrical Calculations p. 111]
-     * @example
-     * import {HebrewCalendar} from '@hebcal/core';
-     * const dt = new Date(2014, 2, 2); // '2014-03-02' == '30 Adar I 5774'
-     * const hd = HebrewCalendar.getBirthdayOrAnniversary(5780, dt); // '1 Nisan 5780'
-     * console.log(hd.greg().toLocaleDateString('en-US')); // '3/26/2020'
-     * @param hyear Hebrew year
-     * @param gdate Gregorian or Hebrew date of event
-     * @returns anniversary occurring in `hyear`
-     */
-    static getBirthdayOrAnniversary(hyear: number, gdate: Date | HDate): HDate | undefined;
-    /**
-     * Calculates yahrzeit.
-     * `hyear` must be after original `gdate` of death.
-     * Returns `undefined` when requested year preceeds or is same as original year.
-     *
-     * Hebcal uses the algorithm defined in "Calendrical Calculations"
-     * by Edward M. Reingold and Nachum Dershowitz.
-     *
-     * The customary anniversary date of a death is more complicated and depends
-     * also on the character of the year in which the first anniversary occurs.
-     * There are several cases:
-     *
-     * * If the date of death is Marcheshvan 30, the anniversary in general depends
-     *   on the first anniversary; if that first anniversary was not Marcheshvan 30,
-     *   use the day before Kislev 1.
-     * * If the date of death is Kislev 30, the anniversary in general again depends
-     *   on the first anniversary — if that was not Kislev 30, use the day before
-     *   Tevet 1.
-     * * If the date of death is Adar II, the anniversary is the same day in the
-     *   last month of the Hebrew year (Adar or Adar II).
-     * * If the date of death is Adar I 30, the anniversary in a Hebrew year that
-     *   is not a leap year (in which Adar only has 29 days) is the last day in
-     *   Shevat.
-     * * In all other cases, use the normal (that is, same month number) anniversary
-     *   of the date of death. [Calendrical Calculations p. 113]
-     * @example
-     * import {HebrewCalendar} from '@hebcal/core';
-     * const dt = new Date(2014, 2, 2); // '2014-03-02' == '30 Adar I 5774'
-     * const hd = HebrewCalendar.getYahrzeit(5780, dt); // '30 Sh\'vat 5780'
-     * console.log(hd.greg().toLocaleDateString('en-US')); // '2/25/2020'
-     * @param hyear Hebrew year
-     * @param gdate Gregorian or Hebrew date of death
-     * @returns anniversary occurring in hyear
-     */
-    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.
-     * @param year Hebrew year
-     */
-    static getHolidaysForYear(year: number): HolidayYearMap;
-    /**
-     * Returns an array of holidays for the year
-     * @param year Hebrew year
-     * @param il use the Israeli schedule for holidays
-     */
-    static getHolidaysForYearArray(year: number, il: boolean): HolidayEvent[];
-    /**
-     * Returns an array of Events on this date (or `undefined` if no events)
-     * @param date Hebrew Date, Gregorian date, or absolute R.D. day number
-     * @param [il] use the Israeli schedule for holidays
-     */
-    static getHolidaysOnDate(date: HDate | Date | number, il?: boolean): HolidayEvent[] | undefined;
-    /**
-     * Eruv Tavshilin
-     */
-    static eruvTavshilin(date: Date | HDate, il: boolean): boolean;
-    /**
-     * Helper function to format a 23-hour (00:00-23:59) time in US format ("8:13pm") or
-     * keep as "20:13" for any other locale/country. Uses {@link CalOptions} to determine
-     * locale.
-     * If `options.hour12` is `false`, locale is ignored and always returns 24-hour time.
-     * If `options.hour12` is `true`, locale is ignored and always returns 12-hour time.
-     * @param timeStr - original time like "20:30"
-     * @param suffix - "p" or "pm" or " P.M.". Add leading space if you want it
-     * @param options
-     */
-    static reformatTimeStr(timeStr: string, suffix: string, options: CalOptions): string;
-    static version(): string;
-    /**
-     * Convenience function to create an instance of `Sedra` or reuse a previously
-     * 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;
-}