@hebcal/core 5.4.8 → 5.4.10

package/dist/location.d.ts

@@ -6,35 +6,28 @@ export declare class Location extends GeoLocation {
     private readonly geoid?;
     /**
      * 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|number} [geoid] - optional string or numeric geographic ID
-     * @param {number} [elevation] - in meters (default `0`)
+     * @param latitude - Latitude as a decimal, valid range -90 thru +90 (e.g. 41.85003)
+     * @param longitude - Longitude as a decimal, valid range -180 thru +180 (e.g. -87.65005)
+     * @param il - in Israel (true) or Diaspora (false)
+     * @param tzid - Olson timezone ID, e.g. "America/Chicago"
+     * @param [cityName] - optional descriptive city name
+     * @param [countryCode] - ISO 3166 alpha-2 country code (e.g. "FR")
+     * @param [geoid] - optional string or numeric geographic ID
+     * @param [elevation] - in meters (default `0`)
      */
     constructor(latitude: number, longitude: number, il: boolean, tzid: string, cityName?: string, countryCode?: string, geoid?: string | number, elevation?: number);
-    /** @return {boolean} */
     getIsrael(): boolean;
-    /** @return {string | null} */
     getName(): string | null;
     /**
      * Returns the location name, up to the first comma
-     * @return {string | null}
      */
     getShortName(): string | null;
-    /** @return {string | undefined} */
     getCountryCode(): string | undefined;
-    /** @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 | number | undefined} */
     getGeoId(): string | number | undefined;
     /**
      * Creates a location object from one of 60 "classic" Hebcal city names.
@@ -52,36 +45,29 @@ export declare class Location extends GeoLocation {
      * 'San Diego', 'San Francisco', 'Sao Paulo', 'Seattle', 'Sydney',
      * 'Tel Aviv', 'Tiberias', 'Toronto', 'Vancouver', 'White Plains',
      * 'Washington DC', 'Worcester'
-     * @param {string} name
-     * @return {Location|undefined}
+     * @param name
      */
     static lookup(name: string): Location | undefined;
-    /** @return {string} */
     toString(): string;
     /**
      * 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 | undefined}
+     * @param tz integer, GMT offset in hours
+     * @param dst 'none', 'eu', 'usa', or 'israel'
      */
     static legacyTzToTzid(tz: number, dst: string): string | undefined;
     /**
      * 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}
+     * @param state two-letter all-caps US state abbreviation like 'CA'
+     * @param tz positive number, 5=America/New_York, 8=America/Los_Angeles
+     * @param dst single char 'Y' or 'N'
      */
     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;
 }

package/dist/modern.d.ts

@@ -7,14 +7,12 @@ import { HDate } from '@hebcal/hdate';
  * on the following Monday.
  * http://www.ushmm.org/remembrance/dor/calendar/
  * @private
- * @param {number} year
- * @return {HDate|null}
+ * @param year
  */
 export declare function dateYomHaShoah(year: number): HDate | null;
 /**
  * Yom HaAtzma'ut only celebrated after 1948
  * @private
- * @param {number} year
- * @return {HDate|null}
+ * @param year
  */
 export declare function dateYomHaZikaron(year: number): HDate | null;

package/dist/molad.d.ts

@@ -9,42 +9,38 @@ export declare class Molad {
     private readonly m;
     /**
      * Calculates the molad for a Hebrew month
-     * @param {number} year
-     * @param {number} month
+     * @param year
+     * @param month
      */
     constructor(year: number, month: number);
     /**
-     * @return {number}
      */
     getYear(): number;
     /**
-     * @return {number}
      */
     getMonth(): number;
     /**
-     * @return {string}
      */
     getMonthName(): string;
     /**
-     * @return {number} Day of Week (0=Sunday, 6=Saturday)
+     * @returns Day of Week (0=Sunday, 6=Saturday)
      */
     getDow(): number;
     /**
-     * @return {number} hour of day (0-23)
+     * @returns hour of day (0-23)
      */
     getHour(): number;
     /**
-     * @return {number} minutes past hour (0-59)
+     * @returns minutes past hour (0-59)
      */
     getMinutes(): number;
     /**
-     * @return {number} parts of a minute (0-17)
+     * @returns parts of a minute (0-17)
      */
     getChalakim(): number;
     /**
-     * @param {string} [locale] Optional locale name (defaults to active locale)
-     * @param {CalOptions} options
-     * @return {string}
+     * @param [locale] Optional locale name (defaults to active locale)
+     * @param options
      */
     render(locale?: string, options?: CalOptions): string;
 }
@@ -53,15 +49,14 @@ export declare class MoladEvent extends Event {
     readonly molad: Molad;
     private readonly options;
     /**
-     * @param {HDate} date Hebrew date event occurs
-     * @param {number} hyear molad year
-     * @param {number} hmonth molad month
-     * @param {CalOptions} options
+     * @param date Hebrew date event occurs
+     * @param hyear molad year
+     * @param hmonth molad month
+     * @param options
      */
     constructor(date: HDate, hyear: number, hmonth: number, options: CalOptions);
     /**
-     * @param {string} [locale] Optional locale name (defaults to active locale).
-     * @return {string}
+     * @param [locale] Optional locale name (defaults to active locale).
      */
     render(locale?: string): string;
 }

package/dist/omer.d.ts

@@ -8,38 +8,30 @@ export declare class OmerEvent extends Event {
     readonly omer: number;
     emoji?: string;
     /**
-     * @param {HDate} date
-     * @param {number} omerDay
+     * @param date
+     * @param omerDay
      */
     constructor(date: HDate, omerDay: number);
     /**
-     * @param {string} lang
-     * @return {string}
+     * @param lang
      */
     sefira(lang?: string): string;
     /**
      * @todo use gettext()
-     * @param {string} [locale] Optional locale name (defaults to active locale).
-     * @return {string}
+     * @param [locale] Optional locale name (defaults to active locale).
      */
     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}
+     * @param [locale] Optional locale name (defaults to active locale).
      */
     renderBrief(locale?: string): string;
-    /** @return {string} */
     getEmoji(): string;
-    /** @return {number} */
     getWeeks(): number;
-    /** @return {number} */
     getDaysWithinWeeks(): number;
     /**
-     * @param {string} locale
-     * @return {string}
+     * @param locale
      */
     getTodayIs(locale: string): string;
-    /** @return {string} */
     url(): string;
 }

package/dist/pkgVersion.d.ts

@@ -1,2 +1,2 @@
 /** DO NOT EDIT THIS AUTO-GENERATED FILE! */
-export declare const version = "5.4.8";
+export declare const version = "5.4.10";

package/dist/reformatTimeStr.d.ts

@@ -1,9 +1,8 @@
 import { CalOptions } from './CalOptions';
 /**
  * @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}
+ * @param timeStr - original time like "20:30"
+ * @param suffix - "p" or "pm" or " P.M.". Add leading space if you want it
+ * @param options
  */
 export declare function reformatTimeStr(timeStr: string, suffix: string, options?: CalOptions): string;

package/dist/sedra.d.ts

@@ -31,54 +31,45 @@ export declare class Sedra {
     private readonly theSedraArray;
     /**
      * Caculates the Parashah HaShavua for an entire Hebrew year
-     * @param {number} hyear - Hebrew year (e.g. 5749)
-     * @param {boolean} il - Use Israel sedra schedule (false for Diaspora)
+     * @param hyear - Hebrew year (e.g. 5749)
+     * @param il - Use Israel sedra schedule (false for Diaspora)
      */
     constructor(hyear: number, il: boolean);
     /**
      * Returns the parsha (or parshiyot) read on Hebrew date
-     * @param {HDate|number} hd Hebrew date or R.D. days
-     * @return {string[]}
+     * @param hd Hebrew date or R.D. days
      */
     get(hd: HDate | number): string[];
     /**
      * Looks up parsha for the date, then returns a translated or transliterated string
-     * @param {HDate|number} hd Hebrew date or R.D. days
-     * @param {string} [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale
-     * @return {string}
+     * @param hd Hebrew date or R.D. days
+     * @param [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale
      */
     getString(hd: HDate | number, locale?: string): string;
     /**
      * Checks to see if this day would be a regular parasha HaShavua
      * Torah reading or special holiday reading
-     * @param {HDate|number} hd Hebrew date or R.D. days
-     * @return {boolean}
+     * @param hd Hebrew date or R.D. days
      */
     isParsha(hd: HDate | number): boolean;
     /**
      * Returns the date that a parsha occurs
      * or `null` if the parsha doesn't occur this year
-     * @param {number|string|string[]} parsha
-     * @return {HDate|null}
      */
     find(parsha: number | string | string[]): HDate | null;
     /**
      * Returns the underlying annual sedra schedule.
      * Used by `@hebcal/triennial`
-     * @return {NumberOrString[]}
      */
     getSedraArray(): NumberOrString[];
     /**
      * R.D. date of the first Saturday on or after Rosh Hashana
-     * @return {number}
      */
     getFirstSaturday(): number;
-    /** @return {number} */
     getYear(): number;
     /**
      * Returns an object describing the parsha on the first Saturday on or after `hd`
-     * @param {HDate|number} hd Hebrew date or R.D. days
-     * @return {SedraResult}
+     * @param hd Hebrew date or R.D. days
      */
     lookup(hd: HDate | number): SedraResult;
 }
@@ -94,9 +85,8 @@ type NumberOrString = number | string;
  * Convenience function to create an instance of `Sedra` or reuse a previously
  * created and cached instance.
  * @private
- * @param {number} hyear
- * @param {boolean} il
- * @return {Sedra}
+ * @param hyear
+ * @param il
  */
 export declare function getSedra_(hyear: number, il: boolean): Sedra;
 export {};

package/dist/staticHolidays.d.ts

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