@hebcal/core 5.1.0 → 5.2.0

package/dist/index.cjs

@@ -1,4 +1,4 @@
-/*! @hebcal/core v5.1.0 */
+/*! @hebcal/core v5.2.0 */
 'use strict';
 
 /** @private */
@@ -1696,7 +1696,11 @@ function fixDate(date) {
       date.yy += 1;
     }
     date.dd -= daysInMonth(date.mm, date.yy);
-    date.mm += 1;
+    if (date.mm === monthsInYear(date.yy)) {
+      date.mm = 1; // rollover to NISAN
+    } else {
+      date.mm += 1;
+    }
     fix(date);
   }
   fixMonth(date);
@@ -3812,7 +3816,21 @@ class Zmanim {
   shkiah() {
     return this.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
+   * @return {Date}
+   */
+  beinHaShmashos() {
+    const tzeit = this.tzeit(7.083);
+    const millis = tzeit.getTime();
+    if (isNaN(millis)) {
+      return tzeit;
+    }
+    return new Date(millis - 13.5 * 60 * 1000);
+  }
   /**
    * Uses timeFormat to return a date like '20:34'
    * @param {Date} dt
@@ -4184,7 +4202,9 @@ function makeTimedEvent(hd, time, desc, ev, options) {
 }
 
 /**
- * Makes a candle-lighting event for Chankah (not on Friday/Saturday)
+ * Makes a candle-lighting event for Chankah (not on Friday/Saturday).
+ * At one point this used civil dusk (6 degrees below horizon).
+ * Another source suggests 4.6667 degrees below horizon.
  * @private
  * @param {Event} ev
  * @param {HDate} hd
@@ -4194,8 +4214,7 @@ function makeTimedEvent(hd, time, desc, ev, options) {
 function makeWeekdayChanukahCandleLighting(ev, hd, options) {
   const location = options.location;
   const zmanim = new Zmanim(location, hd.greg(), options.useElevation);
-  const candleLightingTime = zmanim.dusk();
-  // const candleLightingTime = zmanim.tzeit(4.6667);
+  const candleLightingTime = zmanim.beinHaShmashos();
   return makeTimedEvent(hd, candleLightingTime, ev.getDesc(), ev, options);
 }
 
@@ -6313,7 +6332,7 @@ class DailyLearning {
 }
 
 // DO NOT EDIT THIS AUTO-GENERATED FILE!
-const version = '5.1.0';
+const version = '5.2.0';
 
 const NONE$1 = 0;
 const HALF = 1;
@@ -7394,7 +7413,8 @@ class HebrewCalendar {
    *
    * If both `options.candlelighting=true` and `options.location` is specified,
    * Chanukah candle-lighting times and minor fast start/end times will also be generated.
-   * Chanukah candle-lighting is at dusk (when the sun is 6.0° below the horizon in the evening)
+   * Chanukah candle-lighting is at Bein HaShmashos (13.5 minutes before
+   * the sun is 7.083° below the horizon in the evening)
    * on weekdays, at regular candle-lighting time on Fridays, and at regular Havdalah time on
    * Saturday night (see above).
    *

package/dist/index.mjs

@@ -1,4 +1,4 @@
-/*! @hebcal/core v5.1.0 */
+/*! @hebcal/core v5.2.0 */
 /** @private */
 const lengths = [0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31];
 /** @private */
@@ -1694,7 +1694,11 @@ function fixDate(date) {
       date.yy += 1;
     }
     date.dd -= daysInMonth(date.mm, date.yy);
-    date.mm += 1;
+    if (date.mm === monthsInYear(date.yy)) {
+      date.mm = 1; // rollover to NISAN
+    } else {
+      date.mm += 1;
+    }
     fix(date);
   }
   fixMonth(date);
@@ -3810,7 +3814,21 @@ class Zmanim {
   shkiah() {
     return this.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
+   * @return {Date}
+   */
+  beinHaShmashos() {
+    const tzeit = this.tzeit(7.083);
+    const millis = tzeit.getTime();
+    if (isNaN(millis)) {
+      return tzeit;
+    }
+    return new Date(millis - 13.5 * 60 * 1000);
+  }
   /**
    * Uses timeFormat to return a date like '20:34'
    * @param {Date} dt
@@ -4182,7 +4200,9 @@ function makeTimedEvent(hd, time, desc, ev, options) {
 }
 
 /**
- * Makes a candle-lighting event for Chankah (not on Friday/Saturday)
+ * Makes a candle-lighting event for Chankah (not on Friday/Saturday).
+ * At one point this used civil dusk (6 degrees below horizon).
+ * Another source suggests 4.6667 degrees below horizon.
  * @private
  * @param {Event} ev
  * @param {HDate} hd
@@ -4192,8 +4212,7 @@ function makeTimedEvent(hd, time, desc, ev, options) {
 function makeWeekdayChanukahCandleLighting(ev, hd, options) {
   const location = options.location;
   const zmanim = new Zmanim(location, hd.greg(), options.useElevation);
-  const candleLightingTime = zmanim.dusk();
-  // const candleLightingTime = zmanim.tzeit(4.6667);
+  const candleLightingTime = zmanim.beinHaShmashos();
   return makeTimedEvent(hd, candleLightingTime, ev.getDesc(), ev, options);
 }
 
@@ -6311,7 +6330,7 @@ class DailyLearning {
 }
 
 // DO NOT EDIT THIS AUTO-GENERATED FILE!
-const version = '5.1.0';
+const version = '5.2.0';
 
 const NONE$1 = 0;
 const HALF = 1;
@@ -7392,7 +7411,8 @@ class HebrewCalendar {
    *
    * If both `options.candlelighting=true` and `options.location` is specified,
    * Chanukah candle-lighting times and minor fast start/end times will also be generated.
-   * Chanukah candle-lighting is at dusk (when the sun is 6.0° below the horizon in the evening)
+   * Chanukah candle-lighting is at Bein HaShmashos (13.5 minutes before
+   * the sun is 7.083° below the horizon in the evening)
    * on weekdays, at regular candle-lighting time on Fridays, and at regular Havdalah time on
    * Saturday night (see above).
    *

package/hebcal.d.ts

@@ -455,6 +455,13 @@ declare module '@hebcal/core' {
         neitzHaChama(): Date;
         /** Alias for sunset */
         shkiah(): Date;
+        /**
+         * 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
+         */
+        beinHaShmashos(): Date;
         /**
          * Returns sunrise + `offset` minutes (either positive or negative).
          * @param offset minutes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/core",
-  "version": "5.1.0",
+  "version": "5.2.0",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "contributors": [
     "Eyal Schachter (https://github.com/Scimonster)",
@@ -51,7 +51,7 @@
     "prepublish": "npm run build",
     "po2json": "node ./po2json.cjs po/*.po",
     "version": "node ./version.cjs package.json src/pkgVersion.js",
-    "readme": "npx -p jsdoc-to-markdown jsdoc2md dist/index.js",
+    "readme": "cp dist/index.mjs tmp.js && npx -p jsdoc-to-markdown jsdoc2md tmp.js && rm -f tmp.js",
     "pretest": "npm run build",
     "lint": "eslint src",
     "coverage": "nyc --concurrency 2 ava",
@@ -71,8 +71,8 @@
     "temporal-polyfill": "^0.1.1"
   },
   "devDependencies": {
-    "@babel/core": "^7.23.7",
-    "@babel/preset-env": "^7.23.8",
+    "@babel/core": "^7.23.9",
+    "@babel/preset-env": "^7.23.9",
     "@babel/register": "^7.23.7",
     "@hebcal/hdate": "^0.9.1",
     "@hebcal/noaa": "^0.8.11",
@@ -81,15 +81,15 @@
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-terser": "^0.4.4",
-    "ava": "^6.0.1",
-    "core-js": "^3.35.0",
+    "ava": "^6.1.1",
+    "core-js": "^3.35.1",
     "eslint": "^8.56.0",
     "eslint-config-google": "^0.14.0",
     "jsdoc": "^4.0.2",
     "jsdoc-to-markdown": "^8.0.0",
     "nyc": "^15.1.0",
     "quick-lru": "^7.0.0",
-    "rollup": "^4.9.5",
+    "rollup": "^4.9.6",
     "ttag-cli": "^1.10.10"
   }
 }