@hebcal/core 3.41.3 → 3.42.1

package/README.md

@@ -165,6 +165,8 @@ we omit the thousands (which is presently 5 [ה]).</p>
 <dt><a href="#CalOptions">CalOptions</a> : <code>Object</code></dt>
 <dd><p>Options to configure which events are returned</p>
 </dd>
+<dt><a href="#TachanunResult">TachanunResult</a> : <code>Object</code></dt>
+<dd></dd>
 </dl>
 
 <a name="greg"></a>
@@ -178,7 +180,7 @@ Gregorian date helper functions.
     * [.isLeapYear(year)](#greg.isLeapYear) ⇒ <code>boolean</code>
     * [.daysInMonth(month, year)](#greg.daysInMonth) ⇒ <code>number</code>
     * [.isDate(obj)](#greg.isDate) ⇒ <code>boolean</code>
-    * [.dayOfYear(date)](#greg.dayOfYear) ⇒ <code>number</code>
+    * ~~[.dayOfYear(date)](#greg.dayOfYear) ⇒ <code>number</code>~~
     * [.greg2abs(date)](#greg.greg2abs) ⇒ <code>number</code>
     * [.abs2greg(theDate)](#greg.abs2greg) ⇒ <code>Date</code>
 
@@ -218,7 +220,9 @@ Returns true if the object is a Javascript Date
 
 <a name="greg.dayOfYear"></a>
 
-### greg.dayOfYear(date) ⇒ <code>number</code>
+### ~~greg.dayOfYear(date) ⇒ <code>number</code>~~
+***Deprecated***
+
 Returns number of days since January 1 of that year
 
 **Kind**: static method of [<code>greg</code>](#greg)  
@@ -1443,7 +1447,7 @@ Class representing Location
         * [.lookup(name)](#Location.lookup) ⇒ [<code>Location</code>](#Location)
         * [.legacyTzToTzid(tz, dst)](#Location.legacyTzToTzid) ⇒ <code>string</code>
         * [.getUsaTzid(state, tz, dst)](#Location.getUsaTzid) ⇒ <code>string</code>
-        * [.geonameCityDescr(cityName, admin1, countryName)](#Location.geonameCityDescr) ⇒ <code>string</code>
+        * ~~[.geonameCityDescr(cityName, admin1, countryName)](#Location.geonameCityDescr) ⇒ <code>string</code>~~
         * [.addLocation(cityName, location)](#Location.addLocation) ⇒ <code>boolean</code>
 
 <a name="new_Location_new"></a>
@@ -1585,7 +1589,9 @@ Location.getUsaTzid('AZ', 7, 'Y') // 'America/Denver'
 ```
 <a name="Location.geonameCityDescr"></a>
 
-### Location.geonameCityDescr(cityName, admin1, countryName) ⇒ <code>string</code>
+### ~~Location.geonameCityDescr(cityName, admin1, countryName) ⇒ <code>string</code>~~
+***Deprecated***
+
 Builds a city description from geonameid string components
 
 **Kind**: static method of [<code>Location</code>](#Location)  
@@ -2263,6 +2269,7 @@ Represents Mevarchim haChodesh, the announcement of the new month
 
 * [MevarchimChodeshEvent](#MevarchimChodeshEvent)
     * [new MevarchimChodeshEvent(date, monthName)](#new_MevarchimChodeshEvent_new)
+    * [.basename()](#MevarchimChodeshEvent+basename) ⇒ <code>string</code>
     * [.render([locale])](#MevarchimChodeshEvent+render) ⇒ <code>string</code>
 
 <a name="new_MevarchimChodeshEvent_new"></a>
@@ -2276,6 +2283,10 @@ Constructs Mevarchim haChodesh event
 | date | [<code>HDate</code>](#HDate) | Hebrew date event occurs |
 | monthName | <code>string</code> | Hebrew month name (not translated) |
 
+<a name="MevarchimChodeshEvent+basename"></a>
+
+### mevarchimChodeshEvent.basename() ⇒ <code>string</code>
+**Kind**: instance method of [<code>MevarchimChodeshEvent</code>](#MevarchimChodeshEvent)  
 <a name="MevarchimChodeshEvent+render"></a>
 
 ### mevarchimChodeshEvent.render([locale]) ⇒ <code>string</code>
@@ -2378,6 +2389,8 @@ Event names can be rendered in several languges using the `locale` option.
     * [.reformatTimeStr(timeStr, suffix, options)](#HebrewCalendar.reformatTimeStr) ⇒ <code>string</code>
     * [.version()](#HebrewCalendar.version) ⇒ <code>string</code>
     * [.getSedra(hyear, il)](#HebrewCalendar.getSedra) ⇒ [<code>Sedra</code>](#Sedra)
+    * [.hallel(hdate, il)](#HebrewCalendar.hallel) ⇒ <code>number</code>
+    * [.tachanun(hdate, il)](#HebrewCalendar.tachanun) ⇒ [<code>TachanunResult</code>](#TachanunResult)
 
 <a name="HebrewCalendar.calendar"></a>
 
@@ -2416,6 +2429,7 @@ Additional non-default event types can be specified:
 * Mishna Yomi (`options.mishnaYomi`)
 * Shabbat Mevarchim HaChodesh on Saturday before Rosh Chodesh (`options.shabbatMevarchim`)
 * Molad announcement on Saturday before Rosh Chodesh (`options.molad`)
+* Yom Kippur Katan (`options.yomKippurKatan`)
 
 Candle-lighting and Havdalah times are approximated using latitude and longitude
 specified by the [Location](#Location) class. The `Location` class contains a small
@@ -2635,6 +2649,54 @@ created and cached instance.
 | hyear | <code>number</code> | 
 | il | <code>boolean</code> | 
 
+<a name="HebrewCalendar.hallel"></a>
+
+### HebrewCalendar.hallel(hdate, il) ⇒ <code>number</code>
+Return a number containing information on what Hallel is said on that day.
+
+Whole Hallel is said on Chanukah, the first Yom Tov of Pesach, Shavuot, Sukkot,
+Yom Ha'atzmaut, and Yom Yerushalayim.
+
+Half Hallel is said on Rosh Chodesh (not Rosh Hashanah), and the last 6 days of Pesach.
+
+The number is one of the following values:
+
+0 - No Hallel
+1 - Half Hallel
+2 - Whole Hallel
+
+**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)  
+
+| Param | Type |
+| --- | --- |
+| hdate | [<code>HDate</code>](#HDate) | 
+| il | <code>boolean</code> | 
+
+<a name="HebrewCalendar.tachanun"></a>
+
+### HebrewCalendar.tachanun(hdate, il) ⇒ [<code>TachanunResult</code>](#TachanunResult)
+Return details on what Tachanun (or Tzidchatcha on Shabbat) is said on `hdate`.
+
+Tachanun is not said on Rosh Chodesh, the month of Nisan, Lag Baomer,
+Rosh Chodesh Sivan until Isru Chag, Tisha B'av, 15 Av, Erev Rosh Hashanah,
+Rosh Hashanah, Erev Yom Kippur until after Simchat Torah, Chanukah,
+Tu B'shvat, Purim and Shushan Purim, and Purim and Shushan Purim Katan.
+
+In some congregations Tachanun is not said until from Rosh Chodesh Sivan
+until 14th Sivan, Sukkot until after Rosh Chodesh Cheshvan, Pesach Sheini,
+Yom Ha'atzmaut, and Yom Yerushalayim.
+
+Tachanun is not said at Mincha on days before it is not said at Shacharit.
+
+Tachanun is not said at Shacharit on Shabbat, but is at Mincha, usually.
+
+**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)  
+
+| Param | Type |
+| --- | --- |
+| hdate | [<code>HDate</code>](#HDate) | 
+| il | <code>boolean</code> | 
+
 <a name="months"></a>
 
 ## months : <code>enum</code>
@@ -2694,6 +2756,7 @@ Holiday flags for Event
 | EREV | <code>number</code> | <code>1048576</code> | Evening before a major or minor holiday |
 | CHOL_HAMOED | <code>number</code> | <code>2097152</code> | Chol haMoed, intermediate days of Pesach or Sukkot |
 | MISHNA_YOMI | <code>number</code> | <code>4194304</code> | Mishna Yomi |
+| YOM_KIPPUR_KATAN | <code>number</code> | <code>8388608</code> | Yom Kippur Katan, minor day of atonement on the day preceeding each Rosh Chodesh |
 
 <a name="parshiot"></a>
 
@@ -2818,3 +2881,16 @@ Options to configure which events are returned
 | mask | <code>number</code> | use bitmask from `flags` to filter events |
 | yomKippurKatan | <code>boolean</code> | include Yom Kippur Katan (default `false`).      יוֹם כִּפּוּר קָטָן is a minor day of atonement occurring monthly on the day preceeding each Rosh Chodesh.      Yom Kippur Katan is omitted in Elul (on the day before Rosh Hashanah),      Tishrei (Yom Kippur has just passed), Kislev (due to Chanukah)      and Nisan (fasting not permitted during Nisan).      When Rosh Chodesh occurs on Shabbat or Sunday, Yom Kippur Katan is observed on the preceding Thursday.      See [Wikipedia Yom Kippur Katan practices](https://en.wikipedia.org/wiki/Yom_Kippur_Katan#Practices) |
 | hour12 | <code>boolean</code> | Whether to use 12-hour time (as opposed to 24-hour time).      Possible values are `true` and `false`; the default is locale dependent. |
+
+<a name="TachanunResult"></a>
+
+## TachanunResult : <code>Object</code>
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| shacharit | <code>boolean</code> | Tachanun is said at Shacharit |
+| mincha | <code>boolean</code> | Tachanun is said at Mincha |
+| allCongs | <code>boolean</code> | All congregations say Tachanun on the day |
+