@hebcal/core 6.1.0 → 6.2.0

package/dist/sedra.d.ts

@@ -1,95 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import './locale';
-/** The result from `Sedra.lookup()` */
-export type SedraResult = {
-    /**
-     * Name of the parsha (or parshiyot) read on
-     * Hebrew date, e.g. `['Noach']` or `['Matot', 'Masei']`
-     */
-    parsha: string[];
-    /**
-     * False if this is a regular parashat HaShavua reading.
-     * True if it's a special holiday reading.
-     */
-    chag: boolean;
-    /**
-     * The parsha number (or numbers) using 1-indexing.
-     * A `number` for a regular (single) parsha, and a `number[]`
-     * for a doubled parsha.
-     * For Parashat *Bereshit*, `num` would be equal to `1`, and for
-     * *Matot-Masei* it would be `[42, 43]`
-     * For a chag (holiday) reading, `num` will be `0`.
-     */
-    num: number | number[];
-    /** The date of the Shabbat this parsha is read */
-    hdate: HDate;
-    /** true if Israel, false for Diaspora */
-    il: boolean;
-};
-/**
- * Represents Parashah HaShavua for an entire Hebrew year
- */
-export declare class Sedra {
-    private readonly year;
-    private readonly il;
-    private readonly rh;
-    private readonly firstSaturday;
-    private readonly theSedraArray;
-    private readonly yearKey;
-    /**
-     * Caculates the Parashah HaShavua for an entire Hebrew year
-     * @param hyear - Hebrew year (e.g. 5749)
-     * @param il - Use Israel sedra schedule (false for Diaspora)
-     */
-    constructor(hyear: number, il: boolean);
-    /**
-     * Returns the date that a parsha occurs
-     * or `null` if the parsha doesn't occur this year
-     * @param parsha if a `string`, specified with Sephardic transliterations
-     *  like `'Noach'` or `'Matot-Masei'`. If an array, must be a 1- or 2-element
-     *  array such as `['Noach']` or `['Matot', 'Masei']`. If a `number`, should
-     *  be a 0-based parsha index (`0` for Bereshit, `1` for Noach) or a negative
-     *  number for a doubled parsha (e.g. `-21` for Vayakhel-Pekudei)
-     */
-    find(parsha: number | string | string[]): HDate | null;
-    private findInternal;
-    /**
-     * Returns the date that a parsha (or its doubled or undoubled counterpart)
-     * occurs, or `null` if the parsha doesn't occur this year
-     */
-    findContaining(parsha: number | string): HDate | null;
-    /**
-     * Returns the underlying annual sedra schedule.
-     * Used by `@hebcal/triennial`
-     */
-    getSedraArray(): readonly NumberOrString[];
-    /**
-     * R.D. date of the first Saturday on or after Rosh Hashana
-     */
-    getFirstSaturday(): number;
-    getYear(): number;
-    /**
-     * Returns an object describing the parsha on the first Saturday on or after `hd`
-     * @param hd Hebrew date or R.D. days
-     */
-    lookup(hd: HDate | number): SedraResult;
-}
-/**
- * The 54 parshiyot of the Torah as transilterated strings.
- * * parshiot[0] == `Bereshit`
- * * parshiot[1] == `Noach`
- * * parshiot[52] == `Ha'azinu`
- * * parshiot[53] == `Vezot Haberakhah`
- * @readonly
- * @type {string[]}
- */
-export declare const parshiot: readonly string[];
-type NumberOrString = number | string;
-/**
- * Convenience function to create an instance of `Sedra` or reuse a previously
- * created and cached instance.
- * @param hyear
- * @param il
- */
-export declare function getSedra(hyear: number, il: boolean): Sedra;
-export {};

package/dist/staticHolidays.d.ts

@@ -1,176 +0,0 @@
-/**
- * Transliterated names of holidays, used by `Event.getDesc()`
- * @readonly
- * @enum {string}
- */
-export declare const holidayDesc: {
-    /** Asara B'Tevet */
-    readonly ASARA_BTEVET: "Asara B'Tevet";
-    /** Birkat Hachamah */
-    readonly BIRKAT_HACHAMAH: "Birkat Hachamah";
-    /** Chag HaBanot */
-    readonly CHAG_HABANOT: "Chag HaBanot";
-    /** Chanukah: 8th Day */
-    readonly CHANUKAH_8TH_DAY: "Chanukah: 8th Day";
-    /** Erev Tish'a B'Av */
-    readonly EREV_TISHA_BAV: "Erev Tish'a B'Av";
-    /** Leil Selichot */
-    readonly LEIL_SELICHOT: "Leil Selichot";
-    /** Purim Katan */
-    readonly PURIM_KATAN: "Purim Katan";
-    /** Purim Meshulash */
-    readonly PURIM_MESHULASH: "Purim Meshulash";
-    /** Shabbat Chazon */
-    readonly SHABBAT_CHAZON: "Shabbat Chazon";
-    /** Shabbat HaChodesh */
-    readonly SHABBAT_HACHODESH: "Shabbat HaChodesh";
-    /** Shabbat HaGadol */
-    readonly SHABBAT_HAGADOL: "Shabbat HaGadol";
-    /** Shabbat Nachamu */
-    readonly SHABBAT_NACHAMU: "Shabbat Nachamu";
-    /** Shabbat Parah */
-    readonly SHABBAT_PARAH: "Shabbat Parah";
-    /** Shabbat Shekalim */
-    readonly SHABBAT_SHEKALIM: "Shabbat Shekalim";
-    /** Shabbat Shirah */
-    readonly SHABBAT_SHIRAH: "Shabbat Shirah";
-    /** Shabbat Shuva */
-    readonly SHABBAT_SHUVA: "Shabbat Shuva";
-    /** Shabbat Zachor */
-    readonly SHABBAT_ZACHOR: "Shabbat Zachor";
-    /** Shushan Purim Katan */
-    readonly SHUSHAN_PURIM_KATAN: "Shushan Purim Katan";
-    /** Ta'anit Bechorot */
-    readonly TAANIT_BECHOROT: "Ta'anit Bechorot";
-    /** Ta'anit Esther */
-    readonly TAANIT_ESTHER: "Ta'anit Esther";
-    /** Tish'a B'Av */
-    readonly TISHA_BAV: "Tish'a B'Av";
-    /** Tzom Gedaliah */
-    readonly TZOM_GEDALIAH: "Tzom Gedaliah";
-    /** Tzom Tammuz */
-    readonly TZOM_TAMMUZ: "Tzom Tammuz";
-    /** Yom HaAtzma'ut */
-    readonly YOM_HAATZMA_UT: "Yom HaAtzma'ut";
-    /** Yom HaShoah */
-    readonly YOM_HASHOAH: "Yom HaShoah";
-    /** Yom HaZikaron */
-    readonly YOM_HAZIKARON: "Yom HaZikaron";
-    /** Ben-Gurion Day */
-    readonly BEN_GURION_DAY: "Ben-Gurion Day";
-    /** Chanukah: 1 Candle */
-    readonly CHANUKAH_1_CANDLE: "Chanukah: 1 Candle";
-    /** Erev Pesach */
-    readonly EREV_PESACH: "Erev Pesach";
-    /** Erev Purim */
-    readonly EREV_PURIM: "Erev Purim";
-    /** Erev Rosh Hashana */
-    readonly EREV_ROSH_HASHANA: "Erev Rosh Hashana";
-    /** Erev Shavuot */
-    readonly EREV_SHAVUOT: "Erev Shavuot";
-    /** Erev Sukkot */
-    readonly EREV_SUKKOT: "Erev Sukkot";
-    /** Erev Yom Kippur */
-    readonly EREV_YOM_KIPPUR: "Erev Yom Kippur";
-    /** Family Day */
-    readonly FAMILY_DAY: "Family Day";
-    /** Hebrew Language Day */
-    readonly HEBREW_LANGUAGE_DAY: "Hebrew Language Day";
-    /** Herzl Day */
-    readonly HERZL_DAY: "Herzl Day";
-    /** Jabotinsky Day */
-    readonly JABOTINSKY_DAY: "Jabotinsky Day";
-    /** Lag BaOmer */
-    readonly LAG_BAOMER: "Lag BaOmer";
-    /** Pesach I */
-    readonly PESACH_I: "Pesach I";
-    /** Pesach II */
-    readonly PESACH_II: "Pesach II";
-    /** Pesach III (CH''M) */
-    readonly PESACH_III_CHM: "Pesach III (CH''M)";
-    /** Pesach II (CH''M) */
-    readonly PESACH_II_CHM: "Pesach II (CH''M)";
-    /** Pesach IV (CH''M) */
-    readonly PESACH_IV_CHM: "Pesach IV (CH''M)";
-    /** Pesach Sheni */
-    readonly PESACH_SHENI: "Pesach Sheni";
-    /** Pesach VII */
-    readonly PESACH_VII: "Pesach VII";
-    /** Pesach VIII */
-    readonly PESACH_VIII: "Pesach VIII";
-    /** Pesach VI (CH''M) */
-    readonly PESACH_VI_CHM: "Pesach VI (CH''M)";
-    /** Pesach V (CH''M) */
-    readonly PESACH_V_CHM: "Pesach V (CH''M)";
-    /** Purim */
-    readonly PURIM: "Purim";
-    /** Rosh Hashana II */
-    readonly ROSH_HASHANA_II: "Rosh Hashana II";
-    /** Rosh Hashana LaBehemot */
-    readonly ROSH_HASHANA_LABEHEMOT: "Rosh Hashana LaBehemot";
-    /** Shavuot */
-    readonly SHAVUOT: "Shavuot";
-    /** Shavuot I */
-    readonly SHAVUOT_I: "Shavuot I";
-    /** Shavuot II */
-    readonly SHAVUOT_II: "Shavuot II";
-    /** Shmini Atzeret */
-    readonly SHMINI_ATZERET: "Shmini Atzeret";
-    /** Shushan Purim */
-    readonly SHUSHAN_PURIM: "Shushan Purim";
-    /** Sigd */
-    readonly SIGD: "Sigd";
-    /** Simchat Torah */
-    readonly SIMCHAT_TORAH: "Simchat Torah";
-    /** Sukkot I */
-    readonly SUKKOT_I: "Sukkot I";
-    /** Sukkot II */
-    readonly SUKKOT_II: "Sukkot II";
-    /** Sukkot III (CH''M) */
-    readonly SUKKOT_III_CHM: "Sukkot III (CH''M)";
-    /** Sukkot II (CH''M) */
-    readonly SUKKOT_II_CHM: "Sukkot II (CH''M)";
-    /** Sukkot IV (CH''M) */
-    readonly SUKKOT_IV_CHM: "Sukkot IV (CH''M)";
-    /** Sukkot VII (Hoshana Raba) */
-    readonly SUKKOT_VII_HOSHANA_RABA: "Sukkot VII (Hoshana Raba)";
-    /** Sukkot VI (CH''M) */
-    readonly SUKKOT_VI_CHM: "Sukkot VI (CH''M)";
-    /** Sukkot V (CH''M) */
-    readonly SUKKOT_V_CHM: "Sukkot V (CH''M)";
-    /** Tu B\'Av */
-    readonly TU_BAV: "Tu B'Av";
-    /** Tu BiShvat */
-    readonly TU_BISHVAT: "Tu BiShvat";
-    /** Yitzhak Rabin Memorial Day */
-    readonly YITZHAK_RABIN_MEMORIAL_DAY: "Yitzhak Rabin Memorial Day";
-    /** Yom HaAliyah */
-    readonly YOM_HAALIYAH: "Yom HaAliyah";
-    /** Yom HaAliyah School Observance */
-    readonly YOM_HAALIYAH_SCHOOL_OBSERVANCE: "Yom HaAliyah School Observance";
-    /** Yom Kippur */
-    readonly YOM_KIPPUR: "Yom Kippur";
-    /** Yom Yerushalayim */
-    readonly YOM_YERUSHALAYIM: "Yom Yerushalayim";
-};
-export interface Holiday {
-    mm: number;
-    dd: number;
-    desc: string;
-    flags: number;
-    chmDay?: number;
-    emoji?: string;
-}
-export declare const staticHolidays: Holiday[];
-export interface ModernHoliday {
-    firstYear: number;
-    mm: number;
-    dd: number;
-    desc: string;
-    chul?: boolean;
-    suppressEmoji?: boolean;
-    satPostponeToSun?: boolean;
-    friPostponeToSun?: boolean;
-    friSatMovetoThu?: boolean;
-}
-export declare const staticModernHolidays: ModernHoliday[];

package/dist/tachanun.d.ts

@@ -1,29 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-/**
- * Is *tachanun* said today?
- */
-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;
-};
-/**
- * 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.
- */
-export declare function tachanun(hdate: HDate, il: boolean): TachanunResult;