@hebcal/core 5.3.12 → 5.3.13

package/dist/candles.d.ts

@@ -0,0 +1,74 @@
+/**
+ * @private
+ * @param {Event} e
+ * @param {HDate} hd
+ * @param {CalOptions} options
+ * @param {boolean} isFriday
+ * @param {boolean} isSaturday
+ * @return {Event}
+ */
+export function makeCandleEvent(e: Event, hd: HDate, options: CalOptions, isFriday: boolean, isSaturday: boolean): Event;
+/**
+ * Makes a pair of events representing fast start and end times
+ * @private
+ * @param {Event} ev
+ * @param {CalOptions} options
+ * @return {Event}
+ */
+export function makeFastStartEnd(ev: Event, options: CalOptions): Event;
+/**
+ * Makes a candle-lighting event for Chankah (not on Friday/Saturday).
+ * At one point this used civil dusk (6 degrees below horizon).
+ * Another source suggests 4.6667 degrees below horizon.
+ * @private
+ * @param {Event} ev
+ * @param {HDate} hd
+ * @param {CalOptions} options
+ * @return {TimedEvent}
+ */
+export function makeWeekdayChanukahCandleLighting(ev: Event, hd: HDate, options: CalOptions): TimedEvent;
+/** An event that has an `eventTime` and `eventTimeStr` */
+export class TimedEvent extends Event {
+    /**
+     * @param {HDate} date
+     * @param {string} desc Description (not translated)
+     * @param {number} mask
+     * @param {Date} eventTime
+     * @param {Location} location
+     * @param {Event} linkedEvent
+     * @param {CalOptions} options
+     */
+    constructor(date: HDate, desc: string, mask: number, eventTime: Date, location: Location, linkedEvent: Event, options: CalOptions);
+    eventTime: Date;
+    location: Location;
+    eventTimeStr: string;
+    fmtTime: string;
+    linkedEvent: Event | undefined;
+}
+/** Havdalah after Shabbat or holiday */
+export class HavdalahEvent extends TimedEvent {
+    /**
+     * @param {HDate} date
+     * @param {number} mask
+     * @param {Date} eventTime
+     * @param {Location} location
+     * @param {number} havdalahMins
+     * @param {Event} linkedEvent
+     * @param {CalOptions} options
+     */
+    constructor(date: HDate, mask: number, eventTime: Date, location: Location, havdalahMins: number, linkedEvent: Event, options: CalOptions);
+    havdalahMins: number | undefined;
+}
+/** Candle lighting before Shabbat or holiday */
+export class CandleLightingEvent extends TimedEvent {
+    /**
+     * @param {HDate} date
+     * @param {number} mask
+     * @param {Date} eventTime
+     * @param {Location} location
+     * @param {Event} linkedEvent
+     * @param {CalOptions} options
+     */
+    constructor(date: HDate, mask: number, eventTime: Date, location: Location, linkedEvent: Event, options: CalOptions);
+}
+import { Event } from './event.js';

package/dist/dateFormat.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @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/event.d.ts

@@ -0,0 +1,144 @@
+/**
+ * Holiday flags for Event
+ */
+export type flags = number;
+export namespace flags {
+    let CHAG: number;
+    let LIGHT_CANDLES: number;
+    let YOM_TOV_ENDS: number;
+    let CHUL_ONLY: number;
+    let IL_ONLY: number;
+    let LIGHT_CANDLES_TZEIS: number;
+    let CHANUKAH_CANDLES: number;
+    let ROSH_CHODESH: number;
+    let MINOR_FAST: number;
+    let SPECIAL_SHABBAT: number;
+    let PARSHA_HASHAVUA: number;
+    let DAF_YOMI: number;
+    let OMER_COUNT: number;
+    let MODERN_HOLIDAY: number;
+    let MAJOR_FAST: number;
+    let SHABBAT_MEVARCHIM: number;
+    let MOLAD: number;
+    let USER_EVENT: number;
+    let HEBREW_DATE: number;
+    let MINOR_HOLIDAY: number;
+    let EREV: number;
+    let CHOL_HAMOED: number;
+    let MISHNA_YOMI: number;
+    let YOM_KIPPUR_KATAN: number;
+    let YERUSHALMI_YOMI: number;
+    let NACH_YOMI: number;
+    let DAILY_LEARNING: number;
+}
+/** Represents an Event with a title, date, and flags */
+export class Event {
+    /**
+     * Constructs Event
+     * @param {HDate} date Hebrew date event occurs
+     * @param {string} desc Description (not translated)
+     * @param {number} [mask=0] optional bitmask of holiday flags (see {@link flags})
+     * @param {Object} [attrs={}] optional additional attributes (e.g. `eventTimeStr`, `cholHaMoedDay`)
+     */
+    constructor(date: HDate, desc: string, mask?: number | undefined, attrs?: Object | undefined);
+    date: HDate;
+    desc: string;
+    mask: number;
+    /**
+     * Hebrew date of this event
+     * @return {HDate}
+     */
+    getDate(): HDate;
+    /**
+     * Untranslated description of this event
+     * @return {string}
+     */
+    getDesc(): string;
+    /**
+     * Bitmask of optional event flags. See {@link flags}
+     * @return {number}
+     */
+    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 {string} [locale] Optional locale name (defaults to active locale).
+     * @return {string}
+     */
+    render(locale?: string | undefined): 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 {string} [locale] Optional locale name (defaults to active locale).
+     * @return {string}
+     */
+    renderBrief(locale?: string | undefined): string;
+    /**
+     * Optional holiday-specific Emoji or `null`.
+     * @return {string}
+     */
+    getEmoji(): string;
+    /**
+     * Returns a simplified (untranslated) description for this event. For example,
+     * the {@link HolidayEvent} class supports
+     * "Erev Pesach" => "Pesach", and "Sukkot III (CH''M)" => "Sukkot".
+     * For many holidays the basename and the event description are the same.
+     * @return {string}
+     */
+    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.
+     * @return {string}
+     */
+    url(): string;
+    /**
+     * 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
+     * @return {boolean}
+     */
+    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
+     * @return {boolean}
+     */
+    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 {boolean} il
+     * @return {boolean}
+     */
+    observedIn(il: boolean): boolean;
+    /**
+     * Makes a clone of this Event object
+     * @return {Event}
+     */
+    clone(): Event;
+    /**
+     * Returns a list of event categories
+     * @return {string[]}
+     */
+    getCategories(): string[];
+}
+import { HDate } from './hdate.js';

package/dist/hallel.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @private
+ * @param {Event[]} events
+ * @param {HDate} hdate
+ * @return {number}
+ */
+export function hallel_(events: Event[], hdate: HDate): number;

package/dist/hdate.d.ts

@@ -0,0 +1,395 @@
+/**
+ * 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;
+};