@hebcal/core 5.4.3 → 5.4.4

package/dist/index.cjs

@@ -1,4 +1,4 @@
-/*! @hebcal/core v5.4.3 */
+/*! @hebcal/core v5.4.4 */
 'use strict';
 
 /* eslint-disable @typescript-eslint/no-namespace, no-inner-declarations */
@@ -8023,6 +8023,12 @@ class Zmanim {
     }
     /**
      * Latest Shacharit (Gra); Sunrise plus 4 halachic hours, according to the Gra.
+     *
+     * This method returns the latest *zman tfila* (time to recite shema in the morning)
+     * that is 4 *shaos zmaniyos* (solar hours) after sunrise or sea level sunrise
+     * (depending on the `useElevation` setting), according
+     * to the [GRA](https://en.wikipedia.org/wiki/Vilna_Gaon).
+     *
      * If elevation is enabled, this function will include elevation in the calculation.
      * @return {Date}
      */
@@ -8032,19 +8038,16 @@ class Zmanim {
     /**
      * Returns an array with alot (Date) and ms in hour (number)
      * @private
-     * @return {any[]}
      */
-    getTemporalHour72() {
-        const alot72 = this.sunriseOffset(-72, false, true);
-        const tzeit72 = this.sunsetOffset(72, false, true);
+    getTemporalHour72(forceSeaLevel) {
+        const alot72 = this.sunriseOffset(-72, false, forceSeaLevel);
+        const tzeit72 = this.sunsetOffset(72, false, forceSeaLevel);
         const temporalHour = (tzeit72.getTime() - alot72.getTime()) / 12;
         return [alot72, temporalHour];
     }
     /**
      * Returns an array with alot (Date) and ms in hour (number)
      * @private
-     * @param {number} angle
-     * @return {any[]}
      */
     getTemporalHourByDeg(angle) {
         const alot = this.timeAtAngle(angle, true);
@@ -8060,8 +8063,9 @@ class Zmanim {
      * @return {Date}
      */
     sofZmanShmaMGA() {
-        const [alot72, temporalHour] = this.getTemporalHour72();
-        return new Date(alot72.getTime() + (3 * temporalHour));
+        const [alot72, temporalHour] = this.getTemporalHour72(true);
+        const offset = Math.floor(3 * temporalHour);
+        return new Date(alot72.getTime() + offset);
     }
     /**
      * Latest Shema (MGA); Sunrise plus 3 halachic hours, according to Magen Avraham.
@@ -8071,7 +8075,8 @@ class Zmanim {
      */
     sofZmanShmaMGA16Point1() {
         const [alot, temporalHour] = this.getTemporalHourByDeg(16.1);
-        return new Date(alot.getTime() + (3 * temporalHour));
+        const offset = Math.floor(3 * temporalHour);
+        return new Date(alot.getTime() + offset);
     }
     /**
      * Latest Shema (MGA); Sunrise plus 3 halachic hours, according to Magen Avraham.
@@ -8085,15 +8090,17 @@ class Zmanim {
      */
     sofZmanShmaMGA19Point8() {
         const [alot, temporalHour] = this.getTemporalHourByDeg(19.8);
-        return new Date(alot.getTime() + (3 * temporalHour));
+        const offset = Math.floor(3 * temporalHour);
+        return new Date(alot.getTime() + offset);
     }
     /**
      * Latest Shacharit (MGA); Sunrise plus 4 halachic hours, according to Magen Avraham
      * @return {Date}
      */
     sofZmanTfillaMGA() {
-        const [alot72, temporalHour] = this.getTemporalHour72();
-        return new Date(alot72.getTime() + (4 * temporalHour));
+        const [alot72, temporalHour] = this.getTemporalHour72(true);
+        const offset = Math.floor(4 * temporalHour);
+        return new Date(alot72.getTime() + offset);
     }
     /**
      * Latest Shacharit (MGA); Sunrise plus 4 halachic hours, according to Magen Avraham.
@@ -8103,7 +8110,8 @@ class Zmanim {
      */
     sofZmanTfillaMGA16Point1() {
         const [alot, temporalHour] = this.getTemporalHourByDeg(16.1);
-        return new Date(alot.getTime() + (4 * temporalHour));
+        const offset = Math.floor(4 * temporalHour);
+        return new Date(alot.getTime() + offset);
     }
     /**
      * Latest Shacharit (MGA); Sunrise plus 4 halachic hours, according to Magen Avraham.
@@ -8117,24 +8125,67 @@ class Zmanim {
      */
     sofZmanTfillaMGA19Point8() {
         const [alot, temporalHour] = this.getTemporalHourByDeg(19.8);
-        return new Date(alot.getTime() + (4 * temporalHour));
+        const offset = Math.floor(4 * temporalHour);
+        return new Date(alot.getTime() + offset);
     }
     /**
-     * Earliest Mincha – Mincha Gedola; Sunrise plus 6.5 halachic hours.
+     * Earliest Mincha – Mincha Gedola (GRA); Sunrise plus 6.5 halachic hours.
      * If elevation is enabled, this function will include elevation in the calculation.
+     *
+     * This method returns the latest mincha gedola, the earliest time one can pray mincha
+     * that is 6.5 shaos zmaniyos (solar hours) after sunrise or sea level sunrise
+     * (depending on the `useElevation` setting), according
+     * to the [GRA](https://en.wikipedia.org/wiki/Vilna_Gaon).
+     *
+     * The Ramba"m is of the opinion that it is better to delay *mincha* until
+     * *mincha ketana* while the Ra"sh, Tur, GRA and others are of the
+     * opinion that *mincha* can be prayed *lechatchila* starting at *mincha gedola*.
      * @return {Date}
      */
     minchaGedola() {
         return this.getShaahZmanisBasedZman(6.5);
     }
+    /**
+     * Earliest Mincha – Mincha Gedola (MGA); Sunrise plus 6.5 halachic hours.
+     * If elevation is enabled, this function will include elevation in the calculation.
+     *
+     * This method returns the time of *mincha gedola* according to the Magen Avraham
+     * with the day starting 72 minutes before sunrise and ending 72 minutes after sunset.
+     * This is the earliest time to pray *mincha*.
+     * @return {Date}
+     */
+    minchaGedolaMGA() {
+        const [alot72, temporalHour] = this.getTemporalHour72(false);
+        const offset = Math.floor(6.5 * temporalHour);
+        return new Date(alot72.getTime() + offset);
+    }
     /**
      * 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.
+     *
+     * This method returns *mincha ketana*, the preferred earliest time to pray *mincha* in the
+     * opinion of the [Rambam](https://en.wikipedia.org/wiki/Maimonides) and others,
+     * that is 9.5 *shaos zmaniyos* (solar hours) after sunrise or sea level sunrise
+     * (depending on the `useElevation` setting), according
+     * to the [GRA](https://en.wikipedia.org/wiki/Vilna_Gaon).
      * @return {Date}
      */
     minchaKetana() {
         return this.getShaahZmanisBasedZman(9.5);
     }
+    /**
+     * This method returns the time of *mincha ketana* according to the Magen Avraham
+     * with the day starting 72 minutes before sunrise and ending 72 minutes after sunset.
+     * This is the preferred earliest time to pray *mincha* according to the opinion of
+     * the [Rambam](https://en.wikipedia.org/wiki/Maimonides) and others.
+     *
+     * If elevation is enabled, this function will include elevation in the calculation.
+     * @return {Date}
+     */
+    minchaKetanaMGA() {
+        const [alot72, temporalHour] = this.getTemporalHour72(false);
+        return new Date(alot72.getTime() + Math.floor(9.5 * temporalHour));
+    }
     /**
      * Plag haMincha; Sunrise plus 10.75 halachic hours.
      * If elevation is enabled, this function will include elevation in the calculation.
@@ -10009,7 +10060,7 @@ class DailyLearning {
 }
 
 /** DO NOT EDIT THIS AUTO-GENERATED FILE! */
-const version = '5.4.3';
+const version = '5.4.4';
 
 /* eslint-disable max-len */
 /**
@@ -10865,20 +10916,7 @@ function checkCandleOptions(options) {
     }
     let min = Number(options.candleLightingMins) || 18;
     if (location.getIsrael() && Math.abs(min) === 18) {
-        const geoid = location.getGeoId();
-        if (geoid) {
-            const offset = geoIdCandleOffset[geoid];
-            if (typeof offset === 'number') {
-                min = offset;
-            }
-        }
-        const shortName = location.getShortName();
-        if (shortName) {
-            const offset = israelCityOffset[shortName];
-            if (typeof offset === 'number') {
-                min = offset;
-            }
-        }
+        min = overrideIsraelCandleMins(location, min);
     }
     options.candleLightingMins = -1 * Math.abs(min);
     if (typeof options.havdalahMins === 'number') {
@@ -10894,6 +10932,23 @@ function checkCandleOptions(options) {
         options.fastEndDeg = TZEIT_3MEDIUM_STARS;
     }
 }
+function overrideIsraelCandleMins(location, min) {
+    const geoid = location.getGeoId();
+    if (geoid) {
+        const offset = geoIdCandleOffset[geoid];
+        if (typeof offset === 'number') {
+            return offset;
+        }
+    }
+    const shortName = location.getShortName();
+    if (shortName) {
+        const offset = israelCityOffset[shortName];
+        if (typeof offset === 'number') {
+            return offset;
+        }
+    }
+    return min;
+}
 /**
  * Mask to filter Holiday array
  * @private

package/dist/index.d.ts

@@ -10,6 +10,7 @@ export { Zmanim } from './zmanim';
 export { TimedEvent, CandleLightingEvent, HavdalahEvent } from './TimedEvent';
 export { Molad, MoladEvent } from './molad';
 export { OmerEvent } from './omer';
+export { TachanunResult } from './tachanun';
 export { Sedra, parshiot } from './sedra';
 export { ParshaEvent } from './ParshaEvent';
 export { HolidayEvent, AsaraBTevetEvent, RoshChodeshEvent, RoshHashanaEvent } from './HolidayEvent';

package/dist/index.mjs

@@ -1,4 +1,4 @@
-/*! @hebcal/core v5.4.3 */
+/*! @hebcal/core v5.4.4 */
 /* eslint-disable @typescript-eslint/no-namespace, no-inner-declarations */
 /** @private */
 const lengths = [0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31];
@@ -8021,6 +8021,12 @@ class Zmanim {
     }
     /**
      * Latest Shacharit (Gra); Sunrise plus 4 halachic hours, according to the Gra.
+     *
+     * This method returns the latest *zman tfila* (time to recite shema in the morning)
+     * that is 4 *shaos zmaniyos* (solar hours) after sunrise or sea level sunrise
+     * (depending on the `useElevation` setting), according
+     * to the [GRA](https://en.wikipedia.org/wiki/Vilna_Gaon).
+     *
      * If elevation is enabled, this function will include elevation in the calculation.
      * @return {Date}
      */
@@ -8030,19 +8036,16 @@ class Zmanim {
     /**
      * Returns an array with alot (Date) and ms in hour (number)
      * @private
-     * @return {any[]}
      */
-    getTemporalHour72() {
-        const alot72 = this.sunriseOffset(-72, false, true);
-        const tzeit72 = this.sunsetOffset(72, false, true);
+    getTemporalHour72(forceSeaLevel) {
+        const alot72 = this.sunriseOffset(-72, false, forceSeaLevel);
+        const tzeit72 = this.sunsetOffset(72, false, forceSeaLevel);
         const temporalHour = (tzeit72.getTime() - alot72.getTime()) / 12;
         return [alot72, temporalHour];
     }
     /**
      * Returns an array with alot (Date) and ms in hour (number)
      * @private
-     * @param {number} angle
-     * @return {any[]}
      */
     getTemporalHourByDeg(angle) {
         const alot = this.timeAtAngle(angle, true);
@@ -8058,8 +8061,9 @@ class Zmanim {
      * @return {Date}
      */
     sofZmanShmaMGA() {
-        const [alot72, temporalHour] = this.getTemporalHour72();
-        return new Date(alot72.getTime() + (3 * temporalHour));
+        const [alot72, temporalHour] = this.getTemporalHour72(true);
+        const offset = Math.floor(3 * temporalHour);
+        return new Date(alot72.getTime() + offset);
     }
     /**
      * Latest Shema (MGA); Sunrise plus 3 halachic hours, according to Magen Avraham.
@@ -8069,7 +8073,8 @@ class Zmanim {
      */
     sofZmanShmaMGA16Point1() {
         const [alot, temporalHour] = this.getTemporalHourByDeg(16.1);
-        return new Date(alot.getTime() + (3 * temporalHour));
+        const offset = Math.floor(3 * temporalHour);
+        return new Date(alot.getTime() + offset);
     }
     /**
      * Latest Shema (MGA); Sunrise plus 3 halachic hours, according to Magen Avraham.
@@ -8083,15 +8088,17 @@ class Zmanim {
      */
     sofZmanShmaMGA19Point8() {
         const [alot, temporalHour] = this.getTemporalHourByDeg(19.8);
-        return new Date(alot.getTime() + (3 * temporalHour));
+        const offset = Math.floor(3 * temporalHour);
+        return new Date(alot.getTime() + offset);
     }
     /**
      * Latest Shacharit (MGA); Sunrise plus 4 halachic hours, according to Magen Avraham
      * @return {Date}
      */
     sofZmanTfillaMGA() {
-        const [alot72, temporalHour] = this.getTemporalHour72();
-        return new Date(alot72.getTime() + (4 * temporalHour));
+        const [alot72, temporalHour] = this.getTemporalHour72(true);
+        const offset = Math.floor(4 * temporalHour);
+        return new Date(alot72.getTime() + offset);
     }
     /**
      * Latest Shacharit (MGA); Sunrise plus 4 halachic hours, according to Magen Avraham.
@@ -8101,7 +8108,8 @@ class Zmanim {
      */
     sofZmanTfillaMGA16Point1() {
         const [alot, temporalHour] = this.getTemporalHourByDeg(16.1);
-        return new Date(alot.getTime() + (4 * temporalHour));
+        const offset = Math.floor(4 * temporalHour);
+        return new Date(alot.getTime() + offset);
     }
     /**
      * Latest Shacharit (MGA); Sunrise plus 4 halachic hours, according to Magen Avraham.
@@ -8115,24 +8123,67 @@ class Zmanim {
      */
     sofZmanTfillaMGA19Point8() {
         const [alot, temporalHour] = this.getTemporalHourByDeg(19.8);
-        return new Date(alot.getTime() + (4 * temporalHour));
+        const offset = Math.floor(4 * temporalHour);
+        return new Date(alot.getTime() + offset);
     }
     /**
-     * Earliest Mincha – Mincha Gedola; Sunrise plus 6.5 halachic hours.
+     * Earliest Mincha – Mincha Gedola (GRA); Sunrise plus 6.5 halachic hours.
      * If elevation is enabled, this function will include elevation in the calculation.
+     *
+     * This method returns the latest mincha gedola, the earliest time one can pray mincha
+     * that is 6.5 shaos zmaniyos (solar hours) after sunrise or sea level sunrise
+     * (depending on the `useElevation` setting), according
+     * to the [GRA](https://en.wikipedia.org/wiki/Vilna_Gaon).
+     *
+     * The Ramba"m is of the opinion that it is better to delay *mincha* until
+     * *mincha ketana* while the Ra"sh, Tur, GRA and others are of the
+     * opinion that *mincha* can be prayed *lechatchila* starting at *mincha gedola*.
      * @return {Date}
      */
     minchaGedola() {
         return this.getShaahZmanisBasedZman(6.5);
     }
+    /**
+     * Earliest Mincha – Mincha Gedola (MGA); Sunrise plus 6.5 halachic hours.
+     * If elevation is enabled, this function will include elevation in the calculation.
+     *
+     * This method returns the time of *mincha gedola* according to the Magen Avraham
+     * with the day starting 72 minutes before sunrise and ending 72 minutes after sunset.
+     * This is the earliest time to pray *mincha*.
+     * @return {Date}
+     */
+    minchaGedolaMGA() {
+        const [alot72, temporalHour] = this.getTemporalHour72(false);
+        const offset = Math.floor(6.5 * temporalHour);
+        return new Date(alot72.getTime() + offset);
+    }
     /**
      * 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.
+     *
+     * This method returns *mincha ketana*, the preferred earliest time to pray *mincha* in the
+     * opinion of the [Rambam](https://en.wikipedia.org/wiki/Maimonides) and others,
+     * that is 9.5 *shaos zmaniyos* (solar hours) after sunrise or sea level sunrise
+     * (depending on the `useElevation` setting), according
+     * to the [GRA](https://en.wikipedia.org/wiki/Vilna_Gaon).
      * @return {Date}
      */
     minchaKetana() {
         return this.getShaahZmanisBasedZman(9.5);
     }
+    /**
+     * This method returns the time of *mincha ketana* according to the Magen Avraham
+     * with the day starting 72 minutes before sunrise and ending 72 minutes after sunset.
+     * This is the preferred earliest time to pray *mincha* according to the opinion of
+     * the [Rambam](https://en.wikipedia.org/wiki/Maimonides) and others.
+     *
+     * If elevation is enabled, this function will include elevation in the calculation.
+     * @return {Date}
+     */
+    minchaKetanaMGA() {
+        const [alot72, temporalHour] = this.getTemporalHour72(false);
+        return new Date(alot72.getTime() + Math.floor(9.5 * temporalHour));
+    }
     /**
      * Plag haMincha; Sunrise plus 10.75 halachic hours.
      * If elevation is enabled, this function will include elevation in the calculation.
@@ -10007,7 +10058,7 @@ class DailyLearning {
 }
 
 /** DO NOT EDIT THIS AUTO-GENERATED FILE! */
-const version = '5.4.3';
+const version = '5.4.4';
 
 /* eslint-disable max-len */
 /**
@@ -10863,20 +10914,7 @@ function checkCandleOptions(options) {
     }
     let min = Number(options.candleLightingMins) || 18;
     if (location.getIsrael() && Math.abs(min) === 18) {
-        const geoid = location.getGeoId();
-        if (geoid) {
-            const offset = geoIdCandleOffset[geoid];
-            if (typeof offset === 'number') {
-                min = offset;
-            }
-        }
-        const shortName = location.getShortName();
-        if (shortName) {
-            const offset = israelCityOffset[shortName];
-            if (typeof offset === 'number') {
-                min = offset;
-            }
-        }
+        min = overrideIsraelCandleMins(location, min);
     }
     options.candleLightingMins = -1 * Math.abs(min);
     if (typeof options.havdalahMins === 'number') {
@@ -10892,6 +10930,23 @@ function checkCandleOptions(options) {
         options.fastEndDeg = TZEIT_3MEDIUM_STARS;
     }
 }
+function overrideIsraelCandleMins(location, min) {
+    const geoid = location.getGeoId();
+    if (geoid) {
+        const offset = geoIdCandleOffset[geoid];
+        if (typeof offset === 'number') {
+            return offset;
+        }
+    }
+    const shortName = location.getShortName();
+    if (shortName) {
+        const offset = israelCityOffset[shortName];
+        if (typeof offset === 'number') {
+            return offset;
+        }
+    }
+    return min;
+}
 /**
  * Mask to filter Holiday array
  * @private

package/dist/pkgVersion.d.ts

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

package/dist/tachanun.d.ts

@@ -1,4 +1,7 @@
 import { HDate } from '@hebcal/hdate';
+/**
+ * Is *tachanun* said today?
+ */
 export type TachanunResult = {
     /** Tachanun is said at Shacharit */
     shacharit: boolean;

package/dist/zmanim.d.ts

@@ -160,6 +160,12 @@ export declare class Zmanim {
     sofZmanShma(): Date;
     /**
      * Latest Shacharit (Gra); Sunrise plus 4 halachic hours, according to the Gra.
+     *
+     * This method returns the latest *zman tfila* (time to recite shema in the morning)
+     * that is 4 *shaos zmaniyos* (solar hours) after sunrise or sea level sunrise
+     * (depending on the `useElevation` setting), according
+     * to the [GRA](https://en.wikipedia.org/wiki/Vilna_Gaon).
+     *
      * If elevation is enabled, this function will include elevation in the calculation.
      * @return {Date}
      */
@@ -167,16 +173,13 @@ export declare class Zmanim {
     /**
      * Returns an array with alot (Date) and ms in hour (number)
      * @private
-     * @return {any[]}
      */
-    getTemporalHour72(): any[];
+    getTemporalHour72(forceSeaLevel: boolean): [Date, number];
     /**
      * Returns an array with alot (Date) and ms in hour (number)
      * @private
-     * @param {number} angle
-     * @return {any[]}
      */
-    getTemporalHourByDeg(angle: number): any[];
+    getTemporalHourByDeg(angle: number): [Date, number];
     /**
      * Latest Shema (MGA); Sunrise plus 3 halachic hours, according to Magen Avraham.
      * Based on the opinion of the MGA that the day is calculated from
@@ -227,17 +230,52 @@ export declare class Zmanim {
      */
     sofZmanTfillaMGA19Point8(): Date;
     /**
-     * Earliest Mincha – Mincha Gedola; Sunrise plus 6.5 halachic hours.
+     * Earliest Mincha – Mincha Gedola (GRA); Sunrise plus 6.5 halachic hours.
      * If elevation is enabled, this function will include elevation in the calculation.
+     *
+     * This method returns the latest mincha gedola, the earliest time one can pray mincha
+     * that is 6.5 shaos zmaniyos (solar hours) after sunrise or sea level sunrise
+     * (depending on the `useElevation` setting), according
+     * to the [GRA](https://en.wikipedia.org/wiki/Vilna_Gaon).
+     *
+     * The Ramba"m is of the opinion that it is better to delay *mincha* until
+     * *mincha ketana* while the Ra"sh, Tur, GRA and others are of the
+     * opinion that *mincha* can be prayed *lechatchila* starting at *mincha gedola*.
      * @return {Date}
      */
     minchaGedola(): Date;
+    /**
+     * Earliest Mincha – Mincha Gedola (MGA); Sunrise plus 6.5 halachic hours.
+     * If elevation is enabled, this function will include elevation in the calculation.
+     *
+     * This method returns the time of *mincha gedola* according to the Magen Avraham
+     * with the day starting 72 minutes before sunrise and ending 72 minutes after sunset.
+     * This is the earliest time to pray *mincha*.
+     * @return {Date}
+     */
+    minchaGedolaMGA(): Date;
     /**
      * 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.
+     *
+     * This method returns *mincha ketana*, the preferred earliest time to pray *mincha* in the
+     * opinion of the [Rambam](https://en.wikipedia.org/wiki/Maimonides) and others,
+     * that is 9.5 *shaos zmaniyos* (solar hours) after sunrise or sea level sunrise
+     * (depending on the `useElevation` setting), according
+     * to the [GRA](https://en.wikipedia.org/wiki/Vilna_Gaon).
      * @return {Date}
      */
     minchaKetana(): Date;
+    /**
+     * This method returns the time of *mincha ketana* according to the Magen Avraham
+     * with the day starting 72 minutes before sunrise and ending 72 minutes after sunset.
+     * This is the preferred earliest time to pray *mincha* according to the opinion of
+     * the [Rambam](https://en.wikipedia.org/wiki/Maimonides) and others.
+     *
+     * If elevation is enabled, this function will include elevation in the calculation.
+     * @return {Date}
+     */
+    minchaKetanaMGA(): Date;
     /**
      * Plag haMincha; Sunrise plus 10.75 halachic hours.
      * If elevation is enabled, this function will include elevation in the calculation.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/core",
-  "version": "5.4.3",
+  "version": "5.4.4",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "contributors": [
     "Eyal Schachter (https://github.com/Scimonster)",