@hebcal/core 5.3.12 → 5.4.0

package/dist/locale-ashkenazi.d.ts

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

package/dist/locale-he.d.ts

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

package/dist/locale.d.ts

@@ -0,0 +1,80 @@
+/**
+ * A locale in Hebcal is used for translations/transliterations of
+ * holidays. `@hebcal/core` supports four locales by default
+ * * `en` - default, Sephardic transliterations (e.g. "Shabbat")
+ * * `ashkenazi` - Ashkenazi transliterations (e.g. "Shabbos")
+ * * `he` - Hebrew (e.g. "שַׁבָּת")
+ * * `he-x-NoNikud` - Hebrew without nikud (e.g. "שבת")
+ */
+export class Locale {
+    /**
+     * Returns translation only if `locale` offers a non-empty translation for `id`.
+     * Otherwise, returns `undefined`.
+     * @param {string} id Message ID to translate
+     * @param {string} [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
+     * @return {string | undefined}
+     */
+    static lookupTranslation(id: string, locale?: string | undefined): string | undefined;
+    /**
+     * By default, if no translation was found, returns `id`.
+     * @param {string} id Message ID to translate
+     * @param {string} [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
+     * @return {string}
+     */
+    static gettext(id: string, locale?: string | undefined): string;
+    /**
+     * Register locale translations.
+     * @param {string} locale Locale name (i.e.: `'he'`, `'fr'`)
+     * @param {LocaleData} data parsed data from a `.po` file.
+     */
+    static addLocale(locale: string, data: LocaleData): void;
+    /**
+     * Adds a translation to `locale`, replacing any previous translation.
+     * @param {string} locale Locale name (i.e: `'he'`, `'fr'`).
+     * @param {string} id Message ID to translate
+     * @param {string} translation Translation text
+     */
+    static addTranslation(locale: string, id: string, translation: string): void;
+    /**
+     * Adds multiple translations to `locale`, replacing any previous translations.
+     * @param {string} locale Locale name (i.e: `'he'`, `'fr'`).
+     * @param {LocaleData} data parsed data from a `.po` file.
+     */
+    static addTranslations(locale: string, data: LocaleData): void;
+    /**
+     * Activates a locale. Throws an error if the locale has not been previously added.
+     * After setting the locale to be used, all strings marked for translations
+     * will be represented by the corresponding translation in the specified locale.
+     * @param {string} locale Locale name (i.e: `'he'`, `'fr'`)
+     * @return {LocaleData}
+     */
+    static useLocale(locale: string): LocaleData;
+    /**
+     * Returns the name of the active locale (i.e. 'he', 'ashkenazi', 'fr')
+     * @return {string}
+     */
+    static getLocaleName(): string;
+    /**
+     * Returns the names of registered locales
+     * @return {string[]}
+     */
+    static getLocaleNames(): string[];
+    /**
+     * @param {number} n
+     * @param {string} [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
+     * @return {string}
+     */
+    static ordinal(n: number, locale?: string | undefined): string;
+    /**
+     * @private
+     * @param {number} n
+     * @return {string}
+     */
+    private static getEnOrdinal;
+    /**
+     * Removes nekudot from Hebrew string
+     * @param {string} str
+     * @return {string}
+     */
+    static hebrewStripNikkud(str: string): string;
+}

package/dist/location.d.ts

@@ -0,0 +1,85 @@
+/** Class representing Location */
+export class Location extends GeoLocation {
+    /**
+     * Creates a location object from one of 60 "classic" Hebcal city names.
+     * The following city names are supported:
+     * 'Ashdod', 'Atlanta', 'Austin', 'Baghdad', 'Beer Sheva',
+     * 'Berlin', 'Baltimore', 'Bogota', 'Boston', 'Budapest',
+     * 'Buenos Aires', 'Buffalo', 'Chicago', 'Cincinnati', 'Cleveland',
+     * 'Dallas', 'Denver', 'Detroit', 'Eilat', 'Gibraltar', 'Haifa',
+     * 'Hawaii', 'Helsinki', 'Houston', 'Jerusalem', 'Johannesburg',
+     * 'Kiev', 'La Paz', 'Livingston', 'Las Vegas', 'London', 'Los Angeles',
+     * 'Marseilles', 'Miami', 'Minneapolis', 'Melbourne', 'Mexico City',
+     * 'Montreal', 'Moscow', 'New York', 'Omaha', 'Ottawa', 'Panama City',
+     * 'Paris', 'Pawtucket', 'Petach Tikvah', 'Philadelphia', 'Phoenix',
+     * 'Pittsburgh', 'Providence', 'Portland', 'Saint Louis', 'Saint Petersburg',
+     * 'San Diego', 'San Francisco', 'Sao Paulo', 'Seattle', 'Sydney',
+     * 'Tel Aviv', 'Tiberias', 'Toronto', 'Vancouver', 'White Plains',
+     * 'Washington DC', 'Worcester'
+     * @param {string} name
+     * @return {Location}
+     */
+    static lookup(name: string): Location;
+    /**
+     * Converts legacy Hebcal timezone to a standard Olson tzid.
+     * @param {number} tz integer, GMT offset in hours
+     * @param {string} dst 'none', 'eu', 'usa', or 'israel'
+     * @return {string}
+     */
+    static legacyTzToTzid(tz: number, dst: string): string;
+    /**
+     * Converts timezone info from Zip-Codes.com to a standard Olson tzid.
+     * @example
+     * Location.getUsaTzid('AZ', 7, 'Y') // 'America/Denver'
+     * @param {string} state two-letter all-caps US state abbreviation like 'CA'
+     * @param {number} tz positive number, 5=America/New_York, 8=America/Los_Angeles
+     * @param {string} dst single char 'Y' or 'N'
+     * @return {string}
+     */
+    static getUsaTzid(state: string, tz: number, dst: string): string;
+    /**
+     * Adds a location name for `Location.lookup()` only if the name isn't
+     * already being used. Returns `false` if the name is already taken
+     * and `true` if successfully added.
+     * @param {string} cityName
+     * @param {Location} location
+     * @return {boolean}
+     */
+    static addLocation(cityName: string, location: Location): boolean;
+    /**
+     * Initialize a Location instance
+     * @param {number} latitude - Latitude as a decimal, valid range -90 thru +90 (e.g. 41.85003)
+     * @param {number} longitude - Longitude as a decimal, valid range -180 thru +180 (e.g. -87.65005)
+     * @param {boolean} il - in Israel (true) or Diaspora (false)
+     * @param {string} tzid - Olson timezone ID, e.g. "America/Chicago"
+     * @param {string} cityName - optional descriptive city name
+     * @param {string} countryCode - ISO 3166 alpha-2 country code (e.g. "FR")
+     * @param {string} [geoid] - optional string or numeric geographic ID
+     * @param {number} [elevation] - in meters (default `0`)
+     */
+    constructor(latitude: number, longitude: number, il: boolean, tzid: string, cityName: string, countryCode: string, geoid?: string | undefined, elevation?: number | undefined);
+    il: boolean;
+    cc: string;
+    geoid: string | undefined;
+    /** @return {boolean} */
+    getIsrael(): boolean;
+    /** @return {string} */
+    getName(): string;
+    /**
+     * Returns the location name, up to the first comma
+     * @return {string}
+     */
+    getShortName(): string;
+    /** @return {string} */
+    getCountryCode(): string;
+    /** @return {string} */
+    getTzid(): string;
+    /**
+     * Gets a 24-hour time formatter (e.g. 07:41 or 20:03) for this location
+     * @return {Intl.DateTimeFormat}
+     */
+    getTimeFormatter(): Intl.DateTimeFormat;
+    /** @return {string} */
+    getGeoId(): string;
+}
+import { GeoLocation } from '@hebcal/noaa';

package/dist/modern.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Yom HaShoah first observed in 1951.
+ * When the actual date of Yom Hashoah falls on a Friday, the
+ * state of Israel observes Yom Hashoah on the preceding
+ * Thursday. When it falls on a Sunday, Yom Hashoah is observed
+ * on the following Monday.
+ * http://www.ushmm.org/remembrance/dor/calendar/
+ * @private
+ * @param {number} year
+ * @return {HDate|null}
+ */
+export function dateYomHaShoah(year: number): HDate | null;
+/**
+ * Yom HaAtzma'ut only celebrated after 1948
+ * @private
+ * @param {number} year
+ * @return {HDate|null}
+ */
+export function dateYomHaZikaron(year: number): HDate | null;
+import { HDate } from '@hebcal/hdate';

package/dist/molad.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Represents a molad, the moment when the new moon is "born"
+ */
+export class Molad {
+    /**
+     * Calculates the molad for a Hebrew month
+     * @param {number} year
+     * @param {number} month
+     */
+    constructor(year: number, month: number);
+    year: number;
+    month: number;
+    dow: number;
+    hour: number;
+    minutes: number;
+    chalakim: number;
+    /**
+     * @return {number}
+     */
+    getYear(): number;
+    /**
+     * @return {number}
+     */
+    getMonth(): number;
+    /**
+     * @return {string}
+     */
+    getMonthName(): string;
+    /**
+     * @return {number} Day of Week (0=Sunday, 6=Saturday)
+     */
+    getDow(): number;
+    /**
+     * @return {number} hour of day (0-23)
+     */
+    getHour(): number;
+    /**
+     * @return {number} minutes past hour (0-59)
+     */
+    getMinutes(): number;
+    /**
+     * @return {number} parts of a minute (0-17)
+     */
+    getChalakim(): number;
+    /**
+     * @param {string} [locale] Optional locale name (defaults to active locale)
+     * @param {CalOptions} options
+     * @return {string}
+     */
+    render(locale?: string | undefined, options: CalOptions): string;
+}
+/** Represents a Molad announcement on Shabbat Mevarchim */
+export class MoladEvent extends Event {
+    /**
+     * @param {HDate} date Hebrew date event occurs
+     * @param {number} hyear molad year
+     * @param {number} hmonth molad month
+     * @param {CalOptions} options
+     */
+    constructor(date: HDate, hyear: number, hmonth: number, options: CalOptions);
+    molad: Molad;
+    options: CalOptions;
+}
+import { Event } from './event.js';
+import { HDate } from '@hebcal/hdate';

package/dist/omer.d.ts

@@ -0,0 +1,26 @@
+/** Represents a day 1-49 of counting the Omer from Pesach to Shavuot */
+export class OmerEvent extends Event {
+    /**
+     * @param {HDate} date
+     * @param {number} omerDay
+     */
+    constructor(date: HDate, omerDay: number);
+    weekNumber: number;
+    daysWithinWeeks: number;
+    omer: number;
+    /**
+     * @param {string} lang
+     * @return {string}
+     */
+    sefira(lang?: string): string;
+    /** @return {number} */
+    getWeeks(): number;
+    /** @return {number} */
+    getDaysWithinWeeks(): number;
+    /**
+     * @param {string} locale
+     * @return {string}
+     */
+    getTodayIs(locale: string): string;
+}
+import { Event } from './event.js';

package/dist/pkgVersion.d.ts

@@ -0,0 +1 @@
+export const version: "5.4.0";

package/dist/reformatTimeStr.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @private
+ * @param {string} timeStr - original time like "20:30"
+ * @param {string} suffix - "p" or "pm" or " P.M.". Add leading space if you want it
+ * @param {CalOptions} options
+ * @return {string}
+ */
+export function reformatTimeStr(timeStr: string, suffix: string, options: CalOptions): string;

package/dist/sedra.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @private
+ * @param {number} hyear
+ * @param {boolean} il
+ * @return {Sedra}
+ */
+export function getSedra_(hyear: number, il: boolean): Sedra;
+import { Sedra } from '@hebcal/hdate';

package/dist/staticHolidays.d.ts

@@ -0,0 +1,212 @@
+/**
+ * Transliterated names of holidays, used by `Event.getDesc()`
+ */
+export type holidayDesc = string;
+export namespace holidayDesc {
+    export let ASARA_BTEVET: string;
+    export let BIRKAT_HACHAMAH: string;
+    export let CHAG_HABANOT: string;
+    export let CHANUKAH_8TH_DAY: string;
+    export let EREV_TISHA_BAV: string;
+    export let LEIL_SELICHOT: string;
+    export let PURIM_KATAN: string;
+    export let PURIM_MESHULASH: string;
+    export let SHABBAT_CHAZON: string;
+    export let SHABBAT_HACHODESH: string;
+    export let SHABBAT_HAGADOL: string;
+    export let SHABBAT_NACHAMU: string;
+    export let SHABBAT_PARAH: string;
+    export let SHABBAT_SHEKALIM: string;
+    export let SHABBAT_SHIRAH: string;
+    export let SHABBAT_SHUVA: string;
+    export let SHABBAT_ZACHOR: string;
+    export let SHUSHAN_PURIM_KATAN: string;
+    export let TAANIT_BECHOROT: string;
+    export let TAANIT_ESTHER: string;
+    export let TISHA_BAV: string;
+    export let TZOM_GEDALIAH: string;
+    export let TZOM_TAMMUZ: string;
+    export let YOM_HAATZMA_UT: string;
+    export let YOM_HASHOAH: string;
+    export let YOM_HAZIKARON: string;
+    export { BEN_GURION_DAY };
+    export { CHANUKAH_1_CANDLE };
+    export { EREV_PESACH };
+    export { EREV_PURIM };
+    export { EREV_ROSH_HASHANA };
+    export { EREV_SHAVUOT };
+    export { EREV_SUKKOT };
+    export { EREV_YOM_KIPPUR };
+    export { FAMILY_DAY };
+    export { HEBREW_LANGUAGE_DAY };
+    export { HERZL_DAY };
+    export { JABOTINSKY_DAY };
+    export { LAG_BAOMER };
+    export { PESACH_I };
+    export { PESACH_II };
+    export { PESACH_III_CHM };
+    export { PESACH_II_CHM };
+    export { PESACH_IV_CHM };
+    export { PESACH_SHENI };
+    export { PESACH_VII };
+    export { PESACH_VIII };
+    export { PESACH_VI_CHM };
+    export { PESACH_V_CHM };
+    export { PURIM };
+    export { ROSH_HASHANA_II };
+    export { ROSH_HASHANA_LABEHEMOT };
+    export { SHAVUOT };
+    export { SHAVUOT_I };
+    export { SHAVUOT_II };
+    export { SHMINI_ATZERET };
+    export { SHUSHAN_PURIM };
+    export { SIGD };
+    export { SIMCHAT_TORAH };
+    export { SUKKOT_I };
+    export { SUKKOT_II };
+    export { SUKKOT_III_CHM };
+    export { SUKKOT_II_CHM };
+    export { SUKKOT_IV_CHM };
+    export { SUKKOT_VII_HOSHANA_RABA };
+    export { SUKKOT_VI_CHM };
+    export { SUKKOT_V_CHM };
+    export { TU_BAV };
+    export { TU_BISHVAT };
+    export { YITZHAK_RABIN_MEMORIAL_DAY };
+    export { YOM_HAALIYAH };
+    export { YOM_HAALIYAH_SCHOOL_OBSERVANCE };
+    export { YOM_KIPPUR };
+    export { YOM_YERUSHALAYIM };
+}
+export const staticHolidays: ({
+    mm: number;
+    dd: number;
+    desc: string;
+    flags: number;
+    emoji: string;
+    chmDay?: undefined;
+} | {
+    mm: number;
+    dd: number;
+    desc: string;
+    flags: number;
+    emoji?: undefined;
+    chmDay?: undefined;
+} | {
+    mm: number;
+    dd: number;
+    desc: string;
+    flags: number;
+    chmDay: number;
+    emoji: string;
+})[];
+export const staticModernHolidays: ({
+    firstYear: number;
+    mm: number;
+    dd: number;
+    desc: string;
+    chul: boolean;
+    satPostponeToSun?: undefined;
+    friPostponeToSun?: undefined;
+    friSatMovetoThu?: undefined;
+    suppressEmoji?: undefined;
+} | {
+    firstYear: number;
+    mm: number;
+    dd: number;
+    desc: string;
+    satPostponeToSun: boolean;
+    friPostponeToSun: boolean;
+    chul?: undefined;
+    friSatMovetoThu?: undefined;
+    suppressEmoji?: undefined;
+} | {
+    firstYear: number;
+    mm: number;
+    dd: number;
+    desc: string;
+    chul?: undefined;
+    satPostponeToSun?: undefined;
+    friPostponeToSun?: undefined;
+    friSatMovetoThu?: undefined;
+    suppressEmoji?: undefined;
+} | {
+    firstYear: number;
+    mm: number;
+    dd: number;
+    desc: string;
+    friSatMovetoThu: boolean;
+    chul?: undefined;
+    satPostponeToSun?: undefined;
+    friPostponeToSun?: undefined;
+    suppressEmoji?: undefined;
+} | {
+    firstYear: number;
+    mm: number;
+    dd: number;
+    desc: string;
+    satPostponeToSun: boolean;
+    chul?: undefined;
+    friPostponeToSun?: undefined;
+    friSatMovetoThu?: undefined;
+    suppressEmoji?: undefined;
+} | {
+    firstYear: number;
+    mm: number;
+    dd: number;
+    desc: string;
+    chul: boolean;
+    suppressEmoji: boolean;
+    satPostponeToSun?: undefined;
+    friPostponeToSun?: undefined;
+    friSatMovetoThu?: undefined;
+})[];
+declare const BEN_GURION_DAY: "Ben-Gurion Day";
+declare const CHANUKAH_1_CANDLE: "Chanukah: 1 Candle";
+declare const EREV_PESACH: "Erev Pesach";
+declare const EREV_PURIM: "Erev Purim";
+declare const EREV_ROSH_HASHANA: "Erev Rosh Hashana";
+declare const EREV_SHAVUOT: "Erev Shavuot";
+declare const EREV_SUKKOT: "Erev Sukkot";
+declare const EREV_YOM_KIPPUR: "Erev Yom Kippur";
+declare const FAMILY_DAY: "Family Day";
+declare const HEBREW_LANGUAGE_DAY: "Hebrew Language Day";
+declare const HERZL_DAY: "Herzl Day";
+declare const JABOTINSKY_DAY: "Jabotinsky Day";
+declare const LAG_BAOMER: "Lag BaOmer";
+declare const PESACH_I: "Pesach I";
+declare const PESACH_II: "Pesach II";
+declare const PESACH_III_CHM: "Pesach III (CH''M)";
+declare const PESACH_II_CHM: "Pesach II (CH''M)";
+declare const PESACH_IV_CHM: "Pesach IV (CH''M)";
+declare const PESACH_SHENI: "Pesach Sheni";
+declare const PESACH_VII: "Pesach VII";
+declare const PESACH_VIII: "Pesach VIII";
+declare const PESACH_VI_CHM: "Pesach VI (CH''M)";
+declare const PESACH_V_CHM: "Pesach V (CH''M)";
+declare const PURIM: "Purim";
+declare const ROSH_HASHANA_II: "Rosh Hashana II";
+declare const ROSH_HASHANA_LABEHEMOT: "Rosh Hashana LaBehemot";
+declare const SHAVUOT: "Shavuot";
+declare const SHAVUOT_I: "Shavuot I";
+declare const SHAVUOT_II: "Shavuot II";
+declare const SHMINI_ATZERET: "Shmini Atzeret";
+declare const SHUSHAN_PURIM: "Shushan Purim";
+declare const SIGD: "Sigd";
+declare const SIMCHAT_TORAH: "Simchat Torah";
+declare const SUKKOT_I: "Sukkot I";
+declare const SUKKOT_II: "Sukkot II";
+declare const SUKKOT_III_CHM: "Sukkot III (CH''M)";
+declare const SUKKOT_II_CHM: "Sukkot II (CH''M)";
+declare const SUKKOT_IV_CHM: "Sukkot IV (CH''M)";
+declare const SUKKOT_VII_HOSHANA_RABA: "Sukkot VII (Hoshana Raba)";
+declare const SUKKOT_VI_CHM: "Sukkot VI (CH''M)";
+declare const SUKKOT_V_CHM: "Sukkot V (CH''M)";
+declare const TU_BAV: "Tu B'Av";
+declare const TU_BISHVAT: "Tu BiShvat";
+declare const YITZHAK_RABIN_MEMORIAL_DAY: "Yitzhak Rabin Memorial Day";
+declare const YOM_HAALIYAH: "Yom HaAliyah";
+declare const YOM_HAALIYAH_SCHOOL_OBSERVANCE: "Yom HaAliyah School Observance";
+declare const YOM_KIPPUR: "Yom Kippur";
+declare const YOM_YERUSHALAYIM: "Yom Yerushalayim";
+export {};