@hebcal/core 6.10.0 → 6.11.0

package/README.md

@@ -216,13 +216,21 @@ visible — calculated at 8.5° of solar depression. Two mutually exclusive over
 
 **Minor fasts** begin at Alot HaShachar (16.1° in the morning). They end at 7.083°
 in the Diaspora, or 15 minutes after sunset in Israel (Rabbi Deblitzky's practice).
-Override with `options.fastEndDeg` or `options.fastEndMins` — again mutually
-exclusive. When a minor fast falls on a Friday, the end time is suppressed, because
+Each end has a pair of mutually exclusive overrides:
+
+- `options.fastStartDeg` — a different solar depression angle for the start, or
+  `options.fastStartMins` — a fixed number of minutes before sunrise (72 and 90
+  are typical).
+- `options.fastEndDeg` — a different solar depression angle for the end, or
+  `options.fastEndMins` — a fixed number of minutes after sunset.
+
+When a minor fast falls on a Friday, the end time is suppressed, because
 Shabbat begins before nightfall.
 
-**Tish'a B'Av** does not follow those rules: it begins at sunset the previous day and
-always ends at 6.45° (Rabbi Yechiel Michel Tucazinsky), ignoring `fastEndDeg` and
-`fastEndMins`.
+**Tish'a B'Av** does not follow those rules: it always begins at sunset the
+previous day, and by default ends at 6.45° (Rabbi Yechiel Michel Tucazinsky),
+ignoring the minor fast options. Override its end with `options.tishaBavEndDeg` or
+`options.tishaBavEndMins` (mutually exclusive).
 
 **Chanukah** candle-lighting, also generated when `candlelighting` and `location`
 are set, is at Bein HaShmashos (13.5 minutes before 7.083°) on weekdays, regular

package/dist/bundle.js

@@ -1,9 +1,9 @@
-/*! @hebcal/core v6.10.0, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
+/*! @hebcal/core v6.11.0, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
 var hebcal = (function (exports) {
 'use strict';
 
 /** DO NOT EDIT THIS AUTO-GENERATED FILE! */
-const version = '6.10.0';
+const version = '6.11.0';
 
 /*! @hebcal/hdate v0.22.8, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
 /** @private */
@@ -13207,11 +13207,43 @@ const TZEIT_3MEDIUM_STARS = 7.0833333;
  * @private
  */
 const MINOR_FAST_END_MINUTES_IL = 15;
+/**
+ * Alot HaShachar, 16.1° below geometric zenith.
+ * Default start time for minor fasts.
+ * @private
+ */
+const ALOT_16_POINT_1 = 16.1;
+/**
+ * Returns `val` when it is a finite nonzero number, otherwise `undefined`
+ * @private
+ */
+function nonzero(val) {
+    return typeof val === 'number' && isFinite(val) && val !== 0 ? val : undefined;
+}
+/**
+ * Computes the "Fast begins" time for a minor fast (one that begins at dawn).
+ *
+ * When `options.fastStartMins` is a nonzero number, the fast begins that many
+ * minutes before sunrise; otherwise, when `options.fastStartDeg` is a nonzero
+ * number, the fast begins when the sun is that many degrees below the horizon
+ * in the morning. By default, minor fasts begin at Alot HaShachar (16.1°).
+ * @private
+ */
+function makeFastStartTime(zmanim, options) {
+    const fastStartMins = nonzero(options.fastStartMins);
+    if (fastStartMins !== undefined) {
+        return zmanim.sunriseOffset(-Math.abs(fastStartMins), true);
+    }
+    const fastStartDeg = nonzero(options.fastStartDeg);
+    return zmanim.timeAtAngle(fastStartDeg === undefined ? ALOT_16_POINT_1 : Math.abs(fastStartDeg), true);
+}
 /**
  * Computes the "Fast ends" time for a fast day.
  *
- * Tish'a B'Av always ends at tzeit 6.45° (Rabbi Yechiel Michel Tucazinsky),
- * regardless of `options`.
+ * Tish'a B'Av ends `options.tishaBavEndMins` minutes after sunset or at tzeit
+ * `options.tishaBavEndDeg` when either is a nonzero number, and otherwise at
+ * tzeit 6.45° (Rabbi Yechiel Michel Tucazinsky). It is not affected by
+ * `options.fastEndDeg`, `options.fastEndMins` or `options.il`.
  *
  * For minor fasts: when `options.fastEndMins` is a nonzero number, the fast
  * ends that many minutes after sunset; otherwise, when `options.fastEndDeg` is
@@ -13223,7 +13255,12 @@ const MINOR_FAST_END_MINUTES_IL = 15;
  */
 function makeFastEndTime(zmanim, isTishaBav, options) {
     if (isTishaBav) {
-        return zmanim.tzeit(TZEIT_TUCAZINSKY);
+        const tishaBavEndMins = nonzero(options.tishaBavEndMins);
+        if (tishaBavEndMins !== undefined) {
+            return zmanim.sunsetOffset(Math.abs(tishaBavEndMins), true);
+        }
+        const tishaBavEndDeg = nonzero(options.tishaBavEndDeg);
+        return zmanim.tzeit(tishaBavEndDeg === undefined ? TZEIT_TUCAZINSKY : Math.abs(tishaBavEndDeg));
     }
     const fastEndMins = options.fastEndMins;
     if (typeof fastEndMins === 'number' && fastEndMins !== 0) {
@@ -13247,13 +13284,16 @@ function makeFastEndTime(zmanim, isTishaBav, options) {
  * `options.candlelighting` is `true` and `options.location` is provided.
  *
  * - Minor fasts (including Yom Kippur Katan) begin at *Alot HaShachar*
- *   (16.1° below horizon in the morning). By default they end at tzeit
- *   7.083° (3 medium-sized stars) in the Diaspora, or 15 minutes after
+ *   (16.1° below horizon in the morning), which can be overridden via
+ *   `options.fastStartDeg` or `options.fastStartMins`. By default they end at
+ *   tzeit 7.083° (3 medium-sized stars) in the Diaspora, or 15 minutes after
  *   sunset in Israel (Rabbi Deblitzky's practice). This can be overridden
  *   via `options.fastEndDeg` or `options.fastEndMins`.
- * - Tish'a B'Av begins at sunset on the previous day and always ends at tzeit
- *   6.45° below horizon (Rabbi Yechiel Michel Tucazinsky), regardless of
- *   `options.fastEndDeg` / `options.fastEndMins`.
+ * - Tish'a B'Av begins at sunset on the previous day, regardless of
+ *   `options.fastStartDeg` / `options.fastStartMins`. By default it ends at
+ *   tzeit 6.45° below horizon (Rabbi Yechiel Michel Tucazinsky), which can be
+ *   overridden via `options.tishaBavEndDeg` or `options.tishaBavEndMins`
+ *   (but not by `options.fastEndDeg` / `options.fastEndMins`).
  * - When a minor fast falls on a Friday, the end time is suppressed
  *   (Shabbat begins before nightfall).
  */
@@ -13312,9 +13352,9 @@ function makeFastStartEnd(ev, options) {
         }
     }
     else {
-        const dawn = zmanim.alotHaShachar();
-        if (!isNaN(dawn.getTime())) {
-            startEvent = makeTimedEvent(ev, dawn, FAST_BEGINS, options);
+        const fastStart = makeFastStartTime(zmanim, options);
+        if (!isNaN(fastStart.getTime())) {
+            startEvent = makeTimedEvent(ev, fastStart, FAST_BEGINS, options);
         }
         if (dt.getDay() !== 5 &&
             !(hd.getDate() === 14 && hd.getMonth() === months.NISAN)) {
@@ -14397,13 +14437,21 @@ class MevarchimChodeshEvent extends Event {
  * They end when 3 medium-sized stars are observable in the night sky (sun is 7.083°
  * below the horizon in the evening) in the Diaspora, or 15 minutes after sunset in
  * Israel (Rabbi Deblitzky's practice). Override with:
+ * * `options.fastStartDeg` - degrees of solar depression for the start of a minor fast
+ * * `options.fastStartMins` - minutes before sunrise for the start of a minor fast
+ *   (mutually exclusive with `options.fastStartDeg`)
  * * `options.fastEndDeg` - degrees of solar depression for the end of a minor fast
  * * `options.fastEndMins` - minutes after sunset for the end of a minor fast
  *   (mutually exclusive with `options.fastEndDeg`)
  *
- * Tish'a B'Av is different: it begins at sunset on the previous day and always ends
- * at tzeit 6.45° (Rabbi Yechiel Michel Tucazinsky), ignoring `options.fastEndDeg`
- * and `options.fastEndMins`. When a minor fast falls on a Friday the end time is
+ * Tish'a B'Av is different: it always begins at sunset on the previous day, and
+ * by default ends at tzeit 6.45° (Rabbi Yechiel Michel Tucazinsky), ignoring the
+ * minor fast options above. Override its end with:
+ * * `options.tishaBavEndDeg` - degrees of solar depression for the end of Tish'a B'Av
+ * * `options.tishaBavEndMins` - minutes after sunset for the end of Tish'a B'Av
+ *   (mutually exclusive with `options.tishaBavEndDeg`)
+ *
+ * When a minor fast falls on a Friday the end time is
  * suppressed, because Shabbat begins before nightfall.
  *
  * Two options also exist for generating an Event with the Hebrew date:
@@ -14624,6 +14672,10 @@ const RECOGNIZED_OPTIONS = {
     havdalahDeg: 1,
     fastEndDeg: 1,
     fastEndMins: 1,
+    fastStartDeg: 1,
+    fastStartMins: 1,
+    tishaBavEndDeg: 1,
+    tishaBavEndMins: 1,
     sedrot: 1,
     il: 1,
     noMinorFast: 1,
@@ -14712,6 +14764,14 @@ function checkCandleOptions(options) {
         typeof options.fastEndMins === 'number') {
         throw new TypeError('options.fastEndDeg and options.fastEndMins are mutually exclusive');
     }
+    if (typeof options.fastStartDeg === 'number' &&
+        typeof options.fastStartMins === 'number') {
+        throw new TypeError('options.fastStartDeg and options.fastStartMins are mutually exclusive');
+    }
+    if (typeof options.tishaBavEndDeg === 'number' &&
+        typeof options.tishaBavEndMins === 'number') {
+        throw new TypeError('options.tishaBavEndDeg and options.tishaBavEndMins are mutually exclusive');
+    }
     const min0 = options.candleLightingMins;
     let min = typeof min0 === 'number' && !isNaN(min0) ? Math.trunc(min0) : 18;
     if (location.getIsrael() && Math.abs(min) === 18) {
@@ -14733,6 +14793,18 @@ function checkCandleOptions(options) {
     if (typeof options.fastEndMins === 'number') {
         options.fastEndMins = Math.trunc(Math.abs(options.fastEndMins));
     }
+    if (typeof options.fastStartDeg === 'number') {
+        options.fastStartDeg = Math.abs(options.fastStartDeg);
+    }
+    if (typeof options.fastStartMins === 'number') {
+        options.fastStartMins = Math.trunc(Math.abs(options.fastStartMins));
+    }
+    if (typeof options.tishaBavEndDeg === 'number') {
+        options.tishaBavEndDeg = Math.abs(options.tishaBavEndDeg);
+    }
+    if (typeof options.tishaBavEndMins === 'number') {
+        options.tishaBavEndMins = Math.trunc(Math.abs(options.tishaBavEndMins));
+    }
 }
 function overrideIsraelCandleMins(location) {
     const geoid = location.getGeoId();