@hebcal/core 6.0.6 → 6.0.7

package/dist/src/hallel.js

@@ -0,0 +1,47 @@
+import { months } from '@hebcal/hdate';
+import { flags } from './event';
+const NONE = 0;
+const HALF = 1;
+const WHOLE = 2;
+/**
+ * @private
+ */
+export function hallel_(events, hdate) {
+    const whole = events
+        .filter(ev => {
+        const desc = ev.getDesc();
+        const hd = ev.getDate();
+        const month = hd.getMonth();
+        const mday = hd.getDate();
+        return (desc.startsWith('Chanukah') ||
+            desc.startsWith('Shavuot') ||
+            desc.startsWith('Sukkot') ||
+            (month === months.NISAN &&
+                (mday === 15 || mday === 16) &&
+                ev.getFlags() & flags.CHAG) || // Pesach
+            desc === "Yom HaAtzma'ut" ||
+            desc === 'Yom Yerushalayim');
+    })
+        .map(ev => {
+        return ev.getDate().abs();
+    });
+    const abs = hdate.abs();
+    if (whole.includes(abs)) {
+        return WHOLE;
+    }
+    const half = events
+        .filter(ev => {
+        const desc = ev.getDesc();
+        return (ev.getFlags() & flags.ROSH_CHODESH ||
+            (desc.startsWith('Pesach') &&
+                desc !== 'Pesach I' &&
+                desc !== 'Pesach II'));
+    })
+        .map(ev => {
+        return ev.getDate().abs();
+    });
+    if (half.includes(abs)) {
+        return HALF;
+    }
+    return NONE;
+}

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

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

package/dist/src/he-x-NoNikud.po.js

@@ -0,0 +1 @@
+export default { "headers": { "plural-forms": "nplurals=2; plural=(n != 1);", "language": "he-x-NoNikud" }, "contexts": { "": { "Korach": ["קורח"], "Chukat": ["חוקת"], "Yom Kippur": ["יום כיפור"], "Yom Kippur Katan": ["יום כיפור קטן"] } } };

package/dist/src/he.po.d.ts

@@ -0,0 +1,195 @@
+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/src/he.po.js

@@ -0,0 +1 @@
+export default { "headers": { "plural-forms": "nplurals=2; plural=(n > 1);", "language": "he_IL" }, "contexts": { "": { "Shabbat": ["שַׁבָּת"], "Parashat": ["פָּרָשַׁת"], "Achrei Mot": ["אַחֲרֵי מוֹת"], "Balak": ["בָּלָק"], "Bamidbar": ["בְּמִדְבַּר"], "Bechukotai": ["בְּחֻקֹּתַי"], "Beha'alotcha": ["בְּהַעֲלֹתְךָ"], "Behar": ["בְּהַר"], "Bereshit": ["בְּרֵאשִׁית"], "Beshalach": ["בְּשַׁלַּח"], "Bo": ["בֹּא"], "Chayei Sara": ["חַיֵּי שָֹרָה"], "Chukat": ["חֻקַּת"], "Devarim": ["דְּבָרִים"], "Eikev": ["עֵקֶב"], "Emor": ["אֱמוֹר"], "Ha'azinu": ["הַאֲזִינוּ"], "Kedoshim": ["קְדֹשִׁים"], "Ki Tavo": ["כִּי־תָבוֹא"], "Ki Teitzei": ["כִּי־תֵצֵא"], "Ki Tisa": ["כִּי תִשָּׂא"], "Korach": ["קֹרַח"], "Lech-Lecha": ["לֶךְ־לְךָ"], "Masei": ["מַסְעֵי"], "Matot": ["מַטּוֹת"], "Metzora": ["מְצֹרָע"], "Miketz": ["מִקֵּץ"], "Mishpatim": ["מִשְׁפָּטִים"], "Nasso": ["נָשׂא"], "Nitzavim": ["נִצָּבִים"], "Noach": ["נֹחַ"], "Pekudei": ["פְקוּדֵי"], "Pinchas": ["פִּינְחָס"], "Re'eh": ["רְאֵה"], "Sh'lach": ["שְׁלַח־לְךָ"], "Shemot": ["שְׁמוֹת"], "Shmini": ["שְּׁמִינִי"], "Shoftim": ["שׁוֹפְטִים"], "Tazria": ["תַזְרִיעַ"], "Terumah": ["תְּרוּמָה"], "Tetzaveh": ["תְּצַוֶּה"], "Toldot": ["תּוֹלְדוֹת"], "Tzav": ["צַו"], "Vaera": ["וָאֵרָא"], "Vaetchanan": ["וָאֶתְחַנַּן"], "Vayakhel": ["וַיַּקְהֵל"], "Vayechi": ["וַיְחִי"], "Vayeilech": ["וַיֵּלֶךְ"], "Vayera": ["וַיֵּרָא"], "Vayeshev": ["וַיֵּשֶׁב"], "Vayetzei": ["וַיֵּצֵא"], "Vayigash": ["וַיִּגַּשׁ"], "Vayikra": ["וַיִּקְרָא"], "Vayishlach": ["וַיִּשְׁלַח"], "Vezot Haberakhah": ["וְזֹאת הַבְּרָכָה"], "Yitro": ["יִתְרוֹ"], "Asara B'Tevet": ["עֲשָׂרָה בְּטֵבֵת"], "Candle lighting": ["הַדְלָקַת נֵרוֹת"], "Chanukah": ["חֲנוּכָּה"], "Chanukah: 1 Candle": ["חֲנוּכָּה: א׳ נֵר"], "Chanukah: 2 Candles": ["חֲנוּכָּה: ב׳ נֵרוֹת"], "Chanukah: 3 Candles": ["חֲנוּכָּה: ג׳ נֵרוֹת"], "Chanukah: 4 Candles": ["חֲנוּכָּה: ד׳ נֵרוֹת"], "Chanukah: 5 Candles": ["חֲנוּכָּה: ה׳ נֵרוֹת"], "Chanukah: 6 Candles": ["חֲנוּכָּה: ו׳ נֵרוֹת"], "Chanukah: 7 Candles": ["חֲנוּכָּה: ז׳ נֵרוֹת"], "Chanukah: 8 Candles": ["חֲנוּכָּה: ח׳ נֵרוֹת"], "Chanukah: 8th Day": ["חֲנוּכָּה: יוֹם ח׳"], "Days of the Omer": ["סְפִירַת הָעוֹמֶר"], "Omer": ["עוֹמֶר"], "day of the Omer": ["בָּעוֹמֶר"], "Erev Pesach": ["עֶרֶב פֶּסַח"], "Erev Purim": ["עֶרֶב פּוּרִים"], "Erev Rosh Hashana": ["עֶרֶב רֹאשׁ הַשָּׁנָה"], "Erev Shavuot": ["עֶרֶב שָׁבוּעוֹת"], "Erev Simchat Torah": ["עֶרֶב שִׂמְחַת תּוֹרָה"], "Erev Sukkot": ["עֶרֶב סוּכּוֹת"], "Erev Tish'a B'Av": ["עֶרֶב תִּשְׁעָה בְּאָב"], "Erev Yom Kippur": ["עֶרֶב יוֹם כִּפּוּר"], "Havdalah": ["הַבְדָּלָה"], "Lag BaOmer": ["ל״ג בָּעוֹמֶר"], "Leil Selichot": ["סְלִיחוֹת"], "Pesach": ["פֶּסַח"], "Pesach I": ["פֶּסַח א׳"], "Pesach II": ["פֶּסַח ב׳"], "Pesach II (CH''M)": ["פֶּסַח ב׳ (חוה״מ)"], "Pesach III (CH''M)": ["פֶּסַח ג׳ (חוה״מ)"], "Pesach IV (CH''M)": ["פֶּסַח ד׳ (חוה״מ)"], "Pesach Sheni": ["פֶּסַח שֵׁנִי"], "Pesach V (CH''M)": ["פֶּסַח ה׳ (חוה״מ)"], "Pesach VI (CH''M)": ["פֶּסַח ו׳ (חוה״מ)"], "Pesach VII": ["פֶּסַח ז׳"], "Pesach VIII": ["פֶּסַח ח׳"], "Pesach Shabbat Chol ha-Moed": ["פֶּסַח שַׁבָּת חוֹל הַמּוֹעֵד"], "Purim": ["פּוּרִים"], "Purim Katan": ["פּוּרִים קָטָן"], "Rosh Chodesh %s": ["רֹאשׁ חוֹדֶשׁ %s"], "Rosh Chodesh": ["רֹאשׁ חוֹדֶשׁ"], "Rosh Hashana": ["רֹאשׁ הַשָּׁנָה"], "Rosh Hashana I": ["רֹאשׁ הַשָּׁנָה א׳"], "Rosh Hashana II": ["רֹאשׁ הַשָּׁנָה ב׳"], "Shabbat Chazon": ["שַׁבַּת חֲזוֹן"], "Shabbat HaChodesh": ["שַׁבַּת הַחֹדֶשׁ"], "Shabbat HaGadol": ["שַׁבַּת הַגָּדוֹל"], "Shabbat Nachamu": ["שַׁבַּת נַחֲמוּ"], "Shabbat Parah": ["שַׁבַּת פָּרָה"], "Shabbat Shekalim": ["שַׁבַּת שְׁקָלִים"], "Shabbat Shuva": ["שַׁבַּת שׁוּבָה"], "Shabbat Zachor": ["שַׁבַּת זָכוֹר"], "Shavuot": ["שָׁבוּעוֹת"], "Shavuot I": ["שָׁבוּעוֹת א׳"], "Shavuot II": ["שָׁבוּעוֹת ב׳"], "Shmini Atzeret": ["שְׁמִינִי עֲצֶרֶת"], "Shushan Purim": ["שׁוּשָׁן פּוּרִים"], "Sigd": ["חַג הַסִּיגְד"], "Simchat Torah": ["שִׂמְחַת תּוֹרָה"], "Sukkot": ["סוּכּוֹת"], "Sukkot I": ["סוּכּוֹת א׳"], "Sukkot II": ["סוּכּוֹת ב׳"], "Sukkot II (CH''M)": ["סוּכּוֹת ב׳ (חוה״מ)"], "Sukkot III (CH''M)": ["סוּכּוֹת ג׳ (חוה״מ)"], "Sukkot IV (CH''M)": ["סוּכּוֹת ד׳ (חוה״מ)"], "Sukkot V (CH''M)": ["סוּכּוֹת ה׳ (חוה״מ)"], "Sukkot VI (CH''M)": ["סוּכּוֹת ו׳ (חוה״מ)"], "Sukkot VII (Hoshana Raba)": ["סוּכּוֹת ז׳ (הוֹשַׁעְנָא רַבָּה)"], "Sukkot Shabbat Chol ha-Moed": ["סוּכּוֹת שַׁבָּת חוֹל הַמּוֹעֵד"], "Ta'anit Bechorot": ["תַּעֲנִית בְּכוֹרוֹת"], "Ta'anit Esther": ["תַּעֲנִית אֶסְתֵּר"], "Tish'a B'Av": ["תִּשְׁעָה בְּאָב"], "Tu B'Av": ["ט״וּ בְּאָב"], "Tu BiShvat": ["ט״וּ בִּשְׁבָט"], "Tu B'Shvat": ["ט״וּ בִּשְׁבָט"], "Tzom Gedaliah": ["צוֹם גְּדַלְיָה"], "Tzom Tammuz": ["צוֹם י״ז בְּתַמּוּז"], "Yom HaAtzma'ut": ["יוֹם הָעַצְמָאוּת"], "Yom HaShoah": ["יוֹם הַשּׁוֹאָה"], "Yom HaZikaron": ["יוֹם הַזִּכָּרוֹן"], "Yom Kippur": ["יוֹם כִּפּוּר"], "Yom Yerushalayim": ["יוֹם יְרוּשָׁלַיִם"], "Yom HaAliyah": ["יוֹם הַעֲלִיָּה"], "Yom HaAliyah School Observance": ["שְׁמִירָת בֵּית הַסֵפֶר לְיוֹם הַעֲלִיָּה"], "Rosh Chodesh Adar": ["רֹאשׁ חוֹדֶשׁ אֲדָר"], "Rosh Chodesh Adar I": ["רֹאשׁ חוֹדֶשׁ אֲדָר א׳"], "Rosh Chodesh Adar II": ["רֹאשׁ חוֹדֶשׁ אֲדָר ב׳"], "Rosh Chodesh Av": ["רֹאשׁ חוֹדֶשׁ אָב"], "Rosh Chodesh Cheshvan": ["רֹאשׁ חוֹדֶשׁ חֶשְׁוָן"], "Rosh Chodesh Elul": ["רֹאשׁ חוֹדֶשׁ אֱלוּל"], "Rosh Chodesh Iyyar": ["רֹאשׁ חוֹדֶשׁ אִיָּיר"], "Rosh Chodesh Kislev": ["רֹאשׁ חוֹדֶשׁ כִּסְלֵו"], "Rosh Chodesh Nisan": ["רֹאשׁ חוֹדֶשׁ נִיסָן"], "Rosh Chodesh Sh'vat": ["רֹאשׁ חוֹדֶשׁ שְׁבָט"], "Rosh Chodesh Sivan": ["רֹאשׁ חוֹדֶשׁ סִיוָן"], "Rosh Chodesh Tamuz": ["רֹאשׁ חוֹדֶשׁ תַּמּוּז"], "Rosh Chodesh Tammuz": ["רֹאשׁ חוֹדֶשׁ תַּמּוּז"], "Rosh Chodesh Tevet": ["רֹאשׁ חוֹדֶשׁ טֵבֵת"], "min": ["דַּקּוֹת"], "Fast begins": ["תְּחִילַּת הַצוֹם"], "Fast ends": ["סִיּוּם הַצוֹם"], "Rosh Hashana LaBehemot": ["רֹאשׁ הַשָּׁנָה לְמַעְשַׂר בְּהֵמָה"], "Tish'a B'Av (observed)": ["(תִּשְׁעָה בְּאָב (נִדְחָה"], "Shabbat Mevarchim Chodesh": ["שַׁבַּת מְבָרְכִים חוֹדֶשׁ"], "Shabbat Shirah": ["שַׁבַּת שִׁירָה"], "Lovingkindness": ["חֶסֶד"], "Might": ["גְּבוּרָה"], "Beauty": ["תִּפְאֶרֶת"], "Eternity": ["נֶּצַח"], "Splendor": ["הוֹד"], "Foundation": ["יְּסוֹד"], "Majesty": ["מַּלְכוּת"], "day": ["יוֹם"], "Yom Kippur Katan": ["יוֹם כִּפּוּר קָטָן"], "Yizkor": ["יִזְכּוֹר"], "Family Day": ["יוֹם הַמִּשׁפָּחָה"], "Yitzhak Rabin Memorial Day": ["יוֹם הַזִּכָּרוֹן לְיִצְחָק רַבִּין"], "Jabotinsky Day": ["יוֹם זַ׳בּוֹטִינְסְקִי"], "Herzl Day": ["יוֹם הֵרְצְל"], "Ben-Gurion Day": ["יוֹם בן־גוריון"], "Hebrew Language Day": ["יוֹם הַשָׂפָה הַעִברִית"], "Birkat Hachamah": ["בִּרְכַּת הַחַמָּה"], "Shushan Purim Katan": ["שׁוּשָׁן פּוּרִים קָטָן"], "Purim Meshulash": ["פּוּרִים מְשׁוּלָּשׁ"], "Chag HaBanot": ["חַג הַבָּנוֹת"], "Molad": ["מוֹלָד הָלְּבָנָה"], "chalakim": ["חֲלָקִים"] } } };

package/dist/src/hebcal.d.ts

@@ -0,0 +1,260 @@
+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;
+}