@hebcal/core 3.38.0 → 3.39.0

package/README.md

@@ -399,7 +399,6 @@ Represents a Hebrew date
         * [.daysInMonth(month, year)](#HDate.daysInMonth) ⇒ <code>number</code>
         * [.getMonthName(month, year)](#HDate.getMonthName) ⇒ <code>string</code>
         * [.monthNum(month)](#HDate.monthNum) ⇒ <code>number</code>
-        * [.elapsedDays(year)](#HDate.elapsedDays) ⇒ <code>number</code>
         * [.daysInYear(year)](#HDate.daysInYear) ⇒ <code>number</code>
         * [.longCheshvan(year)](#HDate.longCheshvan) ⇒ <code>boolean</code>
         * [.shortKislev(year)](#HDate.shortKislev) ⇒ <code>boolean</code>
@@ -802,18 +801,6 @@ Returns the Hebrew month number (NISAN=1, TISHREI=7)
 | --- | --- | --- |
 | month | <code>number</code> \| <code>string</code> | A number, or Hebrew month name string |
 
-<a name="HDate.elapsedDays"></a>
-
-### HDate.elapsedDays(year) ⇒ <code>number</code>
-Days from sunday prior to start of Hebrew calendar to mean
-conjunction of Tishrei in Hebrew YEAR
-
-**Kind**: static method of [<code>HDate</code>](#HDate)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| year | <code>number</code> | Hebrew year |
-
 <a name="HDate.daysInYear"></a>
 
 ### HDate.daysInYear(year) ⇒ <code>number</code>
@@ -903,6 +890,7 @@ Represents an Event with a title, date, and flags
     * [.url()](#Event+url) ⇒ <code>string</code>
     * [.observedInIsrael()](#Event+observedInIsrael) ⇒ <code>boolean</code>
     * [.observedInDiaspora()](#Event+observedInDiaspora) ⇒ <code>boolean</code>
+    * [.observedIn(il)](#Event+observedIn) ⇒ <code>boolean</code>
     * ~~[.getAttrs()](#Event+getAttrs) ⇒ <code>Object</code>~~
     * [.clone()](#Event+clone) ⇒ [<code>Event</code>](#Event)
 
@@ -1016,6 +1004,26 @@ ev1.observedInDiaspora(); // true
 const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
 ev2.observedInDiaspora(); // true
 ```
+<a name="Event+observedIn"></a>
+
+### event.observedIn(il) ⇒ <code>boolean</code>
+Is this event observed in Israel/Diaspora?
+
+**Kind**: instance method of [<code>Event</code>](#Event)  
+
+| Param | Type |
+| --- | --- |
+| il | <code>boolean</code> | 
+
+**Example**  
+```js
+const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
+ev1.observedIn(false); // true
+ev1.observedIn(true); // false
+const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
+ev2.observedIn(false); // true
+ev2.observedIn(true); // true
+```
 <a name="Event+getAttrs"></a>
 
 ### ~~event.getAttrs() ⇒ <code>Object</code>~~
@@ -1823,12 +1831,14 @@ Represents a day 1-49 of counting the Omer from Pesach to Shavuot
 
 * [OmerEvent](#OmerEvent)
     * [new OmerEvent(date, omerDay)](#new_OmerEvent_new)
+    * [.sefira(lang)](#OmerEvent+sefira) ⇒ <code>string</code>
     * [.render([locale])](#OmerEvent+render) ⇒ <code>string</code>
     * [.renderBrief([locale])](#OmerEvent+renderBrief) ⇒ <code>string</code>
     * [.getEmoji()](#OmerEvent+getEmoji) ⇒ <code>string</code>
     * [.getWeeks()](#OmerEvent+getWeeks) ⇒ <code>number</code>
     * [.getDaysWithinWeeks()](#OmerEvent+getDaysWithinWeeks) ⇒ <code>number</code>
     * [.getTodayIs(locale)](#OmerEvent+getTodayIs) ⇒ <code>string</code>
+    * [.url()](#OmerEvent+url) ⇒ <code>string</code>
 
 <a name="new_OmerEvent_new"></a>
 
@@ -1839,6 +1849,15 @@ Represents a day 1-49 of counting the Omer from Pesach to Shavuot
 | date | [<code>HDate</code>](#HDate) | 
 | omerDay | <code>number</code> | 
 
+<a name="OmerEvent+sefira"></a>
+
+### omerEvent.sefira(lang) ⇒ <code>string</code>
+**Kind**: instance method of [<code>OmerEvent</code>](#OmerEvent)  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| lang | <code>string</code> | <code>&quot;en&quot;</code> | 
+
 <a name="OmerEvent+render"></a>
 
 ### omerEvent.render([locale]) ⇒ <code>string</code>
@@ -1855,7 +1874,7 @@ Represents a day 1-49 of counting the Omer from Pesach to Shavuot
 <a name="OmerEvent+renderBrief"></a>
 
 ### omerEvent.renderBrief([locale]) ⇒ <code>string</code>
-Returns translation of "Omer 22" without ordinal numbers.
+Returns translation of "Omer day 22" without ordinal numbers.
 
 **Kind**: instance method of [<code>OmerEvent</code>](#OmerEvent)  
 
@@ -1884,6 +1903,10 @@ Returns translation of "Omer 22" without ordinal numbers.
 | --- | --- |
 | locale | <code>string</code> | 
 
+<a name="OmerEvent+url"></a>
+
+### omerEvent.url() ⇒ <code>string</code>
+**Kind**: instance method of [<code>OmerEvent</code>](#OmerEvent)  
 <a name="DafYomi"></a>
 
 ## DafYomi
@@ -2645,29 +2668,29 @@ Holiday flags for Event
 
 | Name | Type | Default | Description |
 | --- | --- | --- | --- |
-| CHAG | <code>number</code> | <code>CHAG$1</code> | Chag, yontiff, yom tov |
-| LIGHT_CANDLES | <code>number</code> | <code>LIGHT_CANDLES$2</code> | Light candles 18 minutes before sundown |
-| YOM_TOV_ENDS | <code>number</code> | <code>YOM_TOV_ENDS$2</code> | End of holiday (end of Yom Tov) |
-| CHUL_ONLY | <code>number</code> | <code>CHUL_ONLY$2</code> | Observed only in the Diaspora (chutz l'aretz) |
-| IL_ONLY | <code>number</code> | <code>IL_ONLY$2</code> | Observed only in Israel |
-| LIGHT_CANDLES_TZEIS | <code>number</code> | <code>LIGHT_CANDLES_TZEIS$2</code> | Light candles in the evening at Tzeit time (3 small stars) |
-| CHANUKAH_CANDLES | <code>number</code> | <code>CHANUKAH_CANDLES$2</code> | Candle-lighting for Chanukah |
-| ROSH_CHODESH | <code>number</code> | <code>ROSH_CHODESH$1</code> | Rosh Chodesh, beginning of a new Hebrew month |
-| MINOR_FAST | <code>number</code> | <code>MINOR_FAST$2</code> | Minor fasts like Tzom Tammuz, Ta'anit Esther, ... |
-| SPECIAL_SHABBAT | <code>number</code> | <code>SPECIAL_SHABBAT$2</code> | Shabbat Shekalim, Zachor, ... |
-| PARSHA_HASHAVUA | <code>number</code> | <code>PARSHA_HASHAVUA$1</code> | Weekly sedrot on Saturdays |
-| DAF_YOMI | <code>number</code> | <code>DAF_YOMI$1</code> | Daily page of Talmud |
-| OMER_COUNT | <code>number</code> | <code>OMER_COUNT$1</code> | Days of the Omer |
-| MODERN_HOLIDAY | <code>number</code> | <code>MODERN_HOLIDAY$2</code> | Yom HaShoah, Yom HaAtzma'ut, ... |
-| MAJOR_FAST | <code>number</code> | <code>MAJOR_FAST$2</code> | Yom Kippur and Tish'a B'Av |
-| SHABBAT_MEVARCHIM | <code>number</code> | <code>SHABBAT_MEVARCHIM$1</code> | On the Saturday before Rosh Chodesh |
-| MOLAD | <code>number</code> | <code>MOLAD</code> | Molad |
-| USER_EVENT | <code>number</code> | <code>USER_EVENT</code> | Yahrzeit or Hebrew Anniversary |
-| HEBREW_DATE | <code>number</code> | <code>HEBREW_DATE</code> | Daily Hebrew date ("11th of Sivan, 5780") |
-| MINOR_HOLIDAY | <code>number</code> | <code>MINOR_HOLIDAY$2</code> | A holiday that's not major, modern, rosh chodesh, or a fast day |
-| EREV | <code>number</code> | <code>EREV$2</code> | Evening before a major or minor holiday |
-| CHOL_HAMOED | <code>number</code> | <code>CHOL_HAMOED$2</code> | Chol haMoed, intermediate days of Pesach or Sukkot |
-| MISHNA_YOMI | <code>number</code> | <code>MISHNA_YOMI</code> | Mishna Yomi |
+| CHAG | <code>number</code> | <code>1</code> | Chag, yontiff, yom tov |
+| LIGHT_CANDLES | <code>number</code> | <code>2</code> | Light candles 18 minutes before sundown |
+| YOM_TOV_ENDS | <code>number</code> | <code>4</code> | End of holiday (end of Yom Tov) |
+| CHUL_ONLY | <code>number</code> | <code>8</code> | Observed only in the Diaspora (chutz l'aretz) |
+| IL_ONLY | <code>number</code> | <code>16</code> | Observed only in Israel |
+| LIGHT_CANDLES_TZEIS | <code>number</code> | <code>32</code> | Light candles in the evening at Tzeit time (3 small stars) |
+| CHANUKAH_CANDLES | <code>number</code> | <code>64</code> | Candle-lighting for Chanukah |
+| ROSH_CHODESH | <code>number</code> | <code>128</code> | Rosh Chodesh, beginning of a new Hebrew month |
+| MINOR_FAST | <code>number</code> | <code>256</code> | Minor fasts like Tzom Tammuz, Ta'anit Esther, ... |
+| SPECIAL_SHABBAT | <code>number</code> | <code>512</code> | Shabbat Shekalim, Zachor, ... |
+| PARSHA_HASHAVUA | <code>number</code> | <code>1024</code> | Weekly sedrot on Saturdays |
+| DAF_YOMI | <code>number</code> | <code>2048</code> | Daily page of Talmud |
+| OMER_COUNT | <code>number</code> | <code>4096</code> | Days of the Omer |
+| MODERN_HOLIDAY | <code>number</code> | <code>8192</code> | Yom HaShoah, Yom HaAtzma'ut, ... |
+| MAJOR_FAST | <code>number</code> | <code>16384</code> | Yom Kippur and Tish'a B'Av |
+| SHABBAT_MEVARCHIM | <code>number</code> | <code>32768</code> | On the Saturday before Rosh Chodesh |
+| MOLAD | <code>number</code> | <code>65536</code> | Molad |
+| USER_EVENT | <code>number</code> | <code>131072</code> | Yahrzeit or Hebrew Anniversary |
+| HEBREW_DATE | <code>number</code> | <code>262144</code> | Daily Hebrew date ("11th of Sivan, 5780") |
+| MINOR_HOLIDAY | <code>number</code> | <code>524288</code> | A holiday that's not major, modern, rosh chodesh, or a fast day |
+| 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 |
 
 <a name="parshiot"></a>