@hebcal/core 6.1.0 → 6.3.0

package/dist/src/zmanim.js

@@ -20,6 +20,19 @@ function getDate(date) {
         return date.greg();
     throw new TypeError(`invalid date: ${date}`);
 }
+/**
+ * The zenith of astronomical sunrise and sunset. The sun is 90° from the vertical 0°
+ */
+const GEOMETRIC_ZENITH = 90;
+/**
+ * The zenith of 1.583° below {@link GEOMETRIC_ZENITH geometric zenith} (90°). This calculation is used for
+ * calculating _netz amiti_ (sunrise) and _shkiah amiti_ (sunset) based on the opinion of the
+ * <a href="https://en.wikipedia.org/wiki/Shneur_Zalman_of_Liadi">Baal Hatanya</a>.
+ *
+ * @see Zmanim.sunriseBaalHatanya()
+ * @see Zmanim.sunsetBaalHatanya()
+ */
+const ZENITH_1_POINT_583 = GEOMETRIC_ZENITH + 1.583;
 /**
  * Calculate halachic times (zmanim / זְמַנִּים) for a given day and location.
  * Calculations are available for tzeit / tzais (nightfall),
@@ -95,7 +108,7 @@ export class Zmanim {
      * @param rising
      */
     timeAtAngle(angle, rising) {
-        const offsetZenith = 90 + angle;
+        const offsetZenith = GEOMETRIC_ZENITH + angle;
         const zdt = rising
             ? this.noaa.getSunriseOffsetByDegrees(offsetZenith)
             : this.noaa.getSunsetOffsetByDegrees(offsetZenith);
@@ -227,6 +240,12 @@ export class Zmanim {
     misheyakirMachmir() {
         return this.timeAtAngle(10.2, true);
     }
+    getShaahZmanisBasedZmanZdt(startOfDay, endOfDay, hours) {
+        const temporalHour = this.noaa.getTemporalHour(startOfDay, endOfDay);
+        const offset = Math.trunc(temporalHour * hours);
+        const zdt = NOAACalculator.getTimeOffset(startOfDay, offset);
+        return zdt;
+    }
     /**
      * Utility method for using elevation-aware sunrise/sunset
      * @private
@@ -239,9 +258,7 @@ export class Zmanim {
         const endOfDay = this.useElevation
             ? this.noaa.getSunset()
             : this.noaa.getSeaLevelSunset();
-        const temporalHour = this.noaa.getTemporalHour(startOfDay, endOfDay);
-        const offset = Math.round(temporalHour * hours);
-        const zdt = NOAACalculator.getTimeOffset(startOfDay, offset);
+        const zdt = this.getShaahZmanisBasedZmanZdt(startOfDay, endOfDay, hours);
         return zdtToDate(zdt);
     }
     /**
@@ -266,6 +283,20 @@ export class Zmanim {
         // Gra
         return this.getShaahZmanisBasedZman(4);
     }
+    /**
+     * This method returns the latest time for burning _chametz_ on _Erev Pesach_ according to the opinion
+     * of the <a href="https://en.wikipedia.org/wiki/Vilna_Gaon">GRA</a>. This time is 5 hours into the day based on the
+     * opinion of the <a href="https://en.wikipedia.org/wiki/Vilna_Gaon">GRA</a> that the day is calculated from
+     * sunrise to sunset. This returns the time 5 * {@link #getShaahZmanisGra()} after {@link #getSeaLevelSunrise() sea
+     * level sunrise}.
+     * @return the <code>Date</code> of the latest time for burning _chametz_ on _Erev Pesach_. If it is not
+     *         _erev Pesach_ or the calculation can't be computed such as in the Arctic Circle where there is at least
+     *         one day a year where the sun does not rise, and one where it does not set, a <code>null</code> will be
+     *         returned.
+     */
+    sofZmanBiurChametzGRA() {
+        return this.getShaahZmanisBasedZman(5);
+    }
     /**
      * Returns an array with alot (Date) and ms in hour (number)
      * @private
@@ -498,7 +529,7 @@ export class Zmanim {
      *            is it the start of _Kiddush Levana_ time or the end? If it is start roll it to the next _tzais_,
      *            and if it is the end, return the end of the previous night (_alos_ passed in). Ignored if either
      *            _alos_ or _tzais_ are null.
-     * @return the _molad_ based time. If the _zman_ does not occur during the current date, <code>null</code> will be
+     * @return the _molad_ based time. If the _zman_ does not occur during the current date, `null` will be
      *         returned.
      */
     getMoladBasedTime(moladBasedTime, alos, tzais, techila) {
@@ -530,7 +561,7 @@ export class Zmanim {
      * halfway between _molad_ and _molad_. This adds half the 29 days, 12 hours and 793 chalakim time between
      * _molad_ and _molad_ (14 days, 18 hours, 22 minutes and 666 milliseconds) to the month's _molad_.
      * The _sof zman Kiddush Levana_ will be returned even if it occurs during the day. To limit the time to between
-     * _tzais_ and _alos_, see {@link #getSofZmanKidushLevanaBetweenMoldos(Date, Date)}.
+     * _tzais_ and _alos_, see {@link getSofZmanKidushLevanaBetweenMoldos}.
      *
      * @param alos
      *            the beginning of the Jewish day. If _Kidush Levana_ occurs during the day (starting at _alos_ and
@@ -542,7 +573,7 @@ export class Zmanim {
      *            adjustment will be made.
      * @return the Date representing the moment halfway between molad and molad. If the time occurs between
      *         _alos_ and _tzais_, _alos_ will be returned. If the _zman_ will not occur on this
-     *         day, a <code>null</code> will be returned.
+     *         day, a `null` will be returned.
      */
     getSofZmanKidushLevanaBetweenMoldos(alos = null, tzais = null) {
         const hd = this.getHDate();
@@ -561,15 +592,15 @@ export class Zmanim {
      * the Shulchan Aruch (Orach Chaim 426). It should be noted that some opinions hold that the
      * <a href="https://en.wikipedia.org/wiki/Moses_Isserles">Rema</a> who brings down the opinion of the <a
      * href="https://en.wikipedia.org/wiki/Yaakov_ben_Moshe_Levi_Moelin">Maharil's</a> of calculating
-     * {@link #getSofZmanKidushLevanaBetweenMoldos(Date, Date) half way between _molad_ and _molad_} is of
+     * {@link getSofZmanKidushLevanaBetweenMoldos half way between _molad_ and _molad_} is of
      * the opinion that the Mechaber agrees to his opinion. Also see the Aruch Hashulchan. For additional details on the subject,
      * See Rabbi Dovid Heber's very detailed write-up in Siman Daled (chapter 4) of <a href="https://hebrewbooks.org/53000">Shaarei
      * Zmanim</a>. The _sof zman Kiddush Levana_ will be returned even if it occurs during the day. To limit the time to
-     * between _tzais_ and _alos_, see {@link #getSofZmanKidushLevana15Days(Date, Date)}.
+     * between _tzais_ and _alos_, see {@link getSofZmanKidushLevana15Days}.
      *
      * @return the Date representing the moment 15 days after the _molad_. If the time occurs between
      *         _alos_ and _tzais_, _alos_ will be returned. If the _zman_ will not occur on this day, a
-     *         <code>null</code> will be returned.
+     *         `null` will be returned.
      *
      *
      */
@@ -603,7 +634,7 @@ export class Zmanim {
      *
      * @return the Date representing the moment 3 days after the molad. If the time occurs between _alos_ and
      *         _tzais_, _tzais_ will be returned. If the _zman_ will not occur on this day, a
-     *         <code>null</code> will be returned.
+     *         `null` will be returned.
      */
     getTchilasZmanKidushLevana3Days(alos = null, tzais = null) {
         const hd = this.getHDate();
@@ -632,7 +663,7 @@ export class Zmanim {
      * {@link HebrewDateFormatter} that will have formatting for this.
      *
      * @return the Date representing the moment of the molad. If the _molad_ does not occur on this day, a
-     *         <code>null</code> will be returned.
+     *         `null` will be returned.
      *
      */
     getZmanMolad() {
@@ -656,10 +687,10 @@ export class Zmanim {
     /**
      * Returns the earliest time of _Kiddush Levana_ according to the opinions that it should not be said until 7
      * days after the _molad_. The time will be returned even if it occurs during the day when _Kiddush Levana_
-     * can't be recited. Use {@link #getTchilasZmanKidushLevana7Days(Date, Date)} if you want to limit the time to night hours.
+     * can't be recited. Use {@link getTchilasZmanKidushLevana7Days} if you want to limit the time to night hours.
      *
      * @return the Date representing the moment 7 days after the molad regardless of it is day or night. If the _zman_
-     *         will not occur on this day, a <code>null</code> will be returned.
+     *         will not occur on this day, a `null` will be returned.
      */
     getTchilasZmanKidushLevana7Days(alos = null, tzais = null) {
         const hd = this.getHDate();
@@ -674,6 +705,174 @@ export class Zmanim {
         const molad = new Molad(hd.getFullYear(), hd.getMonth());
         return this.getMoladBasedTime(molad.getTchilasZmanKidushLevana7Days(), alos, tzais, true);
     }
+    /**
+     * A method that returns the <a href="https://en.wikipedia.org/wiki/Shneur_Zalman_of_Liadi">Baal Hatanya</a>'s
+     * _netz amiti_ (sunrise) without
+     * elevation adjustment. This forms the base for the Baal Hatanya's dawn-based calculations that are
+     * calculated as a dip below the horizon before sunrise.
+     *
+     * According to the Baal Hatanya, _netz amiti_, or true (halachic) sunrise, is when the top of the sun's
+     * disk is visible at an elevation similar to the mountains of Eretz Yisrael. The time is calculated as the point at which
+     * the center of the sun's disk is 1.583&deg; below the horizon. This degree-based calculation can be found in Rabbi Shalom
+     * DovBer Levine's commentary on The <a href="https://www.chabadlibrary.org/books/pdf/Seder-Hachnosas-Shabbos.pdf">Baal
+     * Hatanya's Seder Hachnasas Shabbos</a>. From an elevation of 546 meters, the top of <a href=
+     * "https://en.wikipedia.org/wiki/Mount_Carmel">Har Hacarmel</a>, the sun disappears when it is 1&deg; 35' or 1.583&deg;
+     * below the sea level horizon. This in turn is based on the Gemara <a href=
+     * "https://hebrewbooks.org/shas.aspx?mesechta=2&daf=35">Shabbos 35a</a>. There are other opinions brought down by
+     * Rabbi Levine, including Rabbi Yosef Yitzchok Feigelstock who calculates it as the degrees below the horizon 4 minutes after
+     * sunset in Yerushalayim (on the equinox). That is brought down as 1.583&deg;. This is identical to the 1&deg; 35' _zman_
+     * and is probably a typo and should be 1.683&deg;. These calculations are used by most <a href=
+     * "https://en.wikipedia.org/wiki/Chabad">Chabad</a> calendars that use the Baal Hatanya's _zmanim_. See
+     * <a href="https://www.chabad.org/library/article_cdo/aid/3209349/jewish/About-Our-Zmanim-Calculations.htm">About Our
+     * _Zmanim_ Calculations @ Chabad.org</a>.
+     *
+     * Note: _netz amiti_ is used only for calculating certain _zmanim_, and is intentionally unpublished. For
+     * practical purposes, daytime _mitzvos_ like _shofar_ and _lulav_ should not be done until after the
+     * published time for _netz_ / sunrise.
+     *
+     * @return the <code>Date</code> representing the exact sea level _netz amiti_ (sunrise) time. If the calculation can't be
+     *         computed such as in the Arctic Circle where there is at least one day a year where the sun does not rise, and one
+     *         where it does not set, a `null` will be returned. See detailed explanation on top of the page.
+     *
+     * @see ZENITH_1_POINT_583
+     */
+    getSunriseBaalHatanya() {
+        return this.noaa.getSunriseOffsetByDegrees(ZENITH_1_POINT_583);
+    }
+    /**
+     * A method that returns the <a href="https://en.wikipedia.org/wiki/Shneur_Zalman_of_Liadi">Baal Hatanya</a>'s
+     * _shkiah amiti_ (sunset) without
+     * elevation adjustment. This forms the base for the Baal Hatanya's dusk-based calculations that are calculated
+     * as a dip below the horizon after sunset.
+     *
+     * According to the Baal Hatanya, _shkiah amiti_, true (_halachic_) sunset, is when the top of the
+     * sun's disk disappears from view at an elevation similar to the mountains of _Eretz Yisrael_.
+     * This time is calculated as the point at which the center of the sun's disk is 1.583 degrees below the horizon.
+     *
+     * Note: _shkiah amiti_ is used only for calculating certain _zmanim_, and is intentionally unpublished. For
+     * practical purposes, all daytime mitzvos should be completed before the published time for _shkiah_ / sunset.
+     *
+     * For further explanation of the calculations used for the Baal Hatanya's _zmanim_ in this library, see
+     * <a href="https://www.chabad.org/library/article_cdo/aid/3209349/jewish/About-Our-Zmanim-Calculations.htm">About Our
+     * _Zmanim_ Calculations @ Chabad.org</a>.
+     *
+     * @return the <code>Date</code> representing the exact sea level _shkiah amiti_ (sunset) time. If the calculation
+     *         can't be computed such as in the Arctic Circle where there is at least one day a year where the sun does not
+     *         rise, and one where it does not set, a `null` will be returned.
+     *
+     * @see ZENITH_1_POINT_583
+     */
+    getSunsetBaalHatanya() {
+        return this.noaa.getSunsetOffsetByDegrees(ZENITH_1_POINT_583);
+    }
+    /**
+     * Returns the <a href="https://en.wikipedia.org/wiki/Shneur_Zalman_of_Liadi">Baal Hatanya</a>'s _alos_
+     * (dawn) calculated as the time when the sun is 16.9&deg; below the eastern {@link GEOMETRIC_ZENITH geometric horizon}
+     * before {@link getSunrise() sunrise}.
+     *
+     * The zenith of 16.9&deg; below is based on the calculation that the time between dawn
+     * and _netz amiti_ (sunrise) is 72 minutes, the time that is takes to walk 4 mil at 18 minutes
+     * a mil (<a href="https://en.wikipedia.org/wiki/Maimonides">Rambam</a> and others). The sun's position at 72
+     * minutes before {@link getSunriseBaalHatanya _netz amiti_ (sunrise)} in Jerusalem <a href=
+     * "https://kosherjava.com/2022/01/12/equinox-vs-equilux-zmanim-calculations/">around the equinox / equilux</a> is
+     * 16.9&deg; below {@link GEOMETRIC_ZENITH geometric zenith}.
+     *
+     * @return The <code>Date</code> of dawn. If the calculation can't be computed such as northern and southern
+     *         locations even south of the Arctic Circle and north of the Antarctic Circle where the sun may not reach
+     *         low enough below the horizon for this calculation, a `null` will be returned.   */
+    alosBaalHatanya() {
+        return this.timeAtAngle(16.9, true);
+    }
+    getShaahZmanisBaalHatanya(hours) {
+        const zdt = this.getShaahZmanisBasedZmanZdt(this.getSunriseBaalHatanya(), this.getSunsetBaalHatanya(), hours);
+        return zdtToDate(zdt);
+    }
+    /**
+     * This method returns the latest _zman krias shema_ (time to recite Shema in the morning). This time is 3
+     * {@link shaahZmanisBaalHatanya() _shaos zmaniyos_} (solar hours) after {@link getSunriseBaalHatanya()
+     * _netz amiti_ (sunrise)} based on the opinion of the Baal Hatanya that the day is calculated from
+     * sunrise to sunset. This returns the time 3 * {@link getShaahZmanisBaalHatanya()} after {@link getSunriseBaalHatanya()
+     * _netz amiti_ (sunrise)}.
+     *
+     * @return the <code>Date</code> of the latest _zman shema_ according to the Baal Hatanya. If the calculation
+     *         can't be computed such as in the Arctic Circle where there is at least one day a year where the sun does
+     *         not rise, and one where it does not set, a `null` will be returned.
+     */
+    sofZmanShmaBaalHatanya() {
+        return this.getShaahZmanisBaalHatanya(3);
+    }
+    /**
+     * This method returns the latest _zman tfilah_ (time to recite the morning prayers). This time is 4
+     * hours into the day based on the opinion of the Baal Hatanya that the day is
+     * calculated from sunrise to sunset. This returns the time 4 * {@link getShaahZmanisBaalHatanya()} after
+     * {@link getSunriseBaalHatanya() _netz amiti_ (sunrise)}.
+     *
+     * @return the <code>Date</code> of the latest _zman tfilah_. If the calculation can't be computed such as in
+     *         the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it does
+     *         not set, a `null` will be returned.
+     */
+    sofZmanTfilaBaalHatanya() {
+        return this.getShaahZmanisBaalHatanya(4);
+    }
+    /**
+     * This method returns the time of _mincha gedola_. _Mincha gedola_ is the earliest time one can pray
+     * _mincha_. The <a href="https://en.wikipedia.org/wiki/Maimonides">Rambam</a> is of the opinion that it is
+     * better to delay _mincha_ until {@link minchaKetanaBaalHatanya() _mincha ketana_} while the
+     * <a href="https://en.wikipedia.org/wiki/Asher_ben_Jehiel">Ra"sh</a>,
+     * <a href="https://en.wikipedia.org/wiki/Jacob_ben_Asher">Tur</a>, <a href=
+     * "https://en.wikipedia.org/wiki/Vilna_Gaon">GRA</a> and others are of the opinion that _mincha_ can be prayed
+     * _lechatchila_ starting at _mincha gedola_. This is calculated as 6.5 {@link getShaahZmanisBaalHatanya()
+     * sea level solar hours} after {@link getSunriseBaalHatanya() _netz amiti_ (sunrise)}. This calculation is based
+     * on the opinion of the Baal Hatanya that the day is calculated from sunrise to sunset. This returns the time 6.5
+     * * {@link getShaahZmanisBaalHatanya()} after {@link getSunriseBaalHatanya() _netz amiti_ ("real" sunrise)}.
+     * @return the <code>Date</code> of the time of _mincha gedola_ according to the Baal Hatanya. If the calculation
+     *         can't be computed such as in the Arctic Circle where there is at least one day a year where the sun does not rise,
+     *         and one where it does not set, a `null` will be returned.
+     */
+    minchaGedolaBaalHatanya() {
+        return this.getShaahZmanisBaalHatanya(6.5);
+    }
+    /**
+     * This method returns the time of _mincha ketana_. This is the preferred earliest time to pray
+     * _mincha_ in the opinion of the <a href="https://en.wikipedia.org/wiki/Maimonides">Rambam</a> and others.
+     * For more information on this see the documentation on {@link minchaGedolaBaalHatanya() _mincha gedola_}.
+     * This is calculated as 9.5 sea level solar hours after {@link getSunriseBaalHatanya
+     * _netz amiti_ (sunrise)}. This calculation is calculated based on the opinion of the Baal Hatanya that the
+     * day is calculated from sunrise to sunset. This returns the time 9.5 * after
+     * _netz amiti_ (sunrise).
+     *
+     * @return the <code>Date</code> of the time of _mincha ketana_. If the calculation can't be computed such as
+     *         in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it
+     *         does not set, a `null` will be returned.
+     */
+    minchaKetanaBaalHatanya() {
+        return this.getShaahZmanisBaalHatanya(9.5);
+    }
+    /**
+     * This method returns the time of _plag hamincha_. This is calculated as 10.75 hours after sunrise. This
+     * calculation is based on the opinion of the Baal Hatanya that the day is calculated
+     * from sunrise to sunset. This returns the time 10.75 * {@link getShaahZmanisBaalHatanya()} after
+     * {@link getSunriseBaalHatanya() _netz amiti_ (sunrise)}.
+     *
+     * @return the <code>Date</code> of the time of _plag hamincha_. If the calculation can't be computed such as
+     *         in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it
+     *         does not set, a `null` will be returned.
+     */
+    plagHaminchaBaalHatanya() {
+        return this.getShaahZmanisBaalHatanya(10.75);
+    }
+    /**
+     * A method that returns _tzais_ (nightfall) when the sun is 6&deg; below the western geometric horizon
+     * (90&deg;) after {@link getSunset() sunset}. For information on the source of this calculation see
+     * {@link ZENITH_6_DEGREES}.
+     *
+     * @return The <code>Date</code> of nightfall. If the calculation can't be computed such as northern and southern
+     *         locations even south of the Arctic Circle and north of the Antarctic Circle where the sun may not reach
+     *         low enough below the horizon for this calculation, a `null` will be returned.   * @see ZENITH_6_DEGREES
+     */
+    tzaisBaalHatanya() {
+        return this.timeAtAngle(6, false);
+    }
     /**
      * Uses timeFormat to return a date like '20:34'.
      * Returns `XX:XX` if the date is invalid.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/core",
-  "version": "6.1.0",
+  "version": "6.3.0",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "contributors": [
     "Eyal Schachter (https://github.com/Scimonster)",
@@ -68,6 +68,7 @@
   },
   "license": "GPL-2.0",
   "devDependencies": {
+    "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@rollup/plugin-terser": "^1.0.0",
     "@rollup/plugin-typescript": "^12.3.0",
@@ -79,7 +80,7 @@
     "rollup": "^4.60.1",
     "rollup-plugin-bundle-size": "^1.0.3",
     "rollup-plugin-visualizer": "^7.0.1",
-    "typedoc": "^0.28.18",
+    "typedoc": "^0.28.19",
     "typescript": "^6.0.2",
     "vitest": "^4.1.4"
   },

package/dist/CalOptions.d.ts

@@ -1,168 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import type { Location } from './location';
-export type DailyLearningValue = boolean | number | string;
-/**
- * Options to configure which events are returned
- */
-export type CalOptions = {
-    /**
-     * latitude/longitude/tzid used for candle-lighting
-     */
-    location?: Location;
-    /**
-     * Gregorian or Hebrew year
-     */
-    year?: number;
-    /**
-     * to interpret year as Hebrew year
-     */
-    isHebrewYear?: boolean;
-    /**
-     * Gregorian or Hebrew month (to filter results to a single month)
-     */
-    month?: number | string;
-    /**
-     * generate calendar for multiple years (default 1)
-     */
-    numYears?: number;
-    /**
-     * use specific start date (requires end date)
-     */
-    start?: number | HDate | Date;
-    /**
-     * use specific end date (requires start date)
-     */
-    end?: number | HDate | Date;
-    /**
-     * calculate candle-lighting and havdalah times
-     */
-    candlelighting?: boolean;
-    /**
-     * minutes before sundown to light candles (default 18)
-     */
-    candleLightingMins?: number;
-    /**
-     * minutes after sundown for Havdalah (typical values are 42, 50, or 72).
-     * If `undefined` (the default), calculate Havdalah according to Tzeit Hakochavim -
-     * Nightfall (the point when 3 small stars are observable in the night time sky with
-     * the naked eye). If `0`, Havdalah times are suppressed.
-     */
-    havdalahMins?: number;
-    /**
-     * degrees for solar depression for Havdalah.
-     * Default is 8.5 degrees for 3 small stars. use 7.083 degrees for 3 medium-sized stars
-     * (observed by Dr. Baruch (Berthold) Cohn in his luach published in France in 1899).
-     * If `0`, Havdalah times are suppressed.
-     */
-    havdalahDeg?: number;
-    /**
-     * degrees for solar depression for end of fast days.
-     * Default is 7.083 degrees for 3 medium-sized stars. Other commonly-used values include
-     * 6.45 degrees, as calculated by Rabbi Yechiel Michel Tucazinsky.
-     */
-    fastEndDeg?: number;
-    /**
-     * use elevation for calculations (default `false`).
-     * If `true`, use elevation to affect the calculation of all sunrise/sunset based zmanim.
-     * Note: there are some zmanim such as degree-based zmanim that are driven by the amount
-     * of light in the sky and are not impacted by elevation.
-     * These zmanim intentionally do not support elevation adjustment.
-     */
-    useElevation?: boolean;
-    /**
-     * calculate parashah hashavua on Saturdays
-     */
-    sedrot?: boolean;
-    /**
-     * Israeli holiday and sedra schedule
-     */
-    il?: boolean;
-    /**
-     * suppress minor fasts
-     */
-    noMinorFast?: boolean;
-    /**
-     * suppress modern holidays
-     */
-    noModern?: boolean;
-    /**
-     * suppress Rosh Chodesh
-     */
-    noRoshChodesh?: boolean;
-    /**
-     * add Shabbat Mevarchim
-     */
-    shabbatMevarchim?: boolean;
-    /**
-     * suppress Special Shabbat
-     */
-    noSpecialShabbat?: boolean;
-    /**
-     * suppress regular holidays
-     */
-    noHolidays?: boolean;
-    /**
-     * include Days of the Omer
-     */
-    omer?: boolean;
-    /**
-     * include event announcing the molad
-     */
-    molad?: boolean;
-    /**
-     * use Ashkenazi transliterations for event titles (default Sephardi transliterations)
-     * @deprecated use `event.render('ashkenazi')` instead
-     */
-    ashkenazi?: boolean;
-    /**
-     * translate event titles according to a locale
-     * Default value is `en`, also built-in are `he` and `ashkenazi`.
-     * Additional locales (such as `ru` or `fr`) are provided by the
-     * {@link https://github.com/hebcal/hebcal-locales @hebcal/locales} package
-     */
-    locale?: string;
-    /**
-     * print the Hebrew date for the entire date range
-     */
-    addHebrewDates?: boolean;
-    /**
-     * print the Hebrew date for dates with some events
-     */
-    addHebrewDatesForEvents?: boolean;
-    /**
-     * use bitmask from `flags` to filter events
-     */
-    mask?: number;
-    /**
-     * include Yom Kippur Katan (default `false`).
-     * יוֹם כִּפּוּר קָטָן is a minor day of atonement occurring monthly on the day preceeding each Rosh Chodesh.
-     * Yom Kippur Katan is omitted in Elul (on the day before Rosh Hashanah),
-     * Tishrei (Yom Kippur has just passed), Kislev (due to Chanukah)
-     * and Nisan (fasting not permitted during Nisan).
-     * When Rosh Chodesh occurs on Shabbat or Sunday, Yom Kippur Katan is observed on the preceding Thursday.
-     * See {@link https://en.wikipedia.org/wiki/Yom_Kippur_Katan#Practices Wikipedia Yom Kippur Katan practices}
-     */
-    yomKippurKatan?: boolean;
-    /**
-     * Whether to use 12-hour time (as opposed to 24-hour time).
-     * Possible values are `true` and `false`; the default is locale dependent.
-     */
-    hour12?: boolean;
-    /**
-     * map of options to enable daily study calendars
-     * such as `dafYomi`, `mishnaYomi`, `nachYomi` with value `true`. For `yerushalmi`
-     * the value should be a `number` for edition (`1` for Vilna, `2` for Schottenstein).
-     */
-    dailyLearning?: Record<string, DailyLearningValue>;
-    /**
-     * Yizkor (Hebrew: יִזְכּוֹר) is an Ashkenazi Jewish memorial prayer service
-     * for the dead. Yizkor is recited in synagogue as part of the service
-     * during four holidays each year:
-     * 1. Yom Kippur
-     * 2. Shmini Atzeret
-     * 3. The final day of Passover (8th day Pesach in Diaspora, 7th day
-     *    Pesach in Israel)
-     * 4. Shavuot (2nd day Shavuot in Diaspora)
-     */
-    yizkor?: boolean;
-};

package/dist/DailyLearning.d.ts

@@ -1,32 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import { Event } from './event';
-/**
- * Plug-ins for daily learning calendars such as Daf Yomi, Mishna Yomi, Nach Yomi, etc.
- *
- * Learning schedules are provided by the `@hebcal/learning` package.
- */
-export declare class DailyLearning {
-    /**
-     * Register a new learning calendar.
-     * @param name case insensitive
-     * @param calendar a function that returns an `Event` or `null`
-     * @param startDate the first date for which this calendar is valid
-     */
-    static addCalendar(name: string, calendar: (hd: HDate, il: boolean) => Event | null, startDate?: HDate): void;
-    /**
-     * Returns an event from daily calendar for a given date. Returns `null` if there
-     * is no learning from this calendar on this date.
-     * @param name case insensitive
-     * @param hd Hebrew Date
-     * @param il true for Israel, false for Diaspora
-     */
-    static lookup(name: string, hd: HDate, il: boolean): Event | null;
-    static getStartDate(name: string): HDate | undefined;
-    /**
-     * Tests to see if learning calendar has been registered
-     * @param name case insensitive
-     */
-    static has(name: string): boolean;
-    /** Returns the names of all calendars registered */
-    static getCalendars(): string[];
-}

package/dist/HebrewDateEvent.d.ts

@@ -1,37 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import { Event } from './event';
-import './locale';
-/** Daily Hebrew date ("11th of Sivan, 5780") */
-export declare class HebrewDateEvent extends Event {
-    /**
-     * @param date
-     */
-    constructor(date: HDate);
-    /**
-     * @param [locale] Optional locale name (defaults to empty locale)
-     * @example
-     * import {HDate, HebrewDateEvent, months} from '@hebcal/core';
-     *
-     * const hd = new HDate(15, months.CHESHVAN, 5769);
-     * const ev = new HebrewDateEvent(hd);
-     * console.log(ev.render('en')); // '15th of Cheshvan, 5769'
-     * console.log(ev.render('he')); // 'ט״ו חֶשְׁוָן תשס״ט'
-     */
-    render(locale?: string): string;
-    /**
-     * @private
-     * @param locale
-     */
-    private renderBriefHebrew;
-    /**
-     * @param [locale] Optional locale name (defaults to empty locale)
-     * @example
-     * import {HDate, HebrewDateEvent, months} from '@hebcal/core';
-     *
-     * const hd = new HDate(15, months.CHESHVAN, 5769);
-     * const ev = new HebrewDateEvent(hd);
-     * console.log(ev.renderBrief()); // '15th of Cheshvan'
-     * console.log(ev.renderBrief('he')); // 'ט״ו חֶשְׁוָן'
-     */
-    renderBrief(locale?: string): string;
-}

package/dist/HolidayEvent.d.ts

@@ -1,84 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import { Event } from './event';
-import './locale';
-/** Represents a built-in holiday like Pesach, Purim or Tu BiShvat */
-export declare class HolidayEvent extends Event {
-    /** During Sukkot or Pesach */
-    cholHaMoedDay?: number;
-    /**
-     * `true` if the fast day was postponed a day to avoid Shabbat.
-     * - Tish'a B'Av postponed from the 9th to the 10th
-     * - Tzom Tammuz postponed from the 17th to the 18th
-     */
-    observed?: boolean;
-    constructor(date: HDate, desc: string, mask?: number, attrs?: object);
-    basename(): string;
-    url(): string | undefined;
-    urlDateSuffix(): string;
-    getEmoji(): string;
-    getCategories(): string[];
-    /**
-     * Returns (translated) description of this event
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    render(locale?: string): 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 [locale] Optional locale name (defaults to empty locale)
-     */
-    renderBrief(locale?: string): string;
-}
-/**
- * Because Asara B'Tevet often occurs twice in the same Gregorian year,
- * we subclass HolidayEvent to generate the correct URL.
- */
-export declare class AsaraBTevetEvent extends HolidayEvent {
-    urlDateSuffix(): string;
-}
-/**
- * Because Chanukah sometimes starts in December and ends in January,
- * we subclass HolidayEvent to generate the correct URL.
- */
-export declare class ChanukahEvent extends HolidayEvent {
-    readonly chanukahDay?: number;
-    /**
-     * @param chanukahDay should be undefined for 1st night of Chanukah
-     */
-    constructor(date: HDate, desc: string, mask: number, chanukahDay?: number);
-    urlDateSuffix(): string;
-}
-/** Represents Rosh Hashana, the Jewish New Year */
-export declare class RoshHashanaEvent extends HolidayEvent {
-    private readonly hyear;
-    /**
-     * @private
-     * @param date Hebrew date event occurs
-     * @param hyear Hebrew year
-     * @param mask optional holiday flags
-     */
-    constructor(date: HDate, hyear: number, mask: number);
-    /**
-     * Returns (translated) description of this event
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    render(locale?: string): string;
-    getEmoji(): string;
-}
-/** Represents Rosh Chodesh, the beginning of a new month */
-export declare class RoshChodeshEvent extends HolidayEvent {
-    /**
-     * Constructs Rosh Chodesh event
-     * @param date Hebrew date event occurs
-     * @param monthName Hebrew month name (not translated)
-     */
-    constructor(date: HDate, monthName: string);
-    /**
-     * Returns (translated) description of this event
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    render(locale?: string): string;
-    basename(): string;
-    getEmoji(): string;
-}