@hebcal/core 5.1.1 → 5.2.1

package/dist/index.cjs

@@ -1,4 +1,4 @@
-/*! @hebcal/core v5.1.1 */
+/*! @hebcal/core v5.2.1 */
 'use strict';
 
 /** @private */
@@ -1794,7 +1794,9 @@ const flags = {
   /** Daily page of Jerusalem Talmud (Yerushalmi) */
   YERUSHALMI_YOMI: 0x1000000,
   /** Nach Yomi */
-  NACH_YOMI: 0x2000000
+  NACH_YOMI: 0x2000000,
+  /** Daily Learning */
+  DAILY_LEARNING: 0x4000000
 };
 const flagToCategory = [[flags.MAJOR_FAST, 'holiday', 'major', 'fast'], [flags.CHANUKAH_CANDLES, 'holiday', 'major'], [flags.HEBREW_DATE, 'hebdate'], [flags.MINOR_FAST, 'holiday', 'fast'], [flags.MINOR_HOLIDAY, 'holiday', 'minor'], [flags.MODERN_HOLIDAY, 'holiday', 'modern'], [flags.MOLAD, 'molad'], [flags.OMER_COUNT, 'omer'], [flags.PARSHA_HASHAVUA, 'parashat'],
 // backwards-compat
@@ -3816,7 +3818,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
@@ -4188,7 +4204,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
@@ -4198,8 +4216,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);
 }
 
@@ -6317,7 +6334,7 @@ class DailyLearning {
 }
 
 // DO NOT EDIT THIS AUTO-GENERATED FILE!
-const version = '5.1.1';
+const version = '5.2.1';
 
 const NONE$1 = 0;
 const HALF = 1;
@@ -7398,7 +7415,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.1 */
+/*! @hebcal/core v5.2.1 */
 /** @private */
 const lengths = [0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31];
 /** @private */
@@ -1792,7 +1792,9 @@ const flags = {
   /** Daily page of Jerusalem Talmud (Yerushalmi) */
   YERUSHALMI_YOMI: 0x1000000,
   /** Nach Yomi */
-  NACH_YOMI: 0x2000000
+  NACH_YOMI: 0x2000000,
+  /** Daily Learning */
+  DAILY_LEARNING: 0x4000000
 };
 const flagToCategory = [[flags.MAJOR_FAST, 'holiday', 'major', 'fast'], [flags.CHANUKAH_CANDLES, 'holiday', 'major'], [flags.HEBREW_DATE, 'hebdate'], [flags.MINOR_FAST, 'holiday', 'fast'], [flags.MINOR_HOLIDAY, 'holiday', 'minor'], [flags.MODERN_HOLIDAY, 'holiday', 'modern'], [flags.MOLAD, 'molad'], [flags.OMER_COUNT, 'omer'], [flags.PARSHA_HASHAVUA, 'parashat'],
 // backwards-compat
@@ -3814,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
@@ -4186,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
@@ -4196,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);
 }
 
@@ -6315,7 +6332,7 @@ class DailyLearning {
 }
 
 // DO NOT EDIT THIS AUTO-GENERATED FILE!
-const version = '5.1.1';
+const version = '5.2.1';
 
 const NONE$1 = 0;
 const HALF = 1;
@@ -7396,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/hebcal.d.ts

@@ -91,6 +91,8 @@ declare module '@hebcal/core' {
         YERUSHALMI_YOMI = 0x1000000,
         /** Nach Yomi */
         NACH_YOMI = 0x2000000,
+        /** Daily Learning */
+        DAILY_LEARNING = 0x4000000,
     }
 
     export type UnitTypeShort = 'd' | 'w' | 'M' | 'y';
@@ -455,6 +457,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
@@ -497,7 +506,7 @@ declare module '@hebcal/core' {
          * @param id - Message ID to translate
          * @param [locale] - Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
          */
-        static lookupTranslation(id: string, locale?: string): string;
+        static lookupTranslation(id: string, locale?: string): string | undefined;
         /**
          * By default, if no translation was found, returns `id`.
          * @param id - Message ID to translate
@@ -700,7 +709,7 @@ declare module '@hebcal/core' {
          * @param date - Hebrew Date, Gregorian date, or absolute R.D. day number
          * @param il - use the Israeli schedule for holidays
          */
-        static getHolidaysOnDate(date: HDate | Date | number, il?: boolean): Event[];
+        static getHolidaysOnDate(date: HDate | Date | number, il?: boolean): Event[] | undefined;
 
         /**
          * Calculates a birthday or anniversary (non-yahrzeit).
@@ -723,7 +732,7 @@ declare module '@hebcal/core' {
          * @param gdate - Gregorian or Hebrew date of event
          * @returns anniversary occurring in hyear
          */
-        static getBirthdayOrAnniversary(hyear: number, gdate: Date | HDate): HDate;
+        static getBirthdayOrAnniversary(hyear: number, gdate: Date | HDate): HDate | undefined;
 
         /**
          * Calculates yahrzeit.
@@ -754,7 +763,7 @@ declare module '@hebcal/core' {
          * @param gdate - Gregorian or Hebrew date of death
          * @returns anniversary occurring in hyear
          */
-        static getYahrzeit(hyear: number, gdate: Date | HDate): HDate;
+        static getYahrzeit(hyear: number, gdate: Date | HDate): HDate | undefined;
 
         /**
          * Helper function to format a 23-hour (00:00-23:59) time in US format ("8:13pm") or

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/core",
-  "version": "5.1.1",
+  "version": "5.2.1",
   "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",
@@ -86,7 +86,7 @@
     "eslint": "^8.56.0",
     "eslint-config-google": "^0.14.0",
     "jsdoc": "^4.0.2",
-    "jsdoc-to-markdown": "^8.0.0",
+    "jsdoc-to-markdown": "^8.0.1",
     "nyc": "^15.1.0",
     "quick-lru": "^7.0.0",
     "rollup": "^4.9.6",