@hebcal/core 3.33.3 → 3.33.6

package/README.md

@@ -46,6 +46,19 @@ for (const ev of events) {
 ## Classes
 
 <dl>
+<dt><a href="#greg">greg</a></dt>
+<dd><p>Gregorian date helper functions.</p>
+</dd>
+<dt><a href="#Locale">Locale</a></dt>
+<dd><p>A locale in Hebcal is used for translations/transliterations of
+holidays. <code>@hebcal/core</code> supports four locales by default</p>
+<ul>
+<li><code>en</code> - default, Sephardic transliterations (e.g. &quot;Shabbat&quot;)</li>
+<li><code>ashkenazi</code> - Ashkenazi transliterations (e.g. &quot;Shabbos&quot;)</li>
+<li><code>he</code> - Hebrew (e.g. &quot;שַׁבָּת&quot;)</li>
+<li><code>he-x-NoNikud</code> - Hebrew without nikud (e.g. &quot;שבת&quot;)</li>
+</ul>
+</dd>
 <dt><a href="#HDate">HDate</a></dt>
 <dd><p>Represents a Hebrew date</p>
 </dd>
@@ -111,23 +124,11 @@ each day in order to finish the entire Mishnah in ~6 years.</p>
 <dt><a href="#MishnaYomiEvent">MishnaYomiEvent</a></dt>
 <dd><p>Event wrapper around a Mishna Yomi instance</p>
 </dd>
-</dl>
-
-## Objects
-
-<dl>
-<dt><a href="#greg">greg</a> : <code>object</code></dt>
-<dd><p>Gregorian date helper functions.</p>
-</dd>
-<dt><a href="#Locale">Locale</a> : <code>object</code></dt>
-<dd><p>A locale in Hebcal is used for translations/transliterations of
-holidays. <code>@hebcal/core</code> supports four locales by default</p>
-<ul>
-<li><code>en</code> - default, Sephardic transliterations (e.g. &quot;Shabbat&quot;)</li>
-<li><code>ashkenazi</code> - Ashkenazi transliterations (e.g. &quot;Shabbos&quot;)</li>
-<li><code>he</code> - Hebrew (e.g. &quot;שַׁבָּת&quot;)</li>
-<li><code>he-x-NoNikud</code> - Hebrew without nikud (e.g. &quot;שבת&quot;)</li>
-</ul>
+<dt><a href="#HebrewCalendar">HebrewCalendar</a></dt>
+<dd><p>HebrewCalendar is the main interface to the <code>@hebcal/core</code> library.
+This namespace is used to calculate holidays, rosh chodesh, candle lighting &amp; havdalah times,
+Parashat HaShavua, Daf Yomi, days of the omer, and the molad.
+Event names can be rendered in several languges using the <code>locale</code> option.</p>
 </dd>
 </dl>
 
@@ -138,12 +139,6 @@ holidays. <code>@hebcal/core</code> supports four locales by default</p>
 <dd><p>The 54 parshiyot of the Torah as transilterated strings
 parshiot[0] == &#39;Bereshit&#39;, parshiot[1] == &#39;Noach&#39;, parshiot[53] == &quot;Ha&#39;Azinu&quot;.</p>
 </dd>
-<dt><a href="#HebrewCalendar">HebrewCalendar</a></dt>
-<dd><p>HebrewCalendar is the main interface to the <code>@hebcal/core</code> library.
-This namespace is used to calculate holidays, rosh chodesh, candle lighting &amp; havdalah times,
-Parashat HaShavua, Daf Yomi, days of the omer, and the molad.
-Event names can be rendered in several languges using the <code>locale</code> option.</p>
-</dd>
 </dl>
 
 ## Functions
@@ -165,10 +160,204 @@ we omit the thousands (which is presently 5 [ה]).</p>
 <dd><p>Result of Sedra.lookup</p>
 </dd>
 <dt><a href="#MishnaYomi">MishnaYomi</a> : <code>Object</code></dt>
+<dd><p>Describes a mishna to be read</p>
+</dd>
+<dt><a href="#CalOptions">CalOptions</a> : <code>Object</code></dt>
 <dd><p>Options to configure which events are returned</p>
 </dd>
 </dl>
 
+<a name="greg"></a>
+
+## greg
+Gregorian date helper functions.
+
+**Kind**: global class  
+
+* [greg](#greg)
+    * [.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>
+    * [.greg2abs(date)](#greg.greg2abs) ⇒ <code>number</code>
+    * [.abs2greg(theDate)](#greg.abs2greg) ⇒ <code>Date</code>
+
+<a name="greg.isLeapYear"></a>
+
+### greg.isLeapYear(year) ⇒ <code>boolean</code>
+Returns true if the Gregorian year is a leap year
+
+**Kind**: static method of [<code>greg</code>](#greg)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| year | <code>number</code> | Gregorian year |
+
+<a name="greg.daysInMonth"></a>
+
+### greg.daysInMonth(month, year) ⇒ <code>number</code>
+Number of days in the Gregorian month for given year
+
+**Kind**: static method of [<code>greg</code>](#greg)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| month | <code>number</code> | Gregorian month (1=January, 12=December) |
+| year | <code>number</code> | Gregorian year |
+
+<a name="greg.isDate"></a>
+
+### greg.isDate(obj) ⇒ <code>boolean</code>
+Returns true if the object is a Javascript Date
+
+**Kind**: static method of [<code>greg</code>](#greg)  
+
+| Param | Type |
+| --- | --- |
+| obj | <code>Object</code> | 
+
+<a name="greg.dayOfYear"></a>
+
+### greg.dayOfYear(date) ⇒ <code>number</code>
+Returns number of days since January 1 of that year
+
+**Kind**: static method of [<code>greg</code>](#greg)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| date | <code>Date</code> | Gregorian date |
+
+<a name="greg.greg2abs"></a>
+
+### greg.greg2abs(date) ⇒ <code>number</code>
+Converts Gregorian date to absolute R.D. (Rata Die) days
+
+**Kind**: static method of [<code>greg</code>](#greg)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| date | <code>Date</code> | Gregorian date |
+
+<a name="greg.abs2greg"></a>
+
+### greg.abs2greg(theDate) ⇒ <code>Date</code>
+Converts from Rata Die (R.D. number) to Gregorian date.
+See the footnote on page 384 of ``Calendrical Calculations, Part II:
+Three Historical Calendars'' by E. M. Reingold,  N. Dershowitz, and S. M.
+Clamen, Software--Practice and Experience, Volume 23, Number 4
+(April, 1993), pages 383-404 for an explanation.
+
+**Kind**: static method of [<code>greg</code>](#greg)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| theDate | <code>number</code> | R.D. number of days |
+
+<a name="Locale"></a>
+
+## Locale
+A locale in Hebcal is used for translations/transliterations of
+holidays. `@hebcal/core` supports four locales by default
+* `en` - default, Sephardic transliterations (e.g. "Shabbat")
+* `ashkenazi` - Ashkenazi transliterations (e.g. "Shabbos")
+* `he` - Hebrew (e.g. "שַׁבָּת")
+* `he-x-NoNikud` - Hebrew without nikud (e.g. "שבת")
+
+**Kind**: global class  
+
+* [Locale](#Locale)
+    * [.lookupTranslation(id, [locale])](#Locale.lookupTranslation) ⇒ <code>string</code>
+    * [.gettext(id, [locale])](#Locale.gettext) ⇒ <code>string</code>
+    * [.addLocale(locale, data)](#Locale.addLocale)
+    * [.useLocale(locale)](#Locale.useLocale) ⇒ <code>LocaleData</code>
+    * [.getLocaleName()](#Locale.getLocaleName) ⇒ <code>string</code>
+    * [.getLocaleNames()](#Locale.getLocaleNames) ⇒ <code>Array.&lt;string&gt;</code>
+    * [.ordinal(n, [locale])](#Locale.ordinal) ⇒ <code>string</code>
+    * [.hebrewStripNikkud(str)](#Locale.hebrewStripNikkud) ⇒ <code>string</code>
+
+<a name="Locale.lookupTranslation"></a>
+
+### Locale.lookupTranslation(id, [locale]) ⇒ <code>string</code>
+Returns translation only if `locale` offers a non-empty translation for `id`.
+Otherwise, returns `undefined`.
+
+**Kind**: static method of [<code>Locale</code>](#Locale)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| id | <code>string</code> | Message ID to translate |
+| [locale] | <code>string</code> | Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale. |
+
+<a name="Locale.gettext"></a>
+
+### Locale.gettext(id, [locale]) ⇒ <code>string</code>
+By default, if no translation was found, returns `id`.
+
+**Kind**: static method of [<code>Locale</code>](#Locale)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| id | <code>string</code> | Message ID to translate |
+| [locale] | <code>string</code> | Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale. |
+
+<a name="Locale.addLocale"></a>
+
+### Locale.addLocale(locale, data)
+Register locale translations.
+
+**Kind**: static method of [<code>Locale</code>](#Locale)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| locale | <code>string</code> | Locale name (i.e.: `'he'`, `'fr'`) |
+| data | <code>LocaleDate</code> | parsed data from a `.po` file. |
+
+<a name="Locale.useLocale"></a>
+
+### Locale.useLocale(locale) ⇒ <code>LocaleData</code>
+Activates a locale. Throws an error if the locale has not been previously added.
+After setting the locale to be used, all strings marked for translations
+will be represented by the corresponding translation in the specified locale.
+
+**Kind**: static method of [<code>Locale</code>](#Locale)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| locale | <code>string</code> | Locale name (i.e: `'he'`, `'fr'`) |
+
+<a name="Locale.getLocaleName"></a>
+
+### Locale.getLocaleName() ⇒ <code>string</code>
+Returns the name of the active locale (i.e. 'he', 'ashkenazi', 'fr')
+
+**Kind**: static method of [<code>Locale</code>](#Locale)  
+<a name="Locale.getLocaleNames"></a>
+
+### Locale.getLocaleNames() ⇒ <code>Array.&lt;string&gt;</code>
+Returns the names of registered locales
+
+**Kind**: static method of [<code>Locale</code>](#Locale)  
+<a name="Locale.ordinal"></a>
+
+### Locale.ordinal(n, [locale]) ⇒ <code>string</code>
+**Kind**: static method of [<code>Locale</code>](#Locale)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| n | <code>number</code> |  |
+| [locale] | <code>string</code> | Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale. |
+
+<a name="Locale.hebrewStripNikkud"></a>
+
+### Locale.hebrewStripNikkud(str) ⇒ <code>string</code>
+Removes nekudot from Hebrew string
+
+**Kind**: static method of [<code>Locale</code>](#Locale)  
+
+| Param | Type |
+| --- | --- |
+| str | <code>string</code> | 
+
 <a name="HDate"></a>
 
 ## HDate
@@ -347,7 +536,7 @@ Renders this Hebrew date in Hebrew gematriya, regardless of locale.
 ```js
 import {HDate, months} from '@hebcal/core';
 const hd = new HDate(15, months.CHESHVAN, 5769);
-console.log(ev.renderGematriya()); // 'ט״ו חֶשְׁוָן תשס״ט'
+console.log(hd.renderGematriya()); // 'ט״ו חֶשְׁוָן תשס״ט'
 ```
 <a name="HDate+before"></a>
 
@@ -2087,303 +2276,35 @@ Returns Mishna Yomi name (e.g. "Bava Metzia 10:5-6" or "Berakhot 9:5-Peah 1:1").
 Returns a link to sefaria.org
 
 **Kind**: instance method of [<code>MishnaYomiEvent</code>](#MishnaYomiEvent)  
-<a name="greg"></a>
+<a name="HebrewCalendar"></a>
 
-## greg : <code>object</code>
-Gregorian date helper functions.
+## HebrewCalendar
+HebrewCalendar is the main interface to the `@hebcal/core` library.
+This namespace is used to calculate holidays, rosh chodesh, candle lighting & havdalah times,
+Parashat HaShavua, Daf Yomi, days of the omer, and the molad.
+Event names can be rendered in several languges using the `locale` option.
 
-**Kind**: global namespace  
+**Kind**: global class  
 
-* [greg](#greg) : <code>object</code>
-    * [.monthNames](#greg.monthNames) : <code>Array.&lt;string&gt;</code>
-    * [.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>
-    * [.greg2abs(date)](#greg.greg2abs) ⇒ <code>number</code>
-    * [.abs2greg(theDate)](#greg.abs2greg) ⇒ <code>Date</code>
+* [HebrewCalendar](#HebrewCalendar)
+    * [.calendar([options])](#HebrewCalendar.calendar) ⇒ [<code>Array.&lt;Event&gt;</code>](#Event)
+    * [.getBirthdayOrAnniversary(hyear, gdate)](#HebrewCalendar.getBirthdayOrAnniversary) ⇒ [<code>HDate</code>](#HDate)
+    * [.getYahrzeit(hyear, gdate)](#HebrewCalendar.getYahrzeit) ⇒ [<code>HDate</code>](#HDate)
+    * [.getHolidaysForYear(year)](#HebrewCalendar.getHolidaysForYear) ⇒ <code>Map.&lt;string, Array.&lt;Event&gt;&gt;</code>
+    * [.getHolidaysForYearArray(year, il)](#HebrewCalendar.getHolidaysForYearArray) ⇒ [<code>Array.&lt;Event&gt;</code>](#Event)
+    * [.getHolidaysOnDate(date, [il])](#HebrewCalendar.getHolidaysOnDate) ⇒ [<code>Array.&lt;Event&gt;</code>](#Event)
+    * [.reformatTimeStr(timeStr, suffix, options)](#HebrewCalendar.reformatTimeStr) ⇒ <code>string</code>
+    * [.version()](#HebrewCalendar.version) ⇒ <code>string</code>
+    * [.getSedra(hyear, il)](#HebrewCalendar.getSedra) ⇒ [<code>Sedra</code>](#Sedra)
 
-<a name="greg.monthNames"></a>
+<a name="HebrewCalendar.calendar"></a>
 
-### greg.monthNames : <code>Array.&lt;string&gt;</code>
-Long names of the Gregorian months (1='January', 12='December')
+### HebrewCalendar.calendar([options]) ⇒ [<code>Array.&lt;Event&gt;</code>](#Event)
+Calculates holidays and other Hebrew calendar events based on [CalOptions](#CalOptions).
 
-**Kind**: static property of [<code>greg</code>](#greg)  
-**Read only**: true  
-<a name="greg.isLeapYear"></a>
-
-### greg.isLeapYear(year) ⇒ <code>boolean</code>
-Returns true if the Gregorian year is a leap year
-
-**Kind**: static method of [<code>greg</code>](#greg)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| year | <code>number</code> | Gregorian year |
-
-<a name="greg.daysInMonth"></a>
-
-### greg.daysInMonth(month, year) ⇒ <code>number</code>
-Number of days in the Gregorian month for given year
-
-**Kind**: static method of [<code>greg</code>](#greg)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| month | <code>number</code> | Gregorian month (1=January, 12=December) |
-| year | <code>number</code> | Gregorian year |
-
-<a name="greg.isDate"></a>
-
-### greg.isDate(obj) ⇒ <code>boolean</code>
-Returns true if the object is a Javascript Date
-
-**Kind**: static method of [<code>greg</code>](#greg)  
-
-| Param | Type |
-| --- | --- |
-| obj | <code>Object</code> | 
-
-<a name="greg.dayOfYear"></a>
-
-### greg.dayOfYear(date) ⇒ <code>number</code>
-Returns number of days since January 1 of that year
-
-**Kind**: static method of [<code>greg</code>](#greg)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| date | <code>Date</code> | Gregorian date |
-
-<a name="greg.greg2abs"></a>
-
-### greg.greg2abs(date) ⇒ <code>number</code>
-Converts Gregorian date to absolute R.D. (Rata Die) days
-
-**Kind**: static method of [<code>greg</code>](#greg)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| date | <code>Date</code> | Gregorian date |
-
-<a name="greg.abs2greg"></a>
-
-### greg.abs2greg(theDate) ⇒ <code>Date</code>
-Converts from Rata Die (R.D. number) to Gregorian date.
-See the footnote on page 384 of ``Calendrical Calculations, Part II:
-Three Historical Calendars'' by E. M. Reingold,  N. Dershowitz, and S. M.
-Clamen, Software--Practice and Experience, Volume 23, Number 4
-(April, 1993), pages 383-404 for an explanation.
-
-**Kind**: static method of [<code>greg</code>](#greg)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| theDate | <code>number</code> | R.D. number of days |
-
-<a name="Locale"></a>
-
-## Locale : <code>object</code>
-A locale in Hebcal is used for translations/transliterations of
-holidays. `@hebcal/core` supports four locales by default
-* `en` - default, Sephardic transliterations (e.g. "Shabbat")
-* `ashkenazi` - Ashkenazi transliterations (e.g. "Shabbos")
-* `he` - Hebrew (e.g. "שַׁבָּת")
-* `he-x-NoNikud` - Hebrew without nikud (e.g. "שבת")
-
-**Kind**: global namespace  
-
-* [Locale](#Locale) : <code>object</code>
-    * [.lookupTranslation(id, [locale])](#Locale.lookupTranslation) ⇒ <code>string</code>
-    * [.gettext(id, [locale])](#Locale.gettext) ⇒ <code>string</code>
-    * [.addLocale(locale, data)](#Locale.addLocale)
-    * [.useLocale(locale)](#Locale.useLocale) ⇒ <code>LocaleData</code>
-    * [.getLocaleName()](#Locale.getLocaleName) ⇒ <code>string</code>
-    * [.getLocaleNames()](#Locale.getLocaleNames) ⇒ <code>Array.&lt;string&gt;</code>
-    * [.ordinal(n, [locale])](#Locale.ordinal) ⇒ <code>string</code>
-    * [.hebrewStripNikkud(str)](#Locale.hebrewStripNikkud) ⇒ <code>string</code>
-
-<a name="Locale.lookupTranslation"></a>
-
-### Locale.lookupTranslation(id, [locale]) ⇒ <code>string</code>
-Returns translation only if `locale` offers a non-empty translation for `id`.
-Otherwise, returns `undefined`.
-
-**Kind**: static method of [<code>Locale</code>](#Locale)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| id | <code>string</code> | Message ID to translate |
-| [locale] | <code>string</code> | Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale. |
-
-<a name="Locale.gettext"></a>
-
-### Locale.gettext(id, [locale]) ⇒ <code>string</code>
-By default, if no translation was found, returns `id`.
-
-**Kind**: static method of [<code>Locale</code>](#Locale)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| id | <code>string</code> | Message ID to translate |
-| [locale] | <code>string</code> | Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale. |
-
-<a name="Locale.addLocale"></a>
-
-### Locale.addLocale(locale, data)
-Register locale translations.
-
-**Kind**: static method of [<code>Locale</code>](#Locale)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| locale | <code>string</code> | Locale name (i.e.: `'he'`, `'fr'`) |
-| data | <code>LocaleDate</code> | parsed data from a `.po` file. |
-
-<a name="Locale.useLocale"></a>
-
-### Locale.useLocale(locale) ⇒ <code>LocaleData</code>
-Activates a locale. Throws an error if the locale has not been previously added.
-After setting the locale to be used, all strings marked for translations
-will be represented by the corresponding translation in the specified locale.
-
-**Kind**: static method of [<code>Locale</code>](#Locale)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| locale | <code>string</code> | Locale name (i.e: `'he'`, `'fr'`) |
-
-<a name="Locale.getLocaleName"></a>
-
-### Locale.getLocaleName() ⇒ <code>string</code>
-Returns the name of the active locale (i.e. 'he', 'ashkenazi', 'fr')
-
-**Kind**: static method of [<code>Locale</code>](#Locale)  
-<a name="Locale.getLocaleNames"></a>
-
-### Locale.getLocaleNames() ⇒ <code>Array.&lt;string&gt;</code>
-Returns the names of registered locales
-
-**Kind**: static method of [<code>Locale</code>](#Locale)  
-<a name="Locale.ordinal"></a>
-
-### Locale.ordinal(n, [locale]) ⇒ <code>string</code>
-**Kind**: static method of [<code>Locale</code>](#Locale)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| n | <code>number</code> |  |
-| [locale] | <code>string</code> | Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale. |
-
-<a name="Locale.hebrewStripNikkud"></a>
-
-### Locale.hebrewStripNikkud(str) ⇒ <code>string</code>
-Removes nekudot from Hebrew string
-
-**Kind**: static method of [<code>Locale</code>](#Locale)  
-
-| Param | Type |
-| --- | --- |
-| str | <code>string</code> | 
-
-<a name="months"></a>
-
-## months : <code>enum</code>
-Hebrew months of the year (NISAN=1, TISHREI=7)
-
-**Kind**: global enum  
-**Read only**: true  
-**Properties**
-
-| Name | Type | Default | Description |
-| --- | --- | --- | --- |
-| NISAN | <code>number</code> | <code>1</code> | Nissan / ניסן |
-| IYYAR | <code>number</code> | <code>2</code> | Iyyar / אייר |
-| SIVAN | <code>number</code> | <code>3</code> | Sivan / סיון |
-| TAMUZ | <code>number</code> | <code>4</code> | Tamuz (sometimes Tammuz) / תמוז |
-| AV | <code>number</code> | <code>5</code> | Av / אב |
-| ELUL | <code>number</code> | <code>6</code> | Elul / אלול |
-| TISHREI | <code>number</code> | <code>7</code> | Tishrei / תִשְׁרֵי |
-| CHESHVAN | <code>number</code> | <code>8</code> | Cheshvan / חשון |
-| KISLEV | <code>number</code> | <code>9</code> | Kislev / כסלו |
-| TEVET | <code>number</code> | <code>10</code> | Tevet / טבת |
-| SHVAT | <code>number</code> | <code>11</code> | Sh'vat / שבט |
-| ADAR_I | <code>number</code> | <code>12</code> | Adar or Adar Rishon / אדר |
-| ADAR_II | <code>number</code> | <code>13</code> | Adar Sheini (only on leap years) / אדר ב׳ |
-
-<a name="flags"></a>
-
-## flags : <code>enum</code>
-Holiday flags for Event
-
-**Kind**: global enum  
-**Read only**: true  
-**Properties**
-
-| 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 |
-
-<a name="parshiot"></a>
-
-## parshiot : <code>Array.&lt;string&gt;</code>
-The 54 parshiyot of the Torah as transilterated strings
-parshiot[0] == 'Bereshit', parshiot[1] == 'Noach', parshiot[53] == "Ha'Azinu".
-
-**Kind**: global constant  
-**Read only**: true  
-<a name="HebrewCalendar"></a>
-
-## HebrewCalendar
-HebrewCalendar is the main interface to the `@hebcal/core` library.
-This namespace is used to calculate holidays, rosh chodesh, candle lighting & havdalah times,
-Parashat HaShavua, Daf Yomi, days of the omer, and the molad.
-Event names can be rendered in several languges using the `locale` option.
-
-**Kind**: global constant  
-
-* [HebrewCalendar](#HebrewCalendar)
-    * [.calendar([options])](#HebrewCalendar.calendar) ⇒ [<code>Array.&lt;Event&gt;</code>](#Event)
-    * [.getBirthdayOrAnniversary(hyear, gdate)](#HebrewCalendar.getBirthdayOrAnniversary) ⇒ [<code>HDate</code>](#HDate)
-    * [.getYahrzeit(hyear, gdate)](#HebrewCalendar.getYahrzeit) ⇒ [<code>HDate</code>](#HDate)
-    * [.getHolidaysForYear(year)](#HebrewCalendar.getHolidaysForYear) ⇒ <code>Map.&lt;string, Array.&lt;Event&gt;&gt;</code>
-    * [.getHolidaysForYearArray(year, il)](#HebrewCalendar.getHolidaysForYearArray) ⇒ [<code>Array.&lt;Event&gt;</code>](#Event)
-    * [.getHolidaysOnDate(date, [il])](#HebrewCalendar.getHolidaysOnDate) ⇒ [<code>Array.&lt;Event&gt;</code>](#Event)
-    * [.reformatTimeStr(timeStr, suffix, options)](#HebrewCalendar.reformatTimeStr) ⇒ <code>string</code>
-    * [.version()](#HebrewCalendar.version) ⇒ <code>string</code>
-    * [.getSedra(hyear, il)](#HebrewCalendar.getSedra) ⇒ [<code>Sedra</code>](#Sedra)
-    * [.Options](#HebrewCalendar.Options) : <code>Object</code>
-
-<a name="HebrewCalendar.calendar"></a>
-
-### HebrewCalendar.calendar([options]) ⇒ [<code>Array.&lt;Event&gt;</code>](#Event)
-Calculates holidays and other Hebrew calendar events based on [Options](#HebrewCalendar.Options).
-
-Each holiday is represented by an [Event](#Event) object which includes a date,
-a description, flags and optional attributes.
-If given no options, returns holidays for the Diaspora for the current Gregorian year.
+Each holiday is represented by an [Event](#Event) object which includes a date,
+a description, flags and optional attributes.
+If given no options, returns holidays for the Diaspora for the current Gregorian year.
 
 The date range returned by this function can be controlled by:
 * `options.year` - Gregorian (e.g. 1993) or Hebrew year (e.g. 5749)
@@ -2463,7 +2384,7 @@ Additional locales (such as `ru` or `fr`) are supported by the
 
 | Param | Type | Default |
 | --- | --- | --- |
-| [options] | [<code>Options</code>](#HebrewCalendar.Options) | <code>{}</code> | 
+| [options] | [<code>CalOptions</code>](#CalOptions) | <code>{}</code> | 
 
 **Example**  
 ```js
@@ -2602,7 +2523,7 @@ Returns an array of Events on this date (or undefined if no events)
 
 ### HebrewCalendar.reformatTimeStr(timeStr, suffix, options) ⇒ <code>string</code>
 Helper function to format a 23-hour (00:00-23:59) time in US format ("8:13pm") or
-keep as "20:13" for any other locale/country. Uses `HebrewCalendar.Options` to determine
+keep as "20:13" for any other locale/country. Uses `CalOptions` to determine
 locale.
 
 **Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)  
@@ -2611,7 +2532,7 @@ locale.
 | --- | --- | --- |
 | timeStr | <code>string</code> | original time like "20:30" |
 | suffix | <code>string</code> | "p" or "pm" or " P.M.". Add leading space if you want it |
-| options | [<code>Options</code>](#HebrewCalendar.Options) |  |
+| options | [<code>CalOptions</code>](#CalOptions) |  |
 
 <a name="HebrewCalendar.version"></a>
 
@@ -2630,45 +2551,74 @@ created and cached instance.
 | hyear | <code>number</code> | 
 | il | <code>boolean</code> | 
 
-<a name="HebrewCalendar.Options"></a>
+<a name="months"></a>
 
-### HebrewCalendar.Options : <code>Object</code>
-Options to configure which events are returned
+## months : <code>enum</code>
+Hebrew months of the year (NISAN=1, TISHREI=7)
 
-**Kind**: static typedef of [<code>HebrewCalendar</code>](#HebrewCalendar)  
+**Kind**: global enum  
+**Read only**: true  
 **Properties**
 
-| Name | Type | Description |
-| --- | --- | --- |
-| location | [<code>Location</code>](#Location) | latitude/longitude/tzid used for candle-lighting |
-| year | <code>number</code> | Gregorian or Hebrew year |
-| isHebrewYear | <code>boolean</code> | to interpret year as Hebrew year |
-| month | <code>number</code> | Gregorian or Hebrew month (to filter results to a single month) |
-| numYears | <code>number</code> | generate calendar for multiple years (default 1) |
-| start | <code>Date</code> \| [<code>HDate</code>](#HDate) \| <code>number</code> | use specific start date (requires end date) |
-| end | <code>Date</code> \| [<code>HDate</code>](#HDate) \| <code>number</code> | use specific end date (requires start date) |
-| candlelighting | <code>boolean</code> | calculate candle-lighting and havdalah times |
-| candleLightingMins | <code>number</code> | minutes before sundown to light candles (default 18) |
-| havdalahMins | <code>number</code> | minutes after sundown for Havdalah (typical values are 42, 50, or 72).      If `undefined` (the default), calculate Havdalah according to Tzeit Hakochavim -      Nightfall (the point when 3 small stars are observable in the night time sky with      the naked eye). If `0`, Havdalah times are supressed. |
-| havdalahDeg | <code>number</code> | degrees for solar depression for Havdalah.      Default is 8.5 degrees for 3 small stars. use 7.083 degress for 3 medium-sized stars.      If `0`, Havdalah times are supressed. |
-| sedrot | <code>boolean</code> | calculate parashah hashavua on Saturdays |
-| il | <code>boolean</code> | Israeli holiday and sedra schedule |
-| noMinorFast | <code>boolean</code> | suppress minor fasts |
-| noModern | <code>boolean</code> | suppress modern holidays |
-| noRoshChodesh | <code>boolean</code> | suppress Rosh Chodesh |
-| shabbatMevarchim | <code>boolean</code> | add Shabbat Mevarchim |
-| noSpecialShabbat | <code>boolean</code> | suppress Special Shabbat |
-| noHolidays | <code>boolean</code> | suppress regular holidays |
-| dafyomi | <code>boolean</code> | include Daf Yomi |
-| mishnaYomi | <code>boolean</code> | include Mishna Yomi |
-| omer | <code>boolean</code> | include Days of the Omer |
-| molad | <code>boolean</code> | include event announcing the molad |
-| ashkenazi | <code>boolean</code> | use Ashkenazi transliterations for event titles (default Sephardi transliterations) |
-| locale | <code>string</code> | translate event titles according to a locale      Default value is `en`, also built-in are `he` and `ashkenazi`.      Additional locales (such as `ru` or `fr`) are provided by the      [@hebcal/locales](https://github.com/hebcal/hebcal-locales) package |
-| addHebrewDates | <code>boolean</code> | print the Hebrew date for the entire date range |
-| addHebrewDatesForEvents | <code>boolean</code> | print the Hebrew date for dates with some events |
-| mask | <code>number</code> | use bitmask from `flags` to filter events |
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| NISAN | <code>number</code> | <code>1</code> | Nissan / ניסן |
+| IYYAR | <code>number</code> | <code>2</code> | Iyyar / אייר |
+| SIVAN | <code>number</code> | <code>3</code> | Sivan / סיון |
+| TAMUZ | <code>number</code> | <code>4</code> | Tamuz (sometimes Tammuz) / תמוז |
+| AV | <code>number</code> | <code>5</code> | Av / אב |
+| ELUL | <code>number</code> | <code>6</code> | Elul / אלול |
+| TISHREI | <code>number</code> | <code>7</code> | Tishrei / תִשְׁרֵי |
+| CHESHVAN | <code>number</code> | <code>8</code> | Cheshvan / חשון |
+| KISLEV | <code>number</code> | <code>9</code> | Kislev / כסלו |
+| TEVET | <code>number</code> | <code>10</code> | Tevet / טבת |
+| SHVAT | <code>number</code> | <code>11</code> | Sh'vat / שבט |
+| ADAR_I | <code>number</code> | <code>12</code> | Adar or Adar Rishon / אדר |
+| ADAR_II | <code>number</code> | <code>13</code> | Adar Sheini (only on leap years) / אדר ב׳ |
+
+<a name="flags"></a>
+
+## flags : <code>enum</code>
+Holiday flags for Event
+
+**Kind**: global enum  
+**Read only**: true  
+**Properties**
+
+| 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 |
 
+<a name="parshiot"></a>
+
+## parshiot : <code>Array.&lt;string&gt;</code>
+The 54 parshiyot of the Torah as transilterated strings
+parshiot[0] == 'Bereshit', parshiot[1] == 'Noach', parshiot[53] == "Ha'Azinu".
+
+**Kind**: global constant  
+**Read only**: true  
 <a name="gematriya"></a>
 
 ## gematriya(number) ⇒ <code>string</code>
@@ -2733,7 +2683,7 @@ Result of Sedra.lookup
 <a name="MishnaYomi"></a>
 
 ## MishnaYomi : <code>Object</code>
-Options to configure which events are returned
+Describes a mishna to be read
 
 **Kind**: global typedef  
 **Properties**
@@ -2742,3 +2692,42 @@ Options to configure which events are returned
 | --- | --- | --- |
 | k | <code>string</code> | tractate name in Sephardic transliteration (e.g. "Berakhot", "Moed Katan") |
 | v | <code>string</code> | verse (e.g. "2:1") |
+
+<a name="CalOptions"></a>
+
+## CalOptions : <code>Object</code>
+Options to configure which events are returned
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| location | [<code>Location</code>](#Location) | latitude/longitude/tzid used for candle-lighting |
+| year | <code>number</code> | Gregorian or Hebrew year |
+| isHebrewYear | <code>boolean</code> | to interpret year as Hebrew year |
+| month | <code>number</code> | Gregorian or Hebrew month (to filter results to a single month) |
+| numYears | <code>number</code> | generate calendar for multiple years (default 1) |
+| start | <code>Date</code> \| [<code>HDate</code>](#HDate) \| <code>number</code> | use specific start date (requires end date) |
+| end | <code>Date</code> \| [<code>HDate</code>](#HDate) \| <code>number</code> | use specific end date (requires start date) |
+| candlelighting | <code>boolean</code> | calculate candle-lighting and havdalah times |
+| candleLightingMins | <code>number</code> | minutes before sundown to light candles (default 18) |
+| havdalahMins | <code>number</code> | minutes after sundown for Havdalah (typical values are 42, 50, or 72).      If `undefined` (the default), calculate Havdalah according to Tzeit Hakochavim -      Nightfall (the point when 3 small stars are observable in the night time sky with      the naked eye). If `0`, Havdalah times are supressed. |
+| havdalahDeg | <code>number</code> | degrees for solar depression for Havdalah.      Default is 8.5 degrees for 3 small stars. use 7.083 degress for 3 medium-sized stars.      If `0`, Havdalah times are supressed. |
+| sedrot | <code>boolean</code> | calculate parashah hashavua on Saturdays |
+| il | <code>boolean</code> | Israeli holiday and sedra schedule |
+| noMinorFast | <code>boolean</code> | suppress minor fasts |
+| noModern | <code>boolean</code> | suppress modern holidays |
+| noRoshChodesh | <code>boolean</code> | suppress Rosh Chodesh |
+| shabbatMevarchim | <code>boolean</code> | add Shabbat Mevarchim |
+| noSpecialShabbat | <code>boolean</code> | suppress Special Shabbat |
+| noHolidays | <code>boolean</code> | suppress regular holidays |
+| dafyomi | <code>boolean</code> | include Daf Yomi |
+| mishnaYomi | <code>boolean</code> | include Mishna Yomi |
+| omer | <code>boolean</code> | include Days of the Omer |
+| molad | <code>boolean</code> | include event announcing the molad |
+| ashkenazi | <code>boolean</code> | use Ashkenazi transliterations for event titles (default Sephardi transliterations) |
+| locale | <code>string</code> | translate event titles according to a locale      Default value is `en`, also built-in are `he` and `ashkenazi`.      Additional locales (such as `ru` or `fr`) are provided by the      [@hebcal/locales](https://github.com/hebcal/hebcal-locales) package |
+| addHebrewDates | <code>boolean</code> | print the Hebrew date for the entire date range |
+| addHebrewDatesForEvents | <code>boolean</code> | print the Hebrew date for dates with some events |
+| mask | <code>number</code> | use bitmask from `flags` to filter events |