@hebcal/core 5.1.1 → 5.2.1

package/README.md

@@ -1925,6 +1925,7 @@ https://gml.noaa.gov/grad/solcalc/calcdetails.html
         * [.tzeit([angle])](#Zmanim+tzeit) ⇒ <code>Date</code>
         * [.neitzHaChama()](#Zmanim+neitzHaChama) ⇒ <code>Date</code>
         * [.shkiah()](#Zmanim+shkiah) ⇒ <code>Date</code>
+        * [.beinHaShmashos()](#Zmanim+beinHaShmashos) ⇒ <code>Date</code>
         * [.sunriseOffset(offset, roundMinute, forceSeaLevel)](#Zmanim+sunriseOffset) ⇒ <code>Date</code>
         * [.sunsetOffset(offset, roundMinute, forceSeaLevel)](#Zmanim+sunsetOffset) ⇒ <code>Date</code>
     * _static_
@@ -2121,6 +2122,15 @@ Alias for sunrise
 ### zmanim.shkiah() ⇒ <code>Date</code>
 Alias for sunset
 
+**Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
+<a name="Zmanim+beinHaShmashos"></a>
+
+### zmanim.beinHaShmashos() ⇒ <code>Date</code>
+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
+
 **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)  
 <a name="Zmanim+sunriseOffset"></a>
 
@@ -2671,6 +2681,8 @@ Represents a built-in holiday like Pesach, Purim or Tu BiShvat
     * [.urlDateSuffix()](#HolidayEvent+urlDateSuffix) ⇒ <code>string</code>
     * [.getEmoji()](#HolidayEvent+getEmoji) ⇒ <code>string</code>
     * [.getCategories()](#HolidayEvent+getCategories) ⇒ <code>Array.&lt;string&gt;</code>
+    * [.render([locale])](#HolidayEvent+render) ⇒ <code>string</code>
+    * [.renderBrief([locale])](#HolidayEvent+renderBrief) ⇒ <code>string</code>
 
 <a name="HolidayEvent+basename"></a>
 
@@ -2692,6 +2704,30 @@ Represents a built-in holiday like Pesach, Purim or Tu BiShvat
 
 ### holidayEvent.getCategories() ⇒ <code>Array.&lt;string&gt;</code>
 **Kind**: instance method of [<code>HolidayEvent</code>](#HolidayEvent)  
+<a name="HolidayEvent+render"></a>
+
+### holidayEvent.render([locale]) ⇒ <code>string</code>
+Returns (translated) description of this event
+
+**Kind**: instance method of [<code>HolidayEvent</code>](#HolidayEvent)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
+
+<a name="HolidayEvent+renderBrief"></a>
+
+### holidayEvent.renderBrief([locale]) ⇒ <code>string</code>
+Returns a brief (translated) description of this event.
+For most events, this is the same as render(). For some events, it procudes
+a shorter text (e.g. without a time or added description).
+
+**Kind**: instance method of [<code>HolidayEvent</code>](#HolidayEvent)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
+
 <a name="RoshChodeshEvent"></a>
 
 ## RoshChodeshEvent
@@ -2754,13 +2790,14 @@ Represents Mevarchim haChodesh, the announcement of the new month
 **Kind**: global class  
 
 * [MevarchimChodeshEvent](#MevarchimChodeshEvent)
-    * [new MevarchimChodeshEvent(date, monthName)](#new_MevarchimChodeshEvent_new)
+    * [new MevarchimChodeshEvent(date, monthName, [memo])](#new_MevarchimChodeshEvent_new)
     * [.basename()](#MevarchimChodeshEvent+basename) ⇒ <code>string</code>
     * [.render([locale])](#MevarchimChodeshEvent+render) ⇒ <code>string</code>
+    * [.renderBrief([locale])](#MevarchimChodeshEvent+renderBrief) ⇒ <code>string</code>
 
 <a name="new_MevarchimChodeshEvent_new"></a>
 
-### new MevarchimChodeshEvent(date, monthName)
+### new MevarchimChodeshEvent(date, monthName, [memo])
 Constructs Mevarchim haChodesh event
 
 
@@ -2768,6 +2805,7 @@ Constructs Mevarchim haChodesh event
 | --- | --- | --- |
 | date | [<code>HDate</code>](#HDate) | Hebrew date event occurs |
 | monthName | <code>string</code> | Hebrew month name (not translated) |
+| [memo] | <code>string</code> |  |
 
 <a name="MevarchimChodeshEvent+basename"></a>
 
@@ -2784,6 +2822,17 @@ Returns (translated) description of this event
 | --- | --- | --- |
 | [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
 
+<a name="MevarchimChodeshEvent+renderBrief"></a>
+
+### mevarchimChodeshEvent.renderBrief([locale]) ⇒ <code>string</code>
+Returns (translated) description of this event
+
+**Kind**: instance method of [<code>MevarchimChodeshEvent</code>](#MevarchimChodeshEvent)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
+
 <a name="DailyLearning"></a>
 
 ## DailyLearning
@@ -2914,7 +2963,8 @@ These defaults can be changed using these options:
 
 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).
 
@@ -3225,6 +3275,7 @@ Holiday flags for Event
 | YOM_KIPPUR_KATAN | <code>number</code> | <code>8388608</code> | Yom Kippur Katan, minor day of atonement on the day preceeding each Rosh Chodesh |
 | YERUSHALMI_YOMI | <code>number</code> | <code>16777216</code> | Daily page of Jerusalem Talmud (Yerushalmi) |
 | NACH_YOMI | <code>number</code> | <code>33554432</code> | Nach Yomi |
+| DAILY_LEARNING | <code>number</code> | <code>67108864</code> | Daily Learning |
 
 <a name="parshiot"></a>
 

package/dist/bundle.js

@@ -1,4 +1,4 @@
-/*! @hebcal/core v5.1.1 */
+/*! @hebcal/core v5.2.1 */
 var hebcal = (function (exports) {
 'use strict';
 
@@ -1755,7 +1755,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
@@ -6977,7 +6979,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
@@ -7353,7 +7369,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
@@ -7363,8 +7381,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);
 }
 
@@ -10154,7 +10171,7 @@ class DailyLearning {
 }
 
 // DO NOT EDIT THIS AUTO-GENERATED FILE!
-const version = '5.1.1';
+const version = '5.2.1';
 
 var objectGetOwnPropertyDescriptor = {};
 
@@ -11748,7 +11765,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).
    *