@hebcal/core 3.33.1 → 3.33.4

package/README.md

@@ -14,7 +14,7 @@ by similar functionality written in Emacs Lisp. The initial JavaScript port was
 by Michael J. Radwin. `@hebcal/core` targets both
 browser-based JavaScript and server-side Node.js.
 
-Many users of this library will utilize the [HebrewCalendar.calendar()](#HebrewCalendar.calendar)
+Many users of this library will utilize the [HebrewCalendar](#HebrewCalendar)
 and [HDate](#HDate) interfaces.
 
 ## Installation
@@ -111,6 +111,12 @@ 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>
+<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>
 
 ## Objects
@@ -138,12 +144,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,7 +165,7 @@ 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>Options to configure which events are returned</p>
+<dd><p>Describes a mishna to be read</p>
 </dd>
 </dl>
 
@@ -347,7 +347,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,129 +2087,444 @@ 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>
-
-## greg : <code>object</code>
-Gregorian date helper functions.
+<a name="HebrewCalendar"></a>
 
-**Kind**: global namespace  
+## 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.
 
-* [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>
+**Kind**: global class  
 
-<a name="greg.monthNames"></a>
+* [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>
 
-### greg.monthNames : <code>Array.&lt;string&gt;</code>
-Long names of the Gregorian months (1='January', 12='December')
+<a name="HebrewCalendar.calendar"></a>
 
-**Kind**: static property of [<code>greg</code>](#greg)  
-**Read only**: true  
-<a name="greg.isLeapYear"></a>
+### HebrewCalendar.calendar([options]) ⇒ [<code>Array.&lt;Event&gt;</code>](#Event)
+Calculates holidays and other Hebrew calendar events based on [Options](#HebrewCalendar.Options).
 
-### greg.isLeapYear(year) ⇒ <code>boolean</code>
-Returns true if the Gregorian year is a leap 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.
 
-**Kind**: static method of [<code>greg</code>](#greg)  
+The date range returned by this function can be controlled by:
+* `options.year` - Gregorian (e.g. 1993) or Hebrew year (e.g. 5749)
+* `options.isHebrewYear` - to interpret `year` as Hebrew year
+* `options.numYears` - generate calendar for multiple years (default 1)
+* `options.month` - Gregorian or Hebrew month (to filter results to a single month)
 
-| Param | Type | Description |
-| --- | --- | --- |
-| year | <code>number</code> | Gregorian year |
+Alternatively, specify start and end days with `Date` or [HDate](#HDate) instances:
+* `options.start` - use specific start date (requires `end` date)
+* `options.end` - use specific end date (requires `start` date)
 
-<a name="greg.daysInMonth"></a>
+Unless `options.noHolidays == true`, default holidays include:
+* Major holidays - Rosh Hashana, Yom Kippur, Pesach, Sukkot, etc.
+* Minor holidays - Purim, Chanukah, Tu BiShvat, Lag BaOmer, etc.
+* Minor fasts - Ta'anit Esther, Tzom Gedaliah, etc. (unless `options.noMinorFast`)
+* Special Shabbatot - Shabbat Shekalim, Zachor, etc. (unless `options.noSpecialShabbat`)
+* Modern Holidays - Yom HaShoah, Yom HaAtzma'ut, etc. (unless `options.noModern`)
+* Rosh Chodesh (unless `options.noRoshChodesh`)
 
-### greg.daysInMonth(month, year) ⇒ <code>number</code>
-Number of days in the Gregorian month for given year
+Holiday and Torah reading schedules differ between Israel and the Disapora.
+Set `options.il=true` to use the Israeli schedule.
 
-**Kind**: static method of [<code>greg</code>](#greg)  
+Additional non-default event types can be specified:
+* Parashat HaShavua - weekly Torah Reading on Saturdays (`options.sedrot`)
+* Counting of the Omer (`options.omer`)
+* Daf Yomi (`options.dafyomi`)
+* Mishna Yomi (`options.mishnaYomi`)
+* Shabbat Mevarchim HaChodesh on Saturday before Rosh Chodesh (`options.shabbatMevarchim`)
+* Molad announcement on Saturday before Rosh Chodesh (`options.molad`)
 
-| Param | Type | Description |
-| --- | --- | --- |
-| month | <code>number</code> | Gregorian month (1=January, 12=December) |
-| year | <code>number</code> | Gregorian year |
+Candle-lighting and Havdalah times are approximated using latitude and longitude
+specified by the [Location](#Location) class. The `Location` class contains a small
+database of cities with their associated geographic information and time-zone information.
+If you ever have any doubts about Hebcal's times, consult your local halachic authority.
+If you enter geographic coordinates above the arctic circle or antarctic circle,
+the times are guaranteed to be wrong.
 
-<a name="greg.isDate"></a>
+To add candle-lighting options, set `options.candlelighting=true` and set
+`options.location` to an instance of `Location`. By default, candle lighting
+time is 18 minutes before sundown (40 minutes for Jerusalem) and Havdalah is
+calculated according to Tzeit Hakochavim - Nightfall (the point when 3 small stars
+are observable in the night time sky with the naked eye). The default Havdalah
+option (Tzeit Hakochavim) is calculated when the sun is 8.5° below the horizon.
+These defaults can be changed using these options:
+* `options.candleLightingMins` - minutes before sundown to light candles
+* `options.havdalahMins` - minutes after sundown for Havdalah (typical values are 42, 50, or 72).
+   Havdalah times are supressed when `options.havdalahMins=0`.
+* `options.havdalahDeg` - degrees for solar depression for Havdalah.
+   Default is 8.5 degrees for 3 small stars. Use 7.083 degress for 3 medium-sized stars.
+   Havdalah times are supressed when `options.havdalahDeg=0`.
 
-### greg.isDate(obj) ⇒ <code>boolean</code>
-Returns true if the object is a Javascript Date
+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)
+on weekdays, at regular candle-lighting time on Fridays, and at regular Havdalah time on
+Saturday night (see above).
 
-**Kind**: static method of [<code>greg</code>](#greg)  
+Minor fasts begin at Alot HaShachar (sun is 16.1° below the horizon in the morning) and
+end when 3 medium-sized stars are observable in the night sky (sun is 7.083° below the horizon
+in the evening).
 
-| Param | Type |
-| --- | --- |
-| obj | <code>Object</code> | 
+Two options also exist for generating an Event with the Hebrew date:
+* `options.addHebrewDates` - print the Hebrew date for the entire date range
+* `options.addHebrewDatesForEvents` - print the Hebrew date for dates with some events
 
-<a name="greg.dayOfYear"></a>
+Lastly, translation and transliteration of event titles is controlled by
+`options.locale` and the [Locale](#Locale) API.
+`@hebcal/core` supports three locales by default:
+* `en` - default, Sephardic transliterations (e.g. "Shabbat")
+* `ashkenazi` - Ashkenazi transliterations (e.g. "Shabbos")
+* `he` - Hebrew (e.g. "שַׁבָּת")
 
-### greg.dayOfYear(date) ⇒ <code>number</code>
-Returns number of days since January 1 of that year
+Additional locales (such as `ru` or `fr`) are supported by the
+[@hebcal/locales](https://github.com/hebcal/hebcal-locales) package
 
-**Kind**: static method of [<code>greg</code>](#greg)  
+**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)  
 
-| Param | Type | Description |
+| Param | Type | Default |
 | --- | --- | --- |
-| date | <code>Date</code> | Gregorian date |
-
-<a name="greg.greg2abs"></a>
+| [options] | [<code>Options</code>](#HebrewCalendar.Options) | <code>{}</code> | 
 
-### greg.greg2abs(date) ⇒ <code>number</code>
-Converts Gregorian date to absolute R.D. (Rata Die) days
+**Example**  
+```js
+import {HebrewCalendar, HDate, Location, Event} from '@hebcal/core';
+const options = {
+  year: 1981,
+  isHebrewYear: false,
+  candlelighting: true,
+  location: Location.lookup('San Francisco'),
+  sedrot: true,
+  omer: true,
+};
+const events = HebrewCalendar.calendar(options);
+for (const ev of events) {
+  const hd = ev.getDate();
+  const date = hd.greg();
+  console.log(date.toLocaleDateString(), ev.render(), hd.toString());
+}
+```
+<a name="HebrewCalendar.getBirthdayOrAnniversary"></a>
 
-**Kind**: static method of [<code>greg</code>](#greg)  
+### HebrewCalendar.getBirthdayOrAnniversary(hyear, gdate) ⇒ [<code>HDate</code>](#HDate)
+Calculates a birthday or anniversary (non-yahrzeit).
+`hyear` must be after original `gdate` of anniversary.
+Returns `undefined` when requested year preceeds or is same as original year.
 
-| Param | Type | Description |
-| --- | --- | --- |
-| date | <code>Date</code> | Gregorian date |
+Hebcal uses the algorithm defined in "Calendrical Calculations"
+by Edward M. Reingold and Nachum Dershowitz.
 
-<a name="greg.abs2greg"></a>
+The birthday of someone born in Adar of an ordinary year or Adar II of
+a leap year is also always in the last month of the year, be that Adar
+or Adar II. The birthday in an ordinary year of someone born during the
+first 29 days of Adar I in a leap year is on the corresponding day of Adar;
+in a leap year, the birthday occurs in Adar I, as expected.
 
-### 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.
+Someone born on the thirtieth day of Marcheshvan, Kislev, or Adar I
+has his birthday postponed until the first of the following month in
+years where that day does not occur. [Calendrical Calculations p. 111]
 
-**Kind**: static method of [<code>greg</code>](#greg)  
+**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)  
+**Returns**: [<code>HDate</code>](#HDate) - anniversary occurring in `hyear`  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| theDate | <code>number</code> | R.D. number of days |
+| hyear | <code>number</code> | Hebrew year |
+| gdate | <code>Date</code> \| [<code>HDate</code>](#HDate) | Gregorian or Hebrew date of event |
 
-<a name="Locale"></a>
+**Example**  
+```js
+import {HebrewCalendar} from '@hebcal/core';
+const dt = new Date(2014, 2, 2); // '2014-03-02' == '30 Adar I 5774'
+const hd = HebrewCalendar.getBirthdayOrAnniversary(5780, dt); // '1 Nisan 5780'
+console.log(hd.greg().toLocaleDateString('en-US')); // '3/26/2020'
+```
+<a name="HebrewCalendar.getYahrzeit"></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. "שבת")
+### HebrewCalendar.getYahrzeit(hyear, gdate) ⇒ [<code>HDate</code>](#HDate)
+Calculates yahrzeit.
+`hyear` must be after original `gdate` of death.
+Returns `undefined` when requested year preceeds or is same as original year.
 
-**Kind**: global namespace  
+Hebcal uses the algorithm defined in "Calendrical Calculations"
+by Edward M. Reingold and Nachum Dershowitz.
 
-* [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>
+The customary anniversary date of a death is more complicated and depends
+also on the character of the year in which the first anniversary occurs.
+There are several cases:
 
-<a name="Locale.lookupTranslation"></a>
+* If the date of death is Marcheshvan 30, the anniversary in general depends
+  on the first anniversary; if that first anniversary was not Marcheshvan 30,
+  use the day before Kislev 1.
+* If the date of death is Kislev 30, the anniversary in general again depends
+  on the first anniversary — if that was not Kislev 30, use the day before
+  Tevet 1.
+* If the date of death is Adar II, the anniversary is the same day in the
+  last month of the Hebrew year (Adar or Adar II).
+* If the date of death is Adar I 30, the anniversary in a Hebrew year that
+  is not a leap year (in which Adar only has 29 days) is the last day in
+  Shevat.
+* In all other cases, use the normal (that is, same month number) anniversary
+  of the date of death. [Calendrical Calculations p. 113]
 
-### 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>HebrewCalendar</code>](#HebrewCalendar)  
+**Returns**: [<code>HDate</code>](#HDate) - anniversary occurring in hyear  
 
-**Kind**: static method of [<code>Locale</code>](#Locale)  
+| Param | Type | Description |
+| --- | --- | --- |
+| hyear | <code>number</code> | Hebrew year |
+| gdate | <code>Date</code> \| [<code>HDate</code>](#HDate) | Gregorian or Hebrew date of death |
+
+**Example**  
+```js
+import {HebrewCalendar} from '@hebcal/core';
+const dt = new Date(2014, 2, 2); // '2014-03-02' == '30 Adar I 5774'
+const hd = HebrewCalendar.getYahrzeit(5780, dt); // '30 Sh\'vat 5780'
+console.log(hd.greg().toLocaleDateString('en-US')); // '2/25/2020'
+```
+<a name="HebrewCalendar.getHolidaysForYear"></a>
+
+### HebrewCalendar.getHolidaysForYear(year) ⇒ <code>Map.&lt;string, Array.&lt;Event&gt;&gt;</code>
+Lower-level holidays interface, which returns a `Map` of `Event`s indexed by
+`HDate.toString()`. These events must filtered especially for `flags.IL_ONLY`
+or `flags.CHUL_ONLY` depending on Israel vs. Diaspora holiday scheme.
+
+**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| year | <code>number</code> | Hebrew year |
+
+<a name="HebrewCalendar.getHolidaysForYearArray"></a>
+
+### HebrewCalendar.getHolidaysForYearArray(year, il) ⇒ [<code>Array.&lt;Event&gt;</code>](#Event)
+Returns an array of holidays for the year
+
+**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| year | <code>number</code> | Hebrew year |
+| il | <code>boolean</code> | use the Israeli schedule for holidays |
+
+<a name="HebrewCalendar.getHolidaysOnDate"></a>
+
+### HebrewCalendar.getHolidaysOnDate(date, [il]) ⇒ [<code>Array.&lt;Event&gt;</code>](#Event)
+Returns an array of Events on this date (or undefined if no events)
+
+**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| date | [<code>HDate</code>](#HDate) \| <code>Date</code> \| <code>number</code> | Hebrew Date, Gregorian date, or absolute R.D. day number |
+| [il] | <code>boolean</code> | use the Israeli schedule for holidays |
+
+<a name="HebrewCalendar.reformatTimeStr"></a>
+
+### 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
+locale.
+
+**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| 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) |  |
+
+<a name="HebrewCalendar.version"></a>
+
+### HebrewCalendar.version() ⇒ <code>string</code>
+**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)  
+<a name="HebrewCalendar.getSedra"></a>
+
+### HebrewCalendar.getSedra(hyear, il) ⇒ [<code>Sedra</code>](#Sedra)
+Convenience function to create an instance of `Sedra` or reuse a previously
+created and cached instance.
+
+**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)  
+
+| Param | Type |
+| --- | --- |
+| hyear | <code>number</code> | 
+| il | <code>boolean</code> | 
+
+<a name="HebrewCalendar.Options"></a>
+
+### HebrewCalendar.Options : <code>Object</code>
+Options to configure which events are returned
+
+**Kind**: static typedef of [<code>HebrewCalendar</code>](#HebrewCalendar)  
+**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 |
+
+<a name="greg"></a>
+
+## greg : <code>object</code>
+Gregorian date helper functions.
+
+**Kind**: global namespace  
+
+* [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>
+
+<a name="greg.monthNames"></a>
+
+### greg.monthNames : <code>Array.&lt;string&gt;</code>
+Long names of the Gregorian months (1='January', 12='December')
+
+**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 |
 | --- | --- | --- |
@@ -2354,328 +2669,13 @@ parshiot[0] == 'Bereshit', parshiot[1] == 'Noach', parshiot[53] == "Ha'Azinu".
 
 **Kind**: global constant  
 **Read only**: true  
-<a name="HebrewCalendar"></a>
+<a name="gematriya"></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.
+## gematriya(number) ⇒ <code>string</code>
+Converts a numerical value to a string of Hebrew letters.
 
-**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.
-
-The date range returned by this function can be controlled by:
-* `options.year` - Gregorian (e.g. 1993) or Hebrew year (e.g. 5749)
-* `options.isHebrewYear` - to interpret `year` as Hebrew year
-* `options.numYears` - generate calendar for multiple years (default 1)
-* `options.month` - Gregorian or Hebrew month (to filter results to a single month)
-
-Alternatively, specify start and end days with `Date` or [HDate](#HDate) instances:
-* `options.start` - use specific start date (requires `end` date)
-* `options.end` - use specific end date (requires `start` date)
-
-Unless `options.noHolidays == true`, default holidays include:
-* Major holidays - Rosh Hashana, Yom Kippur, Pesach, Sukkot, etc.
-* Minor holidays - Purim, Chanukah, Tu BiShvat, Lag BaOmer, etc.
-* Minor fasts - Ta'anit Esther, Tzom Gedaliah, etc. (unless `options.noMinorFast`)
-* Special Shabbatot - Shabbat Shekalim, Zachor, etc. (unless `options.noSpecialShabbat`)
-* Modern Holidays - Yom HaShoah, Yom HaAtzma'ut, etc. (unless `options.noModern`)
-* Rosh Chodesh (unless `options.noRoshChodesh`)
-
-Holiday and Torah reading schedules differ between Israel and the Disapora.
-Set `options.il=true` to use the Israeli schedule.
-
-Additional non-default event types can be specified:
-* Parashat HaShavua - weekly Torah Reading on Saturdays (`options.sedrot`)
-* Counting of the Omer (`options.omer`)
-* Daf Yomi (`options.dafyomi`)
-* Mishna Yomi (`options.mishnaYomi`)
-* Shabbat Mevarchim HaChodesh on Saturday before Rosh Chodesh (`options.shabbatMevarchim`)
-* Molad announcement on Saturday before Rosh Chodesh (`options.molad`)
-
-Candle-lighting and Havdalah times are approximated using latitude and longitude
-specified by the [Location](#Location) class. The `Location` class contains a small
-database of cities with their associated geographic information and time-zone information.
-If you ever have any doubts about Hebcal's times, consult your local halachic authority.
-If you enter geographic coordinates above the arctic circle or antarctic circle,
-the times are guaranteed to be wrong.
-
-To add candle-lighting options, set `options.candlelighting=true` and set
-`options.location` to an instance of `Location`. By default, candle lighting
-time is 18 minutes before sundown (40 minutes for Jerusalem) and Havdalah is
-calculated according to Tzeit Hakochavim - Nightfall (the point when 3 small stars
-are observable in the night time sky with the naked eye). The default Havdalah
-option (Tzeit Hakochavim) is calculated when the sun is 8.5° below the horizon.
-These defaults can be changed using these options:
-* `options.candleLightingMins` - minutes before sundown to light candles
-* `options.havdalahMins` - minutes after sundown for Havdalah (typical values are 42, 50, or 72).
-   Havdalah times are supressed when `options.havdalahMins=0`.
-* `options.havdalahDeg` - degrees for solar depression for Havdalah.
-   Default is 8.5 degrees for 3 small stars. Use 7.083 degress for 3 medium-sized stars.
-   Havdalah times are supressed when `options.havdalahDeg=0`.
-
-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)
-on weekdays, at regular candle-lighting time on Fridays, and at regular Havdalah time on
-Saturday night (see above).
-
-Minor fasts begin at Alot HaShachar (sun is 16.1° below the horizon in the morning) and
-end when 3 medium-sized stars are observable in the night sky (sun is 7.083° below the horizon
-in the evening).
-
-Two options also exist for generating an Event with the Hebrew date:
-* `options.addHebrewDates` - print the Hebrew date for the entire date range
-* `options.addHebrewDatesForEvents` - print the Hebrew date for dates with some events
-
-Lastly, translation and transliteration of event titles is controlled by
-`options.locale` and the [Locale](#Locale) API.
-`@hebcal/core` supports three locales by default:
-* `en` - default, Sephardic transliterations (e.g. "Shabbat")
-* `ashkenazi` - Ashkenazi transliterations (e.g. "Shabbos")
-* `he` - Hebrew (e.g. "שַׁבָּת")
-
-Additional locales (such as `ru` or `fr`) are supported by the
-[@hebcal/locales](https://github.com/hebcal/hebcal-locales) package
-
-**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)  
-
-| Param | Type | Default |
-| --- | --- | --- |
-| [options] | [<code>Options</code>](#HebrewCalendar.Options) | <code>{}</code> | 
-
-**Example**  
-```js
-import {HebrewCalendar, HDate, Location, Event} from '@hebcal/core';
-const options = {
-  year: 1981,
-  isHebrewYear: false,
-  candlelighting: true,
-  location: Location.lookup('San Francisco'),
-  sedrot: true,
-  omer: true,
-};
-const events = HebrewCalendar.calendar(options);
-for (const ev of events) {
-  const hd = ev.getDate();
-  const date = hd.greg();
-  console.log(date.toLocaleDateString(), ev.render(), hd.toString());
-}
-```
-<a name="HebrewCalendar.getBirthdayOrAnniversary"></a>
-
-### HebrewCalendar.getBirthdayOrAnniversary(hyear, gdate) ⇒ [<code>HDate</code>](#HDate)
-Calculates a birthday or anniversary (non-yahrzeit).
-`hyear` must be after original `gdate` of anniversary.
-Returns `undefined` when requested year preceeds or is same as original year.
-
-Hebcal uses the algorithm defined in "Calendrical Calculations"
-by Edward M. Reingold and Nachum Dershowitz.
-
-The birthday of someone born in Adar of an ordinary year or Adar II of
-a leap year is also always in the last month of the year, be that Adar
-or Adar II. The birthday in an ordinary year of someone born during the
-first 29 days of Adar I in a leap year is on the corresponding day of Adar;
-in a leap year, the birthday occurs in Adar I, as expected.
-
-Someone born on the thirtieth day of Marcheshvan, Kislev, or Adar I
-has his birthday postponed until the first of the following month in
-years where that day does not occur. [Calendrical Calculations p. 111]
-
-**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)  
-**Returns**: [<code>HDate</code>](#HDate) - anniversary occurring in `hyear`  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| hyear | <code>number</code> | Hebrew year |
-| gdate | <code>Date</code> \| [<code>HDate</code>](#HDate) | Gregorian or Hebrew date of event |
-
-**Example**  
-```js
-import {HebrewCalendar} from '@hebcal/core';
-const dt = new Date(2014, 2, 2); // '2014-03-02' == '30 Adar I 5774'
-const hd = HebrewCalendar.getBirthdayOrAnniversary(5780, dt); // '1 Nisan 5780'
-console.log(hd.greg().toLocaleDateString('en-US')); // '3/26/2020'
-```
-<a name="HebrewCalendar.getYahrzeit"></a>
-
-### HebrewCalendar.getYahrzeit(hyear, gdate) ⇒ [<code>HDate</code>](#HDate)
-Calculates yahrzeit.
-`hyear` must be after original `gdate` of death.
-Returns `undefined` when requested year preceeds or is same as original year.
-
-Hebcal uses the algorithm defined in "Calendrical Calculations"
-by Edward M. Reingold and Nachum Dershowitz.
-
-The customary anniversary date of a death is more complicated and depends
-also on the character of the year in which the first anniversary occurs.
-There are several cases:
-
-* If the date of death is Marcheshvan 30, the anniversary in general depends
-  on the first anniversary; if that first anniversary was not Marcheshvan 30,
-  use the day before Kislev 1.
-* If the date of death is Kislev 30, the anniversary in general again depends
-  on the first anniversary — if that was not Kislev 30, use the day before
-  Tevet 1.
-* If the date of death is Adar II, the anniversary is the same day in the
-  last month of the Hebrew year (Adar or Adar II).
-* If the date of death is Adar I 30, the anniversary in a Hebrew year that
-  is not a leap year (in which Adar only has 29 days) is the last day in
-  Shevat.
-* In all other cases, use the normal (that is, same month number) anniversary
-  of the date of death. [Calendrical Calculations p. 113]
-
-**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)  
-**Returns**: [<code>HDate</code>](#HDate) - anniversary occurring in hyear  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| hyear | <code>number</code> | Hebrew year |
-| gdate | <code>Date</code> \| [<code>HDate</code>](#HDate) | Gregorian or Hebrew date of death |
-
-**Example**  
-```js
-import {HebrewCalendar} from '@hebcal/core';
-const dt = new Date(2014, 2, 2); // '2014-03-02' == '30 Adar I 5774'
-const hd = HebrewCalendar.getYahrzeit(5780, dt); // '30 Sh\'vat 5780'
-console.log(hd.greg().toLocaleDateString('en-US')); // '2/25/2020'
-```
-<a name="HebrewCalendar.getHolidaysForYear"></a>
-
-### HebrewCalendar.getHolidaysForYear(year) ⇒ <code>Map.&lt;string, Array.&lt;Event&gt;&gt;</code>
-Lower-level holidays interface, which returns a `Map` of `Event`s indexed by
-`HDate.toString()`. These events must filtered especially for `flags.IL_ONLY`
-or `flags.CHUL_ONLY` depending on Israel vs. Diaspora holiday scheme.
-
-**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| year | <code>number</code> | Hebrew year |
-
-<a name="HebrewCalendar.getHolidaysForYearArray"></a>
-
-### HebrewCalendar.getHolidaysForYearArray(year, il) ⇒ [<code>Array.&lt;Event&gt;</code>](#Event)
-Returns an array of holidays for the year
-
-**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| year | <code>number</code> | Hebrew year |
-| il | <code>boolean</code> | use the Israeli schedule for holidays |
-
-<a name="HebrewCalendar.getHolidaysOnDate"></a>
-
-### HebrewCalendar.getHolidaysOnDate(date, [il]) ⇒ [<code>Array.&lt;Event&gt;</code>](#Event)
-Returns an array of Events on this date (or undefined if no events)
-
-**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| date | [<code>HDate</code>](#HDate) \| <code>Date</code> \| <code>number</code> | Hebrew Date, Gregorian date, or absolute R.D. day number |
-| [il] | <code>boolean</code> | use the Israeli schedule for holidays |
-
-<a name="HebrewCalendar.reformatTimeStr"></a>
-
-### 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
-locale.
-
-**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| 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) |  |
-
-<a name="HebrewCalendar.version"></a>
-
-### HebrewCalendar.version() ⇒ <code>string</code>
-**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)  
-<a name="HebrewCalendar.getSedra"></a>
-
-### HebrewCalendar.getSedra(hyear, il) ⇒ [<code>Sedra</code>](#Sedra)
-Convenience function to create an instance of `Sedra` or reuse a previously
-created and cached instance.
-
-**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)  
-
-| Param | Type |
-| --- | --- |
-| hyear | <code>number</code> | 
-| il | <code>boolean</code> | 
-
-<a name="HebrewCalendar.Options"></a>
-
-### HebrewCalendar.Options : <code>Object</code>
-Options to configure which events are returned
-
-**Kind**: static typedef of [<code>HebrewCalendar</code>](#HebrewCalendar)  
-**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 |
-
-<a name="gematriya"></a>
-
-## gematriya(number) ⇒ <code>string</code>
-Converts a numerical value to a string of Hebrew letters.
-
-When specifying years of the Hebrew calendar in the present millennium,
-we omit the thousands (which is presently 5 [ה]).
+When specifying years of the Hebrew calendar in the present millennium,
+we omit the thousands (which is presently 5 [ה]).
 
 **Kind**: global function  
 
@@ -2733,7 +2733,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**