@hebcal/core 5.4.0 → 5.4.2

package/dist/dateFormat.d.ts

@@ -1,33 +0,0 @@
-/**
- * @private
- * @param {string} tzid
- * @param {Date} date
- * @return {string}
- */
-export function getPseudoISO(tzid: string, date: Date): string;
-/**
- * @private
- * @param {string} tzid
- * @param {Date} date
- * @return {number}
- */
-export function getTimezoneOffset(tzid: string, date: Date): number;
-/**
- * @private
- * @param {number} number
- * @return {string}
- */
-export function pad4(number: number): string;
-/**
- * @private
- * @param {number} number
- * @return {string}
- */
-export function pad2(number: number): string;
-/**
- * Returns YYYY-MM-DD in the local timezone
- * @private
- * @param {Date} dt
- * @return {string}
- */
-export function isoDateString(dt: Date): string;

package/dist/hdate.d.ts

@@ -1,395 +0,0 @@
-/**
- * A simple Hebrew date object with numeric fields `yy`, `mm`, and `dd`
- * @typedef {Object} SimpleHebrewDate
- * @property {number} yy Hebrew year
- * @property {number} mm Hebrew month of year (1=NISAN, 7=TISHREI)
- * @property {number} dd Day of month (1-30)
- * @private
- */
-/** Represents a Hebrew date */
-export class HDate {
-    /**
-     * Converts Hebrew date to R.D. (Rata Die) fixed days.
-     * R.D. 1 is the imaginary date Monday, January 1, 1 on the Gregorian
-     * Calendar.
-     * @param {number} year Hebrew year
-     * @param {number} month Hebrew month
-     * @param {number} day Hebrew date (1-30)
-     * @return {number}
-     */
-    static hebrew2abs(year: number, month: number, day: number): number;
-    /**
-     * @private
-     * @param {string} locale
-     * @return {string}
-     */
-    private static getDayOfTranslation;
-    /**
-     * @private
-     * @param {string} units
-     * @return {string}
-     */
-    private static standardizeUnits;
-    /**
-     * Returns true if Hebrew year is a leap year
-     * @param {number} year Hebrew year
-     * @return {boolean}
-     */
-    static isLeapYear(year: number): boolean;
-    /**
-     * Number of months in this Hebrew year (either 12 or 13 depending on leap year)
-     * @param {number} year Hebrew year
-     * @return {number}
-     */
-    static monthsInYear(year: number): number;
-    /**
-     * Number of days in Hebrew month in a given year (29 or 30)
-     * @param {number} month Hebrew month (e.g. months.TISHREI)
-     * @param {number} year Hebrew year
-     * @return {number}
-     */
-    static daysInMonth(month: number, year: number): number;
-    /**
-     * Returns a transliterated string name of Hebrew month in year,
-     * for example 'Elul' or 'Cheshvan'.
-     * @param {number} month Hebrew month (e.g. months.TISHREI)
-     * @param {number} year Hebrew year
-     * @return {string}
-     */
-    static getMonthName(month: number, year: number): string;
-    /**
-     * Returns the Hebrew month number (NISAN=1, TISHREI=7)
-     * @param {number|string} month A number, or Hebrew month name string
-     * @return {number}
-     */
-    static monthNum(month: number | string): number;
-    /**
-     * Number of days in the hebrew YEAR
-     * @param {number} year Hebrew year
-     * @return {number}
-     */
-    static daysInYear(year: number): number;
-    /**
-     * true if Cheshvan is long in Hebrew year
-     * @param {number} year Hebrew year
-     * @return {boolean}
-     */
-    static longCheshvan(year: number): boolean;
-    /**
-     * true if Kislev is short in Hebrew year
-     * @param {number} year Hebrew year
-     * @return {boolean}
-     */
-    static shortKislev(year: number): boolean;
-    /**
-     * Converts Hebrew month string name to numeric
-     * @param {string|number} monthName monthName
-     * @return {number}
-     */
-    static monthFromName(monthName: string | number): number;
-    /**
-     * Note: Applying this function to d+6 gives us the DAYNAME on or after an
-     * absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to
-     * absolute date d, applying it to d-1 gives the DAYNAME previous to absolute
-     * date d, and applying it to d+7 gives the DAYNAME following absolute date d.
-     * @param {number} dayOfWeek
-     * @param {number} absdate
-     * @return {number}
-     */
-    static dayOnOrBefore(dayOfWeek: number, absdate: number): number;
-    /**
-     * Tests if the object is an instance of `HDate`
-     * @param {any} obj
-     * @return {boolean}
-     */
-    static isHDate(obj: any): boolean;
-    /**
-     * Construct a new instance of `HDate` from a Gematriya-formatted string
-     * @example
-     *  HDate.fromGematriyaString('כ״ז בְּתַמּוּז תשפ״ג') // 27 Tamuz 5783
-     *  HDate.fromGematriyaString('כ׳ סיון תש״ד') // 20 Sivan 5704
-     *  HDate.fromGematriyaString('ה׳ אִיָיר תש״ח') // 5 Iyyar 5708
-     * @param {string} str
-     * @param {number} currentThousands
-     * @return {HDate}
-     */
-    static fromGematriyaString(str: string, currentThousands?: number): HDate;
-    /**
-     * Create a Hebrew date. There are 3 basic forms for the `HDate()` constructor.
-     *
-     * 1. No parameters - represents the current Hebrew date at time of instantiation
-     * 2. One parameter
-     *    * `Date` - represents the Hebrew date corresponding to the Gregorian date using
-     *       local time. Hours, minutes, seconds and milliseconds are ignored.
-     *    * `HDate` - clones a copy of the given Hebrew date
-     *    * `number` - Converts absolute R.D. days to Hebrew date.
-     *       R.D. 1 == the imaginary date January 1, 1 (Gregorian)
-     * 3. Three parameters: Hebrew day, Hebrew month, Hebrew year. Hebrew day should
-     *    be a number between 1-30, Hebrew month can be a number or string, and
-     *    Hebrew year is always a number.
-     * @example
-     * import {HDate, months} from '@hebcal/core';
-     *
-     * const hd1 = new HDate();
-     * const hd2 = new HDate(new Date(2008, 10, 13));
-     * const hd3 = new HDate(15, 'Cheshvan', 5769);
-     * const hd4 = new HDate(15, months.CHESHVAN, 5769);
-     * const hd5 = new HDate(733359); // ==> 15 Cheshvan 5769
-     * const monthName = 'אייר';
-     * const hd6 = new HDate(5, monthName, 5773);
-     * @param {number|Date|HDate} [day] - Day of month (1-30) if a `number`.
-     *   If a `Date` is specified, represents the Hebrew date corresponding to the
-     *   Gregorian date using local time.
-     *   If an `HDate` is specified, clones a copy of the given Hebrew date.
-     * @param {number|string} [month] - Hebrew month of year (1=NISAN, 7=TISHREI)
-     * @param {number} [year] - Hebrew year
-     */
-    constructor(day?: number | HDate | Date | undefined, month?: string | number | undefined, year?: number | undefined, ...args: any[]);
-    /**
-     * @private
-     * @type {number}
-     */
-    private dd;
-    private mm;
-    yy: number;
-    /**
-     * @private
-     * @type {number}
-     */
-    private rd;
-    /**
-     * Gets the Hebrew year of this Hebrew date
-     * @return {number}
-     */
-    getFullYear(): number;
-    /**
-     * Tests if this date occurs during a leap year
-     * @return {boolean}
-     */
-    isLeapYear(): boolean;
-    /**
-     * Gets the Hebrew month (1=NISAN, 7=TISHREI) of this Hebrew date
-     * @return {number}
-     */
-    getMonth(): number;
-    /**
-     * The Tishrei-based month of the date. 1 is Tishrei, 7 is Nisan, 13 is Elul in a leap year
-     * @return {number}
-     */
-    getTishreiMonth(): number;
-    /**
-     * Number of days in the month of this Hebrew date
-     * @return {number}
-     */
-    daysInMonth(): number;
-    /**
-     * Gets the day within the month (1-30)
-     * @return {number}
-     */
-    getDate(): number;
-    /**
-     * Gets the day of the week. 0=Sunday, 6=Saturday
-     * @return {number}
-     */
-    getDay(): number;
-    /**
-     * Sets the day of the month of the date. Returns the object it was called upon
-     * @private
-     * @param {number|string} month A number, or Hebrew month name string
-     * @return {HDate}
-     */
-    private setMonth;
-    /**
-     * @private
-     * @param {number} date
-     * @return {HDate}
-     */
-    private setDate;
-    /**
-     * Converts to Gregorian date
-     * @return {Date}
-     */
-    greg(): Date;
-    /**
-     * Returns R.D. (Rata Die) fixed days.
-     * R.D. 1 == Monday, January 1, 1 (Gregorian)
-     * Note also that R.D. = Julian Date − 1,721,424.5
-     * https://en.wikipedia.org/wiki/Rata_Die#Dershowitz_and_Reingold
-     * @return {number}
-     */
-    abs(): number;
-    /**
-     * Returns a transliterated Hebrew month name, e.g. `'Elul'` or `'Cheshvan'`.
-     * @return {string}
-     */
-    getMonthName(): string;
-    /**
-     * Renders this Hebrew date as a translated or transliterated string,
-     * including ordinal e.g. `'15th of Cheshvan, 5769'`.
-     * @example
-     * import {HDate, months} from '@hebcal/core';
-     *
-     * const hd = new HDate(15, months.CHESHVAN, 5769);
-     * console.log(hd.render('en')); // '15th of Cheshvan, 5769'
-     * console.log(hd.render('he')); // '15 חֶשְׁוָן, 5769'
-     * @param {string} [locale] Optional locale name (defaults to active locale).
-     * @param {boolean} [showYear=true] Display year (defaults to true).
-     * @return {string}
-     */
-    render(locale?: string | undefined, showYear?: boolean | undefined): string;
-    /**
-     * Renders this Hebrew date in Hebrew gematriya, regardless of locale.
-     * @example
-     * import {HDate, months} from '@hebcal/core';
-     * const hd = new HDate(15, months.CHESHVAN, 5769);
-     * console.log(hd.renderGematriya()); // 'ט״ו חֶשְׁוָן תשס״ט'
-     * @param {boolean} [suppressNikud]
-     * @return {string}
-     */
-    renderGematriya(suppressNikud?: boolean | undefined): string;
-    /**
-     * Returns an `HDate` representing the a dayNumber before the current date.
-     * Sunday=0, Saturday=6
-     * @example
-     * new HDate(new Date('Wednesday February 19, 2014')).before(6).greg() // Sat Feb 15 2014
-     * @param {number} day day of week
-     * @return {HDate}
-     */
-    before(day: number): HDate;
-    /**
-     * Returns an `HDate` representing the a dayNumber on or before the current date.
-     * Sunday=0, Saturday=6
-     * @example
-     * new HDate(new Date('Wednesday February 19, 2014')).onOrBefore(6).greg() // Sat Feb 15 2014
-     * new HDate(new Date('Saturday February 22, 2014')).onOrBefore(6).greg() // Sat Feb 22 2014
-     * new HDate(new Date('Sunday February 23, 2014')).onOrBefore(6).greg() // Sat Feb 22 2014
-     * @param {number} dow day of week
-     * @return {HDate}
-     */
-    onOrBefore(dow: number): HDate;
-    /**
-     * Returns an `HDate` representing the nearest dayNumber to the current date
-     * Sunday=0, Saturday=6
-     * @example
-     * new HDate(new Date('Wednesday February 19, 2014')).nearest(6).greg() // Sat Feb 22 2014
-     * new HDate(new Date('Tuesday February 18, 2014')).nearest(6).greg() // Sat Feb 15 2014
-     * @param {number} dow day of week
-     * @return {HDate}
-     */
-    nearest(dow: number): HDate;
-    /**
-     * Returns an `HDate` representing the a dayNumber on or after the current date.
-     * Sunday=0, Saturday=6
-     * @example
-     * new HDate(new Date('Wednesday February 19, 2014')).onOrAfter(6).greg() // Sat Feb 22 2014
-     * new HDate(new Date('Saturday February 22, 2014')).onOrAfter(6).greg() // Sat Feb 22 2014
-     * new HDate(new Date('Sunday February 23, 2014')).onOrAfter(6).greg() // Sat Mar 01 2014
-     * @param {number} dow day of week
-     * @return {HDate}
-     */
-    onOrAfter(dow: number): HDate;
-    /**
-     * Returns an `HDate` representing the a dayNumber after the current date.
-     * Sunday=0, Saturday=6
-     * @example
-     * new HDate(new Date('Wednesday February 19, 2014')).after(6).greg() // Sat Feb 22 2014
-     * new HDate(new Date('Saturday February 22, 2014')).after(6).greg() // Sat Mar 01 2014
-     * new HDate(new Date('Sunday February 23, 2014')).after(6).greg() // Sat Mar 01 2014
-     * @param {number} day day of week
-     * @return {HDate}
-     */
-    after(day: number): HDate;
-    /**
-     * Returns the next Hebrew date
-     * @return {HDate}
-     */
-    next(): HDate;
-    /**
-     * Returns the previous Hebrew date
-     * @return {HDate}
-     */
-    prev(): HDate;
-    /**
-     * Returns a cloned `HDate` object with a specified amount of time added
-     *
-     * Units are case insensitive, and support plural and short forms.
-     * Note, short forms are case sensitive.
-     *
-     * | Unit | Shorthand | Description
-     * | --- | --- | --- |
-     * | `day` | `d` | days |
-     * | `week` | `w` | weeks |
-     * | `month` | `M` | months |
-     * | `year` | `y` | years |
-     * @param {number} number
-     * @param {string} [units]
-     * @return {HDate}
-     */
-    add(number: number, units?: string | undefined): HDate;
-    /**
-     * Returns a cloned `HDate` object with a specified amount of time subracted
-     *
-     * Units are case insensitive, and support plural and short forms.
-     * Note, short forms are case sensitive.
-     *
-     * | Unit | Shorthand | Description
-     * | --- | --- | --- |
-     * | `day` | `d` | days |
-     * | `week` | `w` | weeks |
-     * | `month` | `M` | months |
-     * | `year` | `y` | years |
-     * @example
-     * import {HDate, months} from '@hebcal/core';
-     *
-     * const hd1 = new HDate(15, months.CHESHVAN, 5769);
-     * const hd2 = hd1.add(1, 'weeks'); // 7 Kislev 5769
-     * const hd3 = hd1.add(-3, 'M'); // 30 Av 5768
-     * @param {number} number
-     * @param {string} [units]
-     * @return {HDate}
-     */
-    subtract(number: number, units?: string | undefined): HDate;
-    /**
-     * Returns the difference in days between the two given HDates.
-     *
-     * The result is positive if `this` date is comes chronologically
-     * after the `other` date, and negative
-     * if the order of the two dates is reversed.
-     *
-     * The result is zero if the two dates are identical.
-     * @example
-     * import {HDate, months} from '@hebcal/core';
-     *
-     * const hd1 = new HDate(25, months.KISLEV, 5770);
-     * const hd2 = new HDate(15, months.CHESHVAN, 5769);
-     * const days = hd1.deltaDays(hd2); // 394
-     * @param {HDate} other Hebrew date to compare
-     * @return {number}
-     */
-    deltaDays(other: HDate): number;
-    /**
-     * Compares this date to another date, returning `true` if the dates match.
-     * @param {HDate} other Hebrew date to compare
-     * @return {boolean}
-     */
-    isSameDate(other: HDate): boolean;
-    /** @return {string} */
-    toString(): string;
-}
-/**
- * A simple Hebrew date object with numeric fields `yy`, `mm`, and `dd`
- */
-export type SimpleHebrewDate = {
-    /**
-     * Hebrew year
-     */
-    yy: number;
-    /**
-     * Hebrew month of year (1=NISAN, 7=TISHREI)
-     */
-    mm: number;
-    /**
-     * Day of month (1-30)
-     */
-    dd: number;
-};

package/dist/locale-ashkenazi.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/locale-he.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/staticHols.d.ts

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

package/dist/throwTypeError.d.ts

@@ -1,5 +0,0 @@
-/**
- * @private
- * @param {string} msg
- */
-export function throwTypeError(msg: string): void;