@hebcal/core 3.41.4 → 3.42.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +65 -0
- package/dist/bundle.js +875 -304
- package/dist/bundle.min.js +2 -2
- package/dist/greg0.mjs +1 -1
- package/dist/hdate-bundle.js +3 -3
- package/dist/hdate-bundle.min.js +2 -2
- package/dist/hdate.js +3 -3
- package/dist/hdate.mjs +3 -3
- package/dist/hdate0-bundle.js +1 -1
- package/dist/hdate0-bundle.min.js +1 -1
- package/dist/hdate0.mjs +1 -1
- package/dist/index.js +348 -62
- package/dist/index.mjs +348 -62
- package/hebcal.d.ts +66 -7
- package/package.json +11 -11
package/README.md
CHANGED
|
@@ -165,6 +165,8 @@ we omit the thousands (which is presently 5 [ה]).</p>
|
|
|
165
165
|
<dt><a href="#CalOptions">CalOptions</a> : <code>Object</code></dt>
|
|
166
166
|
<dd><p>Options to configure which events are returned</p>
|
|
167
167
|
</dd>
|
|
168
|
+
<dt><a href="#TachanunResult">TachanunResult</a> : <code>Object</code></dt>
|
|
169
|
+
<dd></dd>
|
|
168
170
|
</dl>
|
|
169
171
|
|
|
170
172
|
<a name="greg"></a>
|
|
@@ -2387,6 +2389,8 @@ Event names can be rendered in several languges using the `locale` option.
|
|
|
2387
2389
|
* [.reformatTimeStr(timeStr, suffix, options)](#HebrewCalendar.reformatTimeStr) ⇒ <code>string</code>
|
|
2388
2390
|
* [.version()](#HebrewCalendar.version) ⇒ <code>string</code>
|
|
2389
2391
|
* [.getSedra(hyear, il)](#HebrewCalendar.getSedra) ⇒ [<code>Sedra</code>](#Sedra)
|
|
2392
|
+
* [.hallel(hdate, il)](#HebrewCalendar.hallel) ⇒ <code>number</code>
|
|
2393
|
+
* [.tachanun(hdate, il)](#HebrewCalendar.tachanun) ⇒ [<code>TachanunResult</code>](#TachanunResult)
|
|
2390
2394
|
|
|
2391
2395
|
<a name="HebrewCalendar.calendar"></a>
|
|
2392
2396
|
|
|
@@ -2645,6 +2649,54 @@ created and cached instance.
|
|
|
2645
2649
|
| hyear | <code>number</code> |
|
|
2646
2650
|
| il | <code>boolean</code> |
|
|
2647
2651
|
|
|
2652
|
+
<a name="HebrewCalendar.hallel"></a>
|
|
2653
|
+
|
|
2654
|
+
### HebrewCalendar.hallel(hdate, il) ⇒ <code>number</code>
|
|
2655
|
+
Return a number containing information on what Hallel is said on that day.
|
|
2656
|
+
|
|
2657
|
+
Whole Hallel is said on Chanukah, the first Yom Tov of Pesach, Shavuot, Sukkot,
|
|
2658
|
+
Yom Ha'atzmaut, and Yom Yerushalayim.
|
|
2659
|
+
|
|
2660
|
+
Half Hallel is said on Rosh Chodesh (not Rosh Hashanah), and the last 6 days of Pesach.
|
|
2661
|
+
|
|
2662
|
+
The number is one of the following values:
|
|
2663
|
+
|
|
2664
|
+
0 - No Hallel
|
|
2665
|
+
1 - Half Hallel
|
|
2666
|
+
2 - Whole Hallel
|
|
2667
|
+
|
|
2668
|
+
**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)
|
|
2669
|
+
|
|
2670
|
+
| Param | Type |
|
|
2671
|
+
| --- | --- |
|
|
2672
|
+
| hdate | [<code>HDate</code>](#HDate) |
|
|
2673
|
+
| il | <code>boolean</code> |
|
|
2674
|
+
|
|
2675
|
+
<a name="HebrewCalendar.tachanun"></a>
|
|
2676
|
+
|
|
2677
|
+
### HebrewCalendar.tachanun(hdate, il) ⇒ [<code>TachanunResult</code>](#TachanunResult)
|
|
2678
|
+
Return details on what Tachanun (or Tzidchatcha on Shabbat) is said on `hdate`.
|
|
2679
|
+
|
|
2680
|
+
Tachanun is not said on Rosh Chodesh, the month of Nisan, Lag Baomer,
|
|
2681
|
+
Rosh Chodesh Sivan until Isru Chag, Tisha B'av, 15 Av, Erev Rosh Hashanah,
|
|
2682
|
+
Rosh Hashanah, Erev Yom Kippur until after Simchat Torah, Chanukah,
|
|
2683
|
+
Tu B'shvat, Purim and Shushan Purim, and Purim and Shushan Purim Katan.
|
|
2684
|
+
|
|
2685
|
+
In some congregations Tachanun is not said until from Rosh Chodesh Sivan
|
|
2686
|
+
until 14th Sivan, Sukkot until after Rosh Chodesh Cheshvan, Pesach Sheini,
|
|
2687
|
+
Yom Ha'atzmaut, and Yom Yerushalayim.
|
|
2688
|
+
|
|
2689
|
+
Tachanun is not said at Mincha on days before it is not said at Shacharit.
|
|
2690
|
+
|
|
2691
|
+
Tachanun is not said at Shacharit on Shabbat, but is at Mincha, usually.
|
|
2692
|
+
|
|
2693
|
+
**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)
|
|
2694
|
+
|
|
2695
|
+
| Param | Type |
|
|
2696
|
+
| --- | --- |
|
|
2697
|
+
| hdate | [<code>HDate</code>](#HDate) |
|
|
2698
|
+
| il | <code>boolean</code> |
|
|
2699
|
+
|
|
2648
2700
|
<a name="months"></a>
|
|
2649
2701
|
|
|
2650
2702
|
## months : <code>enum</code>
|
|
@@ -2829,3 +2881,16 @@ Options to configure which events are returned
|
|
|
2829
2881
|
| mask | <code>number</code> | use bitmask from `flags` to filter events |
|
|
2830
2882
|
| 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) |
|
|
2831
2883
|
| 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. |
|
|
2884
|
+
|
|
2885
|
+
<a name="TachanunResult"></a>
|
|
2886
|
+
|
|
2887
|
+
## TachanunResult : <code>Object</code>
|
|
2888
|
+
**Kind**: global typedef
|
|
2889
|
+
**Properties**
|
|
2890
|
+
|
|
2891
|
+
| Name | Type | Description |
|
|
2892
|
+
| --- | --- | --- |
|
|
2893
|
+
| shacharit | <code>boolean</code> | Tachanun is said at Shacharit |
|
|
2894
|
+
| mincha | <code>boolean</code> | Tachanun is said at Mincha |
|
|
2895
|
+
| allCongs | <code>boolean</code> | All congregations say Tachanun on the day |
|
|
2896
|
+
|