@hebcal/core 5.3.10 → 5.3.11

package/README.md

@@ -1998,6 +1998,7 @@ Enables or disables elevation adjustment for zmanim support elevation adjustment
 ### zmanim.timeAtAngle(angle, rising) ⇒ <code>Date</code>
 Convenience function to get the time when sun is above or below the horizon
 for a certain angle (in degrees).
+This function does not support elevation adjustment.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 
@@ -2010,41 +2011,52 @@ for a certain angle (in degrees).
 
 ### zmanim.sunrise() ⇒ <code>Date</code>
 Upper edge of the Sun appears over the eastern horizon in the morning (0.833° above horizon)
+If elevation is enabled, this function will include elevation in the calculation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+seaLevelSunrise"></a>
 
 ### zmanim.seaLevelSunrise() ⇒ <code>Date</code>
-Upper edge of the Sun appears over the eastern horizon in the morning (0.833° above horizon)
+Upper edge of the Sun appears over the eastern horizon in the morning (0.833° above horizon).
+This function does not support elevation adjustment.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+sunset"></a>
 
 ### zmanim.sunset() ⇒ <code>Date</code>
-When the upper edge of the Sun disappears below the horizon (0.833° below horizon)
+When the upper edge of the Sun disappears below the horizon (0.833° below horizon).
+If elevation is enabled, this function will include elevation in the calculation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+seaLevelSunset"></a>
 
 ### zmanim.seaLevelSunset() ⇒ <code>Date</code>
-When the upper edge of the Sun disappears below the horizon (0.833° below horizon)
+When the upper edge of the Sun disappears below the horizon (0.833° below horizon).
+This function does not support elevation adjustment.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+dawn"></a>
 
 ### zmanim.dawn() ⇒ <code>Date</code>
-Civil dawn; Sun is 6° below the horizon in the morning
+Civil dawn; Sun is 6° below the horizon in the morning.
+Because degree-based functions estimate the amount of light in the sky,
+the result is not impacted by elevation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+dusk"></a>
 
 ### zmanim.dusk() ⇒ <code>Date</code>
-Civil dusk; Sun is 6° below the horizon in the evening
+Civil dusk; Sun is 6° below the horizon in the evening.
+Because degree-based functions estimate the amount of light in the sky,
+the result is not impacted by elevation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+gregEve"></a>
 
 ### zmanim.gregEve() ⇒ <code>Date</code>
+Returns sunset for the previous day.
+If elevation is enabled, this function will include elevation in the calculation.
+
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+chatzot"></a>
 
@@ -2055,37 +2067,46 @@ Midday – Chatzot; Sunrise plus 6 halachic hours
 <a name="Zmanim+chatzotNight"></a>
 
 ### zmanim.chatzotNight() ⇒ <code>Date</code>
-Midnight – Chatzot; Sunset plus 6 halachic hours
+Midnight – Chatzot; Sunset plus 6 halachic hours.
+If elevation is enabled, this function will include elevation in the calculation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+alotHaShachar"></a>
 
 ### zmanim.alotHaShachar() ⇒ <code>Date</code>
-Dawn – Alot haShachar; Sun is 16.1° below the horizon in the morning
+Dawn – Alot haShachar; Sun is 16.1° below the horizon in the morning.
+Because degree-based functions estimate the amount of light in the sky,
+the result is not impacted by elevation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+misheyakir"></a>
 
 ### zmanim.misheyakir() ⇒ <code>Date</code>
-Earliest talis & tefillin – Misheyakir; Sun is 11.5° below the horizon in the morning
+Earliest talis & tefillin – Misheyakir; Sun is 11.5° below the horizon in the morning.
+Because degree-based functions estimate the amount of light in the sky,
+the result is not impacted by elevation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+misheyakirMachmir"></a>
 
 ### zmanim.misheyakirMachmir() ⇒ <code>Date</code>
-Earliest talis & tefillin – Misheyakir Machmir; Sun is 10.2° below the horizon in the morning
+Earliest talis & tefillin – Misheyakir Machmir; Sun is 10.2° below the horizon in the morning.
+Because degree-based functions estimate the amount of light in the sky,
+the result is not impacted by elevation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+sofZmanShma"></a>
 
 ### zmanim.sofZmanShma() ⇒ <code>Date</code>
-Latest Shema (Gra); Sunrise plus 3 halachic hours, according to the Gra
+Latest Shema (Gra); Sunrise plus 3 halachic hours, according to the Gra.
+If elevation is enabled, this function will include elevation in the calculation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+sofZmanTfilla"></a>
 
 ### zmanim.sofZmanTfilla() ⇒ <code>Date</code>
-Latest Shacharit (Gra); Sunrise plus 4 halachic hours, according to the Gra
+Latest Shacharit (Gra); Sunrise plus 4 halachic hours, according to the Gra.
+If elevation is enabled, this function will include elevation in the calculation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+sofZmanShmaMGA"></a>
@@ -2146,19 +2167,22 @@ https://kosherjava.com/2022/01/12/equinox-vs-equilux-zmanim-calculations/
 <a name="Zmanim+minchaGedola"></a>
 
 ### zmanim.minchaGedola() ⇒ <code>Date</code>
-Earliest Mincha – Mincha Gedola; Sunrise plus 6.5 halachic hours
+Earliest Mincha – Mincha Gedola; Sunrise plus 6.5 halachic hours.
+If elevation is enabled, this function will include elevation in the calculation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+minchaKetana"></a>
 
 ### zmanim.minchaKetana() ⇒ <code>Date</code>
-Preferable earliest time to recite Minchah – Mincha Ketana; Sunrise plus 9.5 halachic hours
+Preferable earliest time to recite Minchah – Mincha Ketana; Sunrise plus 9.5 halachic hours.
+If elevation is enabled, this function will include elevation in the calculation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+plagHaMincha"></a>
 
 ### zmanim.plagHaMincha() ⇒ <code>Date</code>
-Plag haMincha; Sunrise plus 10.75 halachic hours
+Plag haMincha; Sunrise plus 10.75 halachic hours.
+If elevation is enabled, this function will include elevation in the calculation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+tzeit"></a>
@@ -2168,7 +2192,7 @@ Plag haMincha; Sunrise plus 10.75 halachic hours
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| [angle] | <code>number</code> | <code>8.5</code> | optional time for solar depression.   Default is 8.5 degrees for 3 small stars, use 7.083 degrees for 3 medium-sized stars. |
+| [angle] | <code>number</code> | <code>8.5</code> | optional time for solar depression.   Default is 8.5 degrees for 3 small stars, use 7.083 degrees for 3 medium-sized stars. Because degree-based functions estimate the amount of light in the sky, the result is not impacted by elevation. |
 
 <a name="Zmanim+neitzHaChama"></a>
 
@@ -2188,13 +2212,17 @@ Alias for sunset
 Rabbeinu Tam holds that bein hashmashos is a specific time
 between sunset and tzeis hakochavim.
 One opinion on how to calculate this time is that
-it is 13.5 minutes before tzies 7.083
+it is 13.5 minutes before tzies 7.083.
+Because degree-based functions estimate the amount of light in the sky,
+the result is not impacted by elevation.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+sunriseOffset"></a>
 
 ### zmanim.sunriseOffset(offset, roundMinute, forceSeaLevel) ⇒ <code>Date</code>
 Returns sunrise + `offset` minutes (either positive or negative).
+If elevation is enabled, this function will include elevation in the calculation
+ unless `forceSeaLevel` is `true`.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 
@@ -2208,6 +2236,8 @@ Returns sunrise + `offset` minutes (either positive or negative).
 
 ### zmanim.sunsetOffset(offset, roundMinute, forceSeaLevel) ⇒ <code>Date</code>
 Returns sunset + `offset` minutes (either positive or negative).
+If elevation is enabled, this function will include elevation in the calculation
+ unless `forceSeaLevel` is `true`.
 
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 

package/dist/bundle.js

@@ -1,4 +1,4 @@
-/*! @hebcal/core v5.3.10 */
+/*! @hebcal/core v5.3.11 */
 var hebcal = (function (exports) {
 'use strict';
 
@@ -9125,14 +9125,6 @@ function pad4(number) {
   return String(number);
 }
 
-Object.defineProperties(globalThis, p({
-  Temporal: mr
-})), Object.defineProperties(Intl, p({
-  DateTimeFormat: Sr
-})), Object.defineProperties(Date.prototype, p({
-  toTemporalInstant: toTemporalInstant
-}));
-
 /**
  * @private
  * @param {number} number
@@ -9145,6 +9137,24 @@ function pad2(number) {
   return String(number);
 }
 
+/**
+ * Returns YYYY-MM-DD in the local timezone
+ * @private
+ * @param {Date} dt
+ * @return {string}
+ */
+function isoDateString(dt) {
+  return pad4(dt.getFullYear()) + '-' + pad2(dt.getMonth() + 1) + '-' + pad2(dt.getDate());
+}
+
+Object.defineProperties(globalThis, p({
+  Temporal: mr
+})), Object.defineProperties(Intl, p({
+  DateTimeFormat: Sr
+})), Object.defineProperties(Date.prototype, p({
+  toTemporalInstant: toTemporalInstant
+}));
+
 /**
  * @private
  * @param {Temporal.ZonedDateTime} zdt
@@ -9227,6 +9237,7 @@ class Zmanim {
   /**
    * Convenience function to get the time when sun is above or below the horizon
    * for a certain angle (in degrees).
+   * This function does not support elevation adjustment.
    * @param {number} angle
    * @param {boolean} rising
    * @return {Date}
@@ -9238,6 +9249,7 @@ class Zmanim {
   }
   /**
    * Upper edge of the Sun appears over the eastern horizon in the morning (0.833° above horizon)
+   * If elevation is enabled, this function will include elevation in the calculation.
    * @return {Date}
    */
   sunrise() {
@@ -9245,7 +9257,8 @@ class Zmanim {
     return zdtToDate(zdt);
   }
   /**
-   * Upper edge of the Sun appears over the eastern horizon in the morning (0.833° above horizon)
+   * Upper edge of the Sun appears over the eastern horizon in the morning (0.833° above horizon).
+   * This function does not support elevation adjustment.
    * @return {Date}
    */
   seaLevelSunrise() {
@@ -9253,7 +9266,8 @@ class Zmanim {
     return zdtToDate(zdt);
   }
   /**
-   * When the upper edge of the Sun disappears below the horizon (0.833° below horizon)
+   * When the upper edge of the Sun disappears below the horizon (0.833° below horizon).
+   * If elevation is enabled, this function will include elevation in the calculation.
    * @return {Date}
    */
   sunset() {
@@ -9261,7 +9275,8 @@ class Zmanim {
     return zdtToDate(zdt);
   }
   /**
-   * When the upper edge of the Sun disappears below the horizon (0.833° below horizon)
+   * When the upper edge of the Sun disappears below the horizon (0.833° below horizon).
+   * This function does not support elevation adjustment.
    * @return {Date}
    */
   seaLevelSunset() {
@@ -9269,7 +9284,9 @@ class Zmanim {
     return zdtToDate(zdt);
   }
   /**
-   * Civil dawn; Sun is 6° below the horizon in the morning
+   * Civil dawn; Sun is 6° below the horizon in the morning.
+   * Because degree-based functions estimate the amount of light in the sky,
+   * the result is not impacted by elevation.
    * @return {Date}
    */
   dawn() {
@@ -9277,14 +9294,20 @@ class Zmanim {
     return zdtToDate(zdt);
   }
   /**
-   * Civil dusk; Sun is 6° below the horizon in the evening
+   * Civil dusk; Sun is 6° below the horizon in the evening.
+   * Because degree-based functions estimate the amount of light in the sky,
+   * the result is not impacted by elevation.
    * @return {Date}
    */
   dusk() {
     const zdt = this.noaa.getEndCivilTwilight();
     return zdtToDate(zdt);
   }
-  /** @return {Date} */
+  /**
+   * Returns sunset for the previous day.
+   * If elevation is enabled, this function will include elevation in the calculation.
+   * @return {Date}
+   */
   gregEve() {
     const prev = new Date(this.date);
     prev.setDate(prev.getDate() - 1);
@@ -9303,32 +9326,41 @@ class Zmanim {
    * @return {Date}
    */
   chatzot() {
-    const zdt = this.noaa.getSunTransit();
+    const startOfDay = this.noaa.getSeaLevelSunrise();
+    const endOfDay = this.noaa.getSeaLevelSunset();
+    const zdt = this.noaa.getSunTransit(startOfDay, endOfDay);
     return zdtToDate(zdt);
   }
   /**
-   * Midnight – Chatzot; Sunset plus 6 halachic hours
+   * Midnight – Chatzot; Sunset plus 6 halachic hours.
+   * If elevation is enabled, this function will include elevation in the calculation.
    * @return {Date}
    */
   chatzotNight() {
     return new Date(this.sunrise().getTime() - this.nightHour() * 6);
   }
   /**
-   * Dawn – Alot haShachar; Sun is 16.1° below the horizon in the morning
+   * Dawn – Alot haShachar; Sun is 16.1° below the horizon in the morning.
+   * Because degree-based functions estimate the amount of light in the sky,
+   * the result is not impacted by elevation.
    * @return {Date}
    */
   alotHaShachar() {
     return this.timeAtAngle(16.1, true);
   }
   /**
-   * Earliest talis & tefillin – Misheyakir; Sun is 11.5° below the horizon in the morning
+   * Earliest talis & tefillin – Misheyakir; Sun is 11.5° below the horizon in the morning.
+   * Because degree-based functions estimate the amount of light in the sky,
+   * the result is not impacted by elevation.
    * @return {Date}
    */
   misheyakir() {
     return this.timeAtAngle(11.5, true);
   }
   /**
-   * Earliest talis & tefillin – Misheyakir Machmir; Sun is 10.2° below the horizon in the morning
+   * Earliest talis & tefillin – Misheyakir Machmir; Sun is 10.2° below the horizon in the morning.
+   * Because degree-based functions estimate the amount of light in the sky,
+   * the result is not impacted by elevation.
    * @return {Date}
    */
   misheyakirMachmir() {
@@ -9349,7 +9381,8 @@ class Zmanim {
     return zdtToDate(zdt);
   }
   /**
-   * Latest Shema (Gra); Sunrise plus 3 halachic hours, according to the Gra
+   * Latest Shema (Gra); Sunrise plus 3 halachic hours, according to the Gra.
+   * If elevation is enabled, this function will include elevation in the calculation.
    * @return {Date}
    */
   sofZmanShma() {
@@ -9357,7 +9390,8 @@ class Zmanim {
     return this.getShaahZmanisBasedZman(3);
   }
   /**
-   * Latest Shacharit (Gra); Sunrise plus 4 halachic hours, according to the Gra
+   * Latest Shacharit (Gra); Sunrise plus 4 halachic hours, according to the Gra.
+   * If elevation is enabled, this function will include elevation in the calculation.
    * @return {Date}
    */
   sofZmanTfilla() {
@@ -9457,21 +9491,24 @@ class Zmanim {
     return new Date(alot.getTime() + 4 * temporalHour);
   }
   /**
-   * Earliest Mincha – Mincha Gedola; Sunrise plus 6.5 halachic hours
+   * Earliest Mincha – Mincha Gedola; Sunrise plus 6.5 halachic hours.
+   * If elevation is enabled, this function will include elevation in the calculation.
    * @return {Date}
    */
   minchaGedola() {
     return this.getShaahZmanisBasedZman(6.5);
   }
   /**
-   * Preferable earliest time to recite Minchah – Mincha Ketana; Sunrise plus 9.5 halachic hours
+   * Preferable earliest time to recite Minchah – Mincha Ketana; Sunrise plus 9.5 halachic hours.
+   * If elevation is enabled, this function will include elevation in the calculation.
    * @return {Date}
    */
   minchaKetana() {
     return this.getShaahZmanisBasedZman(9.5);
   }
   /**
-   * Plag haMincha; Sunrise plus 10.75 halachic hours
+   * Plag haMincha; Sunrise plus 10.75 halachic hours.
+   * If elevation is enabled, this function will include elevation in the calculation.
    * @return {Date}
    */
   plagHaMincha() {
@@ -9480,6 +9517,8 @@ class Zmanim {
   /**
    * @param {number} [angle=8.5] optional time for solar depression.
    *   Default is 8.5 degrees for 3 small stars, use 7.083 degrees for 3 medium-sized stars.
+   * Because degree-based functions estimate the amount of light in the sky,
+   * the result is not impacted by elevation.
    * @return {Date}
    */
   tzeit() {
@@ -9504,7 +9543,9 @@ class Zmanim {
    * Rabbeinu Tam holds that bein hashmashos is a specific time
    * between sunset and tzeis hakochavim.
    * One opinion on how to calculate this time is that
-   * it is 13.5 minutes before tzies 7.083
+   * it is 13.5 minutes before tzies 7.083.
+   * Because degree-based functions estimate the amount of light in the sky,
+   * the result is not impacted by elevation.
    * @return {Date}
    */
   beinHaShmashos() {
@@ -9580,6 +9621,8 @@ class Zmanim {
 
   /**
    * Returns sunrise + `offset` minutes (either positive or negative).
+   * If elevation is enabled, this function will include elevation in the calculation
+   *  unless `forceSeaLevel` is `true`.
    * @param {number} offset minutes
    * @param {boolean} roundMinute round time to nearest minute (default true)
    * @param {boolean} forceSeaLevel use sea-level sunrise (default false)
@@ -9604,6 +9647,8 @@ class Zmanim {
 
   /**
    * Returns sunset + `offset` minutes (either positive or negative).
+   * If elevation is enabled, this function will include elevation in the calculation
+   *  unless `forceSeaLevel` is `true`.
    * @param {number} offset minutes
    * @param {boolean} roundMinute round time to nearest minute (default true)
    * @param {boolean} forceSeaLevel use sea-level sunset (default false)
@@ -10847,8 +10892,7 @@ class ParshaEvent extends Event {
 
   /** @return {string} */
   urlDateSuffix() {
-    const isoDateTime = this.getDate().greg().toISOString();
-    const isoDate = isoDateTime.substring(0, isoDateTime.indexOf('T'));
+    const isoDate = isoDateString(this.getDate().greg());
     return isoDate.replace(/-/g, '');
   }
 }
@@ -11666,22 +11710,24 @@ class HolidayEvent extends Event {
     if (cats[0] !== 'unknown') {
       return cats;
     }
+    // Don't depend on flags.MINOR_HOLIDAY always being set. Look for minor holidays.
     const desc = this.getDesc();
-    // Don't depend on flags.MINOR_HOLIDAY always being set
-    switch (desc) {
-      case holidayDesc.LAG_BAOMER:
-      case holidayDesc.LEIL_SELICHOT:
-      case holidayDesc.PESACH_SHENI:
-      case holidayDesc.EREV_PURIM:
-      case holidayDesc.PURIM_KATAN:
-      case holidayDesc.SHUSHAN_PURIM:
-      case holidayDesc.TU_BAV:
-      case holidayDesc.TU_BISHVAT:
-      case holidayDesc.ROSH_HASHANA_LABEHEMOT:
-        return ['holiday', 'minor'];
-      default:
-        return ['holiday', 'major'];
-    }
+    const {
+      LAG_BAOMER,
+      LEIL_SELICHOT,
+      PESACH_SHENI,
+      EREV_PURIM,
+      PURIM_KATAN,
+      SHUSHAN_PURIM,
+      TU_BAV,
+      TU_BISHVAT,
+      ROSH_HASHANA_LABEHEMOT
+    } = holidayDesc;
+    const minorHolidays = [LAG_BAOMER, LEIL_SELICHOT, PESACH_SHENI, EREV_PURIM, PURIM_KATAN, SHUSHAN_PURIM, TU_BAV, TU_BISHVAT, ROSH_HASHANA_LABEHEMOT];
+    if (minorHolidays.includes(desc)) {
+      return ['holiday', 'minor'];
+    }
+    return ['holiday', 'major'];
   }
   /**
    * Returns (translated) description of this event
@@ -11744,8 +11790,7 @@ class RoshChodeshEvent extends HolidayEvent {
 class AsaraBTevetEvent extends HolidayEvent {
   /** @return {string} */
   urlDateSuffix() {
-    const isoDateTime = this.getDate().greg().toISOString();
-    const isoDate = isoDateTime.substring(0, isoDateTime.indexOf('T'));
+    const isoDate = isoDateString(this.getDate().greg());
     return isoDate.replace(/-/g, '');
   }
 }
@@ -12136,7 +12181,7 @@ class DailyLearning {
 }
 
 // DO NOT EDIT THIS AUTO-GENERATED FILE!
-const version = '5.3.10';
+const version = '5.3.11';
 
 const NONE$1 = 0;
 const HALF = 1;