@hebcal/core 5.4.0 → 5.4.1

package/dist/location.d.ts

@@ -52,14 +52,14 @@ export class Location extends GeoLocation {
      * @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} [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);
+    constructor(latitude: number, longitude: number, il: boolean, tzid: string, cityName?: string | undefined, countryCode?: string | undefined, geoid?: string | undefined, elevation?: number | undefined);
     il: boolean;
-    cc: string;
+    cc: string | undefined;
     geoid: string | undefined;
     /** @return {boolean} */
     getIsrael(): boolean;

package/dist/modern.d.ts

@@ -1,3 +1,4 @@
+import { HDate } from '@hebcal/hdate';
 /**
  * Yom HaShoah first observed in 1951.
  * When the actual date of Yom Hashoah falls on a Friday, the
@@ -9,12 +10,11 @@
  * @param {number} year
  * @return {HDate|null}
  */
-export function dateYomHaShoah(year: number): HDate | null;
+export declare 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';
+export declare function dateYomHaZikaron(year: number): HDate | null;

package/dist/molad.d.ts

@@ -1,19 +1,17 @@
+import { Event } from './event';
+import { CalOptions } from './CalOptions';
+import { HDate } from '@hebcal/hdate';
 /**
  * Represents a molad, the moment when the new moon is "born"
  */
-export class Molad {
+export declare class Molad {
+    private readonly m;
     /**
      * 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}
      */
@@ -47,10 +45,12 @@ export class Molad {
      * @param {CalOptions} options
      * @return {string}
      */
-    render(locale?: string | undefined, options: CalOptions): string;
+    render(locale?: string, options?: CalOptions): string;
 }
 /** Represents a Molad announcement on Shabbat Mevarchim */
-export class MoladEvent extends Event {
+export declare class MoladEvent extends Event {
+    readonly molad: Molad;
+    private readonly options;
     /**
      * @param {HDate} date Hebrew date event occurs
      * @param {number} hyear molad year
@@ -58,8 +58,9 @@ export class MoladEvent extends Event {
      * @param {CalOptions} options
      */
     constructor(date: HDate, hyear: number, hmonth: number, options: CalOptions);
-    molad: Molad;
-    options: CalOptions;
+    /**
+     * @param {string} [locale] Optional locale name (defaults to active locale).
+     * @return {string}
+     */
+    render(locale?: string): string;
 }
-import { Event } from './event.js';
-import { HDate } from '@hebcal/hdate';

package/dist/omer.d.ts

@@ -1,18 +1,35 @@
+import { HDate } from '@hebcal/hdate';
+import { Event } from './event';
 /** Represents a day 1-49 of counting the Omer from Pesach to Shavuot */
-export class OmerEvent extends Event {
+export declare class OmerEvent extends Event {
+    private readonly weekNumber;
+    private readonly daysWithinWeeks;
+    readonly omer: number;
+    emoji?: string;
     /**
      * @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;
+    /**
+     * @todo use gettext()
+     * @param {string} [locale] Optional locale name (defaults to active locale).
+     * @return {string}
+     */
+    render(locale?: string): string;
+    /**
+     * Returns translation of "Omer day 22" without ordinal numbers.
+     * @param {string} [locale] Optional locale name (defaults to active locale).
+     * @return {string}
+     */
+    renderBrief(locale?: string): string;
+    /** @return {string} */
+    getEmoji(): string;
     /** @return {number} */
     getWeeks(): number;
     /** @return {number} */
@@ -22,5 +39,6 @@ export class OmerEvent extends Event {
      * @return {string}
      */
     getTodayIs(locale: string): string;
+    /** @return {string} */
+    url(): string;
 }
-import { Event } from './event.js';

package/dist/pkgVersion.d.ts

@@ -1 +1 @@
-export const version: "5.4.0";
+export const version: "5.4.1";

package/dist/reformatTimeStr.d.ts

@@ -1,3 +1,4 @@
+import { CalOptions } from './CalOptions';
 /**
  * @private
  * @param {string} timeStr - original time like "20:30"
@@ -5,4 +6,4 @@
  * @param {CalOptions} options
  * @return {string}
  */
-export function reformatTimeStr(timeStr: string, suffix: string, options: CalOptions): string;
+export declare function reformatTimeStr(timeStr: string, suffix: string, options?: CalOptions): string;

package/dist/sedra.d.ts

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

package/dist/staticHolidays.d.ts

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

package/dist/tachanun.d.ts

@@ -1,8 +1,10 @@
-/**
- * @private
- * @param {HDate} hdate
- * @param {boolean} il
- * @return {TachanunResult}
- */
-export function tachanun_(hdate: HDate, il: boolean): TachanunResult;
 import { HDate } from '@hebcal/hdate';
+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;
+};
+export declare function tachanun_(hdate: HDate, il: boolean): TachanunResult;