@hebcal/core 5.4.3 → 5.4.4

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 CHANGED
@@ -61,9 +61,6 @@ holidays. <code>@hebcal/hdate</code> supports four locales by default</p>
61
61
  <dt><a href="#HDate">HDate</a></dt>
62
62
  <dd><p>Represents a Hebrew date</p>
63
63
  </dd>
64
- <dt><a href="#Sedra">Sedra</a></dt>
65
- <dd><p>Represents Parashah HaShavua for an entire Hebrew year</p>
66
- </dd>
67
64
  <dt><a href="#Event">Event</a></dt>
68
65
  <dd><p>Represents an Event with a title, date, and flags</p>
69
66
  </dd>
@@ -104,12 +101,12 @@ conditions, observed values may vary from calculations.
104
101
  <dt><a href="#TimedEvent">TimedEvent</a></dt>
105
102
  <dd><p>An event that has an <code>eventTime</code> and <code>eventTimeStr</code></p>
106
103
  </dd>
107
- <dt><a href="#HavdalahEvent">HavdalahEvent</a></dt>
108
- <dd><p>Havdalah after Shabbat or holiday</p>
109
- </dd>
110
104
  <dt><a href="#CandleLightingEvent">CandleLightingEvent</a></dt>
111
105
  <dd><p>Candle lighting before Shabbat or holiday</p>
112
106
  </dd>
107
+ <dt><a href="#HavdalahEvent">HavdalahEvent</a></dt>
108
+ <dd><p>Havdalah after Shabbat or holiday</p>
109
+ </dd>
113
110
  <dt><a href="#Molad">Molad</a></dt>
114
111
  <dd><p>Represents a molad, the moment when the new moon is &quot;born&quot;</p>
115
112
  </dd>
@@ -119,19 +116,22 @@ conditions, observed values may vary from calculations.
119
116
  <dt><a href="#OmerEvent">OmerEvent</a></dt>
120
117
  <dd><p>Represents a day 1-49 of counting the Omer from Pesach to Shavuot</p>
121
118
  </dd>
119
+ <dt><a href="#Sedra">Sedra</a></dt>
120
+ <dd><p>Represents Parashah HaShavua for an entire Hebrew year</p>
121
+ </dd>
122
122
  <dt><a href="#ParshaEvent">ParshaEvent</a></dt>
123
123
  <dd><p>Represents one of 54 weekly Torah portions, always on a Saturday</p>
124
124
  </dd>
125
125
  <dt><a href="#HolidayEvent">HolidayEvent</a></dt>
126
126
  <dd><p>Represents a built-in holiday like Pesach, Purim or Tu BiShvat</p>
127
127
  </dd>
128
- <dt><a href="#RoshChodeshEvent">RoshChodeshEvent</a></dt>
129
- <dd><p>Represents Rosh Chodesh, the beginning of a new month</p>
130
- </dd>
131
128
  <dt><a href="#AsaraBTevetEvent">AsaraBTevetEvent</a></dt>
132
129
  <dd><p>Because Asara B&#39;Tevet often occurs twice in the same Gregorian year,
133
130
  we subclass HolidayEvent to override the <code>url()</code> method.</p>
134
131
  </dd>
132
+ <dt><a href="#RoshChodeshEvent">RoshChodeshEvent</a></dt>
133
+ <dd><p>Represents Rosh Chodesh, the beginning of a new month</p>
134
+ </dd>
135
135
  <dt><a href="#MevarchimChodeshEvent">MevarchimChodeshEvent</a></dt>
136
136
  <dd><p>Represents Mevarchim haChodesh, the announcement of the new month</p>
137
137
  </dd>
@@ -162,6 +162,9 @@ Event names can be rendered in several languges using the <code>locale</code> op
162
162
  <dd><p>The 54 parshiyot of the Torah as transilterated strings
163
163
  parshiot[0] == &#39;Bereshit&#39;, parshiot[1] == &#39;Noach&#39;, parshiot[52] == &quot;Ha&#39;azinu&quot;.</p>
164
164
  </dd>
165
+ <dt><a href="#version">version</a></dt>
166
+ <dd><p>DO NOT EDIT THIS AUTO-GENERATED FILE!</p>
167
+ </dd>
165
168
  </dl>
166
169
 
167
170
  ## Functions
@@ -230,6 +233,9 @@ and vowels (nekudot).</p>
230
233
  <dd><p>Returns an emoji number symbol with a circle, for example <code>㊲</code>
231
234
  from the “Enclosed CJK Letters and Months” block of the Unicode standard</p>
232
235
  </dd>
236
+ <dt><a href="#molad">molad()</a></dt>
237
+ <dd><p>Calculates the molad for a Hebrew month</p>
238
+ </dd>
233
239
  <dt><a href="#getPseudoISO">getPseudoISO(tzid, date)</a> ⇒ <code>string</code></dt>
234
240
  <dd><p>Returns a string similar to <code>Date.toISOString()</code> but in the
235
241
  timezone <code>tzid</code>. Contrary to the typical meaning of <code>Z</code> at the end
@@ -250,16 +256,6 @@ Similar to <code>string.padStart(2, &#39;0&#39;)</code>.</p>
250
256
  </dd>
251
257
  </dl>
252
258
 
253
- ## Typedefs
254
-
255
- <dl>
256
- <dt><a href="#CalOptions">CalOptions</a> : <code>Object</code></dt>
257
- <dd><p>Options to configure which events are returned</p>
258
- </dd>
259
- <dt><a href="#TachanunResult">TachanunResult</a> : <code>Object</code></dt>
260
- <dd></dd>
261
- </dl>
262
-
263
259
  <a name="Locale"></a>
264
260
 
265
261
  ## Locale
@@ -332,7 +328,7 @@ Adds a translation to `locale`, replacing any previous translation.
332
328
  | --- | --- | --- |
333
329
  | locale | <code>string</code> | Locale name (i.e: `'he'`, `'fr'`). |
334
330
  | id | <code>string</code> | Message ID to translate |
335
- | translation | <code>string</code> | Translation text |
331
+ | translation | <code>string</code> \| <code>Array.&lt;string&gt;</code> | Translation text |
336
332
 
337
333
  <a name="Locale.addTranslations"></a>
338
334
 
@@ -929,110 +925,6 @@ HDate.fromGematriyaString('כ״ז בְּתַמּוּז תשפ״ג') // 27 Tamuz
929
925
  HDate.fromGematriyaString('כ׳ סיון תש״ד') // 20 Sivan 5704
930
926
  HDate.fromGematriyaString('ה׳ אִיָיר תש״ח') // 5 Iyyar 5708
931
927
  ```
932
- <a name="Sedra"></a>
933
-
934
- ## Sedra
935
- Represents Parashah HaShavua for an entire Hebrew year
936
-
937
- **Kind**: global class
938
-
939
- * [Sedra](#Sedra)
940
- * [new Sedra(hyear, il)](#new_Sedra_new)
941
- * [.get(hd)](#Sedra+get) ⇒ <code>Array.&lt;string&gt;</code>
942
- * [.getString(hd, [locale])](#Sedra+getString) ⇒ <code>string</code>
943
- * [.isParsha(hd)](#Sedra+isParsha) ⇒ <code>boolean</code>
944
- * [.find(parsha)](#Sedra+find) ⇒ [<code>HDate</code>](#HDate) \| <code>null</code>
945
- * [.getSedraArray()](#Sedra+getSedraArray) ⇒ <code>Array.&lt;NumberOrString&gt;</code>
946
- * [.getFirstSaturday()](#Sedra+getFirstSaturday) ⇒ <code>number</code>
947
- * [.getYear()](#Sedra+getYear) ⇒ <code>number</code>
948
- * [.lookup(hd)](#Sedra+lookup) ⇒ <code>SedraResult</code>
949
-
950
- <a name="new_Sedra_new"></a>
951
-
952
- ### new Sedra(hyear, il)
953
- Caculates the Parashah HaShavua for an entire Hebrew year
954
-
955
-
956
- | Param | Type | Description |
957
- | --- | --- | --- |
958
- | hyear | <code>number</code> | Hebrew year (e.g. 5749) |
959
- | il | <code>boolean</code> | Use Israel sedra schedule (false for Diaspora) |
960
-
961
- <a name="Sedra+get"></a>
962
-
963
- ### sedra.get(hd) ⇒ <code>Array.&lt;string&gt;</code>
964
- Returns the parsha (or parshiyot) read on Hebrew date
965
-
966
- **Kind**: instance method of [<code>Sedra</code>](#Sedra)
967
-
968
- | Param | Type | Description |
969
- | --- | --- | --- |
970
- | hd | [<code>HDate</code>](#HDate) \| <code>number</code> | Hebrew date or R.D. days |
971
-
972
- <a name="Sedra+getString"></a>
973
-
974
- ### sedra.getString(hd, [locale]) ⇒ <code>string</code>
975
- Looks up parsha for the date, then returns a translated or transliterated string
976
-
977
- **Kind**: instance method of [<code>Sedra</code>](#Sedra)
978
-
979
- | Param | Type | Description |
980
- | --- | --- | --- |
981
- | hd | [<code>HDate</code>](#HDate) \| <code>number</code> | Hebrew date or R.D. days |
982
- | [locale] | <code>string</code> | Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale |
983
-
984
- <a name="Sedra+isParsha"></a>
985
-
986
- ### sedra.isParsha(hd) ⇒ <code>boolean</code>
987
- Checks to see if this day would be a regular parasha HaShavua
988
- Torah reading or special holiday reading
989
-
990
- **Kind**: instance method of [<code>Sedra</code>](#Sedra)
991
-
992
- | Param | Type | Description |
993
- | --- | --- | --- |
994
- | hd | [<code>HDate</code>](#HDate) \| <code>number</code> | Hebrew date or R.D. days |
995
-
996
- <a name="Sedra+find"></a>
997
-
998
- ### sedra.find(parsha) ⇒ [<code>HDate</code>](#HDate) \| <code>null</code>
999
- Returns the date that a parsha occurs
1000
- or `null` if the parsha doesn't occur this year
1001
-
1002
- **Kind**: instance method of [<code>Sedra</code>](#Sedra)
1003
-
1004
- | Param | Type |
1005
- | --- | --- |
1006
- | parsha | <code>number</code> \| <code>string</code> \| <code>Array.&lt;string&gt;</code> |
1007
-
1008
- <a name="Sedra+getSedraArray"></a>
1009
-
1010
- ### sedra.getSedraArray() ⇒ <code>Array.&lt;NumberOrString&gt;</code>
1011
- Returns the underlying annual sedra schedule.
1012
- Used by `@hebcal/triennial`
1013
-
1014
- **Kind**: instance method of [<code>Sedra</code>](#Sedra)
1015
- <a name="Sedra+getFirstSaturday"></a>
1016
-
1017
- ### sedra.getFirstSaturday() ⇒ <code>number</code>
1018
- R.D. date of the first Saturday on or after Rosh Hashana
1019
-
1020
- **Kind**: instance method of [<code>Sedra</code>](#Sedra)
1021
- <a name="Sedra+getYear"></a>
1022
-
1023
- ### sedra.getYear() ⇒ <code>number</code>
1024
- **Kind**: instance method of [<code>Sedra</code>](#Sedra)
1025
- <a name="Sedra+lookup"></a>
1026
-
1027
- ### sedra.lookup(hd) ⇒ <code>SedraResult</code>
1028
- Returns an object describing the parsha on the first Saturday on or after `hd`
1029
-
1030
- **Kind**: instance method of [<code>Sedra</code>](#Sedra)
1031
-
1032
- | Param | Type | Description |
1033
- | --- | --- | --- |
1034
- | hd | [<code>HDate</code>](#HDate) \| <code>number</code> | Hebrew date or R.D. days |
1035
-
1036
928
  <a name="Event"></a>
1037
929
 
1038
930
  ## Event
@@ -1047,9 +939,9 @@ Represents an Event with a title, date, and flags
1047
939
  * [.getFlags()](#Event+getFlags) ⇒ <code>number</code>
1048
940
  * [.render([locale])](#Event+render) ⇒ <code>string</code>
1049
941
  * [.renderBrief([locale])](#Event+renderBrief) ⇒ <code>string</code>
1050
- * [.getEmoji()](#Event+getEmoji) ⇒ <code>string</code>
942
+ * [.getEmoji()](#Event+getEmoji) ⇒ <code>string</code> \| <code>null</code>
1051
943
  * [.basename()](#Event+basename) ⇒ <code>string</code>
1052
- * [.url()](#Event+url) ⇒ <code>string</code>
944
+ * [.url()](#Event+url) ⇒ <code>string</code> \| <code>undefined</code>
1053
945
  * [.observedInIsrael()](#Event+observedInIsrael) ⇒ <code>boolean</code>
1054
946
  * [.observedInDiaspora()](#Event+observedInDiaspora) ⇒ <code>boolean</code>
1055
947
  * [.observedIn(il)](#Event+observedIn) ⇒ <code>boolean</code>
@@ -1120,7 +1012,7 @@ a shorter text (e.g. without a time or added description).
1120
1012
 
1121
1013
  <a name="Event+getEmoji"></a>
1122
1014
 
1123
- ### event.getEmoji() ⇒ <code>string</code>
1015
+ ### event.getEmoji() ⇒ <code>string</code> \| <code>null</code>
1124
1016
  Optional holiday-specific Emoji or `null`.
1125
1017
 
1126
1018
  **Kind**: instance method of [<code>Event</code>](#Event)
@@ -1135,7 +1027,7 @@ For many holidays the basename and the event description are the same.
1135
1027
  **Kind**: instance method of [<code>Event</code>](#Event)
1136
1028
  <a name="Event+url"></a>
1137
1029
 
1138
- ### event.url() ⇒ <code>string</code>
1030
+ ### event.url() ⇒ <code>string</code> \| <code>undefined</code>
1139
1031
  Returns a URL to hebcal.com or sefaria.org for more detail on the event.
1140
1032
  Returns `undefined` for events with no detail page.
1141
1033
 
@@ -1873,25 +1765,25 @@ Class representing Location
1873
1765
  **Kind**: global class
1874
1766
 
1875
1767
  * [Location](#Location)
1876
- * [new Location(latitude, longitude, il, tzid, cityName, countryCode, [geoid], [elevation])](#new_Location_new)
1768
+ * [new Location(latitude, longitude, il, tzid, [cityName], [countryCode], [geoid], [elevation])](#new_Location_new)
1877
1769
  * _instance_
1878
1770
  * [.getIsrael()](#Location+getIsrael) ⇒ <code>boolean</code>
1879
- * [.getName()](#Location+getName) ⇒ <code>string</code>
1880
- * [.getShortName()](#Location+getShortName) ⇒ <code>string</code>
1881
- * [.getCountryCode()](#Location+getCountryCode) ⇒ <code>string</code>
1771
+ * [.getName()](#Location+getName) ⇒ <code>string</code> \| <code>null</code>
1772
+ * [.getShortName()](#Location+getShortName) ⇒ <code>string</code> \| <code>null</code>
1773
+ * [.getCountryCode()](#Location+getCountryCode) ⇒ <code>string</code> \| <code>undefined</code>
1882
1774
  * [.getTzid()](#Location+getTzid) ⇒ <code>string</code>
1883
1775
  * [.getTimeFormatter()](#Location+getTimeFormatter) ⇒ <code>Intl.DateTimeFormat</code>
1884
- * [.getGeoId()](#Location+getGeoId) ⇒ <code>string</code>
1776
+ * [.getGeoId()](#Location+getGeoId) ⇒ <code>string</code> \| <code>number</code> \| <code>undefined</code>
1885
1777
  * [.toString()](#Location+toString) ⇒ <code>string</code>
1886
1778
  * _static_
1887
- * [.lookup(name)](#Location.lookup) ⇒ [<code>Location</code>](#Location)
1888
- * [.legacyTzToTzid(tz, dst)](#Location.legacyTzToTzid) ⇒ <code>string</code>
1779
+ * [.lookup(name)](#Location.lookup) ⇒ [<code>Location</code>](#Location) \| <code>undefined</code>
1780
+ * [.legacyTzToTzid(tz, dst)](#Location.legacyTzToTzid) ⇒ <code>string</code> \| <code>undefined</code>
1889
1781
  * [.getUsaTzid(state, tz, dst)](#Location.getUsaTzid) ⇒ <code>string</code>
1890
1782
  * [.addLocation(cityName, location)](#Location.addLocation) ⇒ <code>boolean</code>
1891
1783
 
1892
1784
  <a name="new_Location_new"></a>
1893
1785
 
1894
- ### new Location(latitude, longitude, il, tzid, cityName, countryCode, [geoid], [elevation])
1786
+ ### new Location(latitude, longitude, il, tzid, [cityName], [countryCode], [geoid], [elevation])
1895
1787
  Initialize a Location instance
1896
1788
 
1897
1789
 
@@ -1901,9 +1793,9 @@ Initialize a Location instance
1901
1793
  | longitude | <code>number</code> | Longitude as a decimal, valid range -180 thru +180 (e.g. -87.65005) |
1902
1794
  | il | <code>boolean</code> | in Israel (true) or Diaspora (false) |
1903
1795
  | tzid | <code>string</code> | Olson timezone ID, e.g. "America/Chicago" |
1904
- | cityName | <code>string</code> | optional descriptive city name |
1905
- | countryCode | <code>string</code> | ISO 3166 alpha-2 country code (e.g. "FR") |
1906
- | [geoid] | <code>string</code> | optional string or numeric geographic ID |
1796
+ | [cityName] | <code>string</code> | optional descriptive city name |
1797
+ | [countryCode] | <code>string</code> | ISO 3166 alpha-2 country code (e.g. "FR") |
1798
+ | [geoid] | <code>string</code> \| <code>number</code> | optional string or numeric geographic ID |
1907
1799
  | [elevation] | <code>number</code> | in meters (default `0`) |
1908
1800
 
1909
1801
  <a name="Location+getIsrael"></a>
@@ -1912,17 +1804,17 @@ Initialize a Location instance
1912
1804
  **Kind**: instance method of [<code>Location</code>](#Location)
1913
1805
  <a name="Location+getName"></a>
1914
1806
 
1915
- ### location.getName() ⇒ <code>string</code>
1807
+ ### location.getName() ⇒ <code>string</code> \| <code>null</code>
1916
1808
  **Kind**: instance method of [<code>Location</code>](#Location)
1917
1809
  <a name="Location+getShortName"></a>
1918
1810
 
1919
- ### location.getShortName() ⇒ <code>string</code>
1811
+ ### location.getShortName() ⇒ <code>string</code> \| <code>null</code>
1920
1812
  Returns the location name, up to the first comma
1921
1813
 
1922
1814
  **Kind**: instance method of [<code>Location</code>](#Location)
1923
1815
  <a name="Location+getCountryCode"></a>
1924
1816
 
1925
- ### location.getCountryCode() ⇒ <code>string</code>
1817
+ ### location.getCountryCode() ⇒ <code>string</code> \| <code>undefined</code>
1926
1818
  **Kind**: instance method of [<code>Location</code>](#Location)
1927
1819
  <a name="Location+getTzid"></a>
1928
1820
 
@@ -1936,7 +1828,7 @@ Gets a 24-hour time formatter (e.g. 07:41 or 20:03) for this location
1936
1828
  **Kind**: instance method of [<code>Location</code>](#Location)
1937
1829
  <a name="Location+getGeoId"></a>
1938
1830
 
1939
- ### location.getGeoId() ⇒ <code>string</code>
1831
+ ### location.getGeoId() ⇒ <code>string</code> \| <code>number</code> \| <code>undefined</code>
1940
1832
  **Kind**: instance method of [<code>Location</code>](#Location)
1941
1833
  <a name="Location+toString"></a>
1942
1834
 
@@ -1944,7 +1836,7 @@ Gets a 24-hour time formatter (e.g. 07:41 or 20:03) for this location
1944
1836
  **Kind**: instance method of [<code>Location</code>](#Location)
1945
1837
  <a name="Location.lookup"></a>
1946
1838
 
1947
- ### Location.lookup(name) ⇒ [<code>Location</code>](#Location)
1839
+ ### Location.lookup(name) ⇒ [<code>Location</code>](#Location) \| <code>undefined</code>
1948
1840
  Creates a location object from one of 60 "classic" Hebcal city names.
1949
1841
  The following city names are supported:
1950
1842
  'Ashdod', 'Atlanta', 'Austin', 'Baghdad', 'Beer Sheva',
@@ -1969,7 +1861,7 @@ The following city names are supported:
1969
1861
 
1970
1862
  <a name="Location.legacyTzToTzid"></a>
1971
1863
 
1972
- ### Location.legacyTzToTzid(tz, dst) ⇒ <code>string</code>
1864
+ ### Location.legacyTzToTzid(tz, dst) ⇒ <code>string</code> \| <code>undefined</code>
1973
1865
  Converts legacy Hebcal timezone to a standard Olson tzid.
1974
1866
 
1975
1867
  **Kind**: static method of [<code>Location</code>](#Location)
@@ -2056,7 +1948,9 @@ https://gml.noaa.gov/grad/solcalc/calcdetails.html
2056
1948
  * [.sofZmanTfillaMGA16Point1()](#Zmanim+sofZmanTfillaMGA16Point1) ⇒ <code>Date</code>
2057
1949
  * [.sofZmanTfillaMGA19Point8()](#Zmanim+sofZmanTfillaMGA19Point8) ⇒ <code>Date</code>
2058
1950
  * [.minchaGedola()](#Zmanim+minchaGedola) ⇒ <code>Date</code>
1951
+ * [.minchaGedolaMGA()](#Zmanim+minchaGedolaMGA) ⇒ <code>Date</code>
2059
1952
  * [.minchaKetana()](#Zmanim+minchaKetana) ⇒ <code>Date</code>
1953
+ * [.minchaKetanaMGA()](#Zmanim+minchaKetanaMGA) ⇒ <code>Date</code>
2060
1954
  * [.plagHaMincha()](#Zmanim+plagHaMincha) ⇒ <code>Date</code>
2061
1955
  * [.tzeit([angle])](#Zmanim+tzeit) ⇒ <code>Date</code>
2062
1956
  * [.neitzHaChama()](#Zmanim+neitzHaChama) ⇒ <code>Date</code>
@@ -2225,6 +2119,12 @@ If elevation is enabled, this function will include elevation in the calculation
2225
2119
 
2226
2120
  ### zmanim.sofZmanTfilla() ⇒ <code>Date</code>
2227
2121
  Latest Shacharit (Gra); Sunrise plus 4 halachic hours, according to the Gra.
2122
+
2123
+ This method returns the latest *zman tfila* (time to recite shema in the morning)
2124
+ that is 4 *shaos zmaniyos* (solar hours) after sunrise or sea level sunrise
2125
+ (depending on the `useElevation` setting), according
2126
+ to the [GRA](https://en.wikipedia.org/wiki/Vilna_Gaon).
2127
+
2228
2128
  If elevation is enabled, this function will include elevation in the calculation.
2229
2129
 
2230
2130
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
@@ -2286,9 +2186,29 @@ https://kosherjava.com/2022/01/12/equinox-vs-equilux-zmanim-calculations/
2286
2186
  <a name="Zmanim+minchaGedola"></a>
2287
2187
 
2288
2188
  ### zmanim.minchaGedola() ⇒ <code>Date</code>
2289
- Earliest Mincha – Mincha Gedola; Sunrise plus 6.5 halachic hours.
2189
+ Earliest Mincha – Mincha Gedola (GRA); Sunrise plus 6.5 halachic hours.
2290
2190
  If elevation is enabled, this function will include elevation in the calculation.
2291
2191
 
2192
+ This method returns the latest mincha gedola, the earliest time one can pray mincha
2193
+ that is 6.5 shaos zmaniyos (solar hours) after sunrise or sea level sunrise
2194
+ (depending on the `useElevation` setting), according
2195
+ to the [GRA](https://en.wikipedia.org/wiki/Vilna_Gaon).
2196
+
2197
+ The Ramba"m is of the opinion that it is better to delay *mincha* until
2198
+ *mincha ketana* while the Ra"sh, Tur, GRA and others are of the
2199
+ opinion that *mincha* can be prayed *lechatchila* starting at *mincha gedola*.
2200
+
2201
+ **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
2202
+ <a name="Zmanim+minchaGedolaMGA"></a>
2203
+
2204
+ ### zmanim.minchaGedolaMGA() ⇒ <code>Date</code>
2205
+ Earliest Mincha – Mincha Gedola (MGA); Sunrise plus 6.5 halachic hours.
2206
+ If elevation is enabled, this function will include elevation in the calculation.
2207
+
2208
+ This method returns the time of *mincha gedola* according to the Magen Avraham
2209
+ with the day starting 72 minutes before sunrise and ending 72 minutes after sunset.
2210
+ This is the earliest time to pray *mincha*.
2211
+
2292
2212
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
2293
2213
  <a name="Zmanim+minchaKetana"></a>
2294
2214
 
@@ -2296,6 +2216,23 @@ If elevation is enabled, this function will include elevation in the calculation
2296
2216
  Preferable earliest time to recite Minchah – Mincha Ketana; Sunrise plus 9.5 halachic hours.
2297
2217
  If elevation is enabled, this function will include elevation in the calculation.
2298
2218
 
2219
+ This method returns *mincha ketana*, the preferred earliest time to pray *mincha* in the
2220
+ opinion of the [Rambam](https://en.wikipedia.org/wiki/Maimonides) and others,
2221
+ that is 9.5 *shaos zmaniyos* (solar hours) after sunrise or sea level sunrise
2222
+ (depending on the `useElevation` setting), according
2223
+ to the [GRA](https://en.wikipedia.org/wiki/Vilna_Gaon).
2224
+
2225
+ **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
2226
+ <a name="Zmanim+minchaKetanaMGA"></a>
2227
+
2228
+ ### zmanim.minchaKetanaMGA() ⇒ <code>Date</code>
2229
+ This method returns the time of *mincha ketana* according to the Magen Avraham
2230
+ with the day starting 72 minutes before sunrise and ending 72 minutes after sunset.
2231
+ This is the preferred earliest time to pray *mincha* according to the opinion of
2232
+ the [Rambam](https://en.wikipedia.org/wiki/Maimonides) and others.
2233
+
2234
+ If elevation is enabled, this function will include elevation in the calculation.
2235
+
2299
2236
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
2300
2237
  <a name="Zmanim+plagHaMincha"></a>
2301
2238
 
@@ -2421,24 +2358,18 @@ An event that has an `eventTime` and `eventTimeStr`
2421
2358
  **Kind**: global class
2422
2359
 
2423
2360
  * [TimedEvent](#TimedEvent)
2424
- * [new TimedEvent(date, desc, mask, eventTime, location, linkedEvent, options)](#new_TimedEvent_new)
2361
+ * [new TimedEvent(desc)](#new_TimedEvent_new)
2425
2362
  * [.render([locale])](#TimedEvent+render) ⇒ <code>string</code>
2426
2363
  * [.renderBrief([locale])](#TimedEvent+renderBrief) ⇒ <code>string</code>
2427
2364
  * [.getCategories()](#TimedEvent+getCategories) ⇒ <code>Array.&lt;string&gt;</code>
2428
2365
 
2429
2366
  <a name="new_TimedEvent_new"></a>
2430
2367
 
2431
- ### new TimedEvent(date, desc, mask, eventTime, location, linkedEvent, options)
2368
+ ### new TimedEvent(desc)
2432
2369
 
2433
2370
  | Param | Type | Description |
2434
2371
  | --- | --- | --- |
2435
- | date | [<code>HDate</code>](#HDate) | |
2436
2372
  | desc | <code>string</code> | Description (not translated) |
2437
- | mask | <code>number</code> | |
2438
- | eventTime | <code>Date</code> | |
2439
- | location | [<code>Location</code>](#Location) | |
2440
- | linkedEvent | [<code>Event</code>](#Event) | |
2441
- | options | [<code>CalOptions</code>](#CalOptions) | |
2442
2373
 
2443
2374
  <a name="TimedEvent+render"></a>
2444
2375
 
@@ -2464,6 +2395,16 @@ Returns translation of "Candle lighting" without the time.
2464
2395
 
2465
2396
  ### timedEvent.getCategories() ⇒ <code>Array.&lt;string&gt;</code>
2466
2397
  **Kind**: instance method of [<code>TimedEvent</code>](#TimedEvent)
2398
+ <a name="CandleLightingEvent"></a>
2399
+
2400
+ ## CandleLightingEvent
2401
+ Candle lighting before Shabbat or holiday
2402
+
2403
+ **Kind**: global class
2404
+ <a name="CandleLightingEvent+getEmoji"></a>
2405
+
2406
+ ### candleLightingEvent.getEmoji() ⇒ <code>string</code>
2407
+ **Kind**: instance method of [<code>CandleLightingEvent</code>](#CandleLightingEvent)
2467
2408
  <a name="HavdalahEvent"></a>
2468
2409
 
2469
2410
  ## HavdalahEvent
@@ -2472,25 +2413,10 @@ Havdalah after Shabbat or holiday
2472
2413
  **Kind**: global class
2473
2414
 
2474
2415
  * [HavdalahEvent](#HavdalahEvent)
2475
- * [new HavdalahEvent(date, mask, eventTime, location, havdalahMins, linkedEvent, options)](#new_HavdalahEvent_new)
2476
2416
  * [.render([locale])](#HavdalahEvent+render) ⇒ <code>string</code>
2477
2417
  * [.renderBrief([locale])](#HavdalahEvent+renderBrief) ⇒ <code>string</code>
2478
2418
  * [.getEmoji()](#HavdalahEvent+getEmoji) ⇒ <code>string</code>
2479
2419
 
2480
- <a name="new_HavdalahEvent_new"></a>
2481
-
2482
- ### new HavdalahEvent(date, mask, eventTime, location, havdalahMins, linkedEvent, options)
2483
-
2484
- | Param | Type |
2485
- | --- | --- |
2486
- | date | [<code>HDate</code>](#HDate) |
2487
- | mask | <code>number</code> |
2488
- | eventTime | <code>Date</code> |
2489
- | location | [<code>Location</code>](#Location) |
2490
- | havdalahMins | <code>number</code> |
2491
- | linkedEvent | [<code>Event</code>](#Event) |
2492
- | options | [<code>CalOptions</code>](#CalOptions) |
2493
-
2494
2420
  <a name="HavdalahEvent+render"></a>
2495
2421
 
2496
2422
  ### havdalahEvent.render([locale]) ⇒ <code>string</code>
@@ -2515,34 +2441,6 @@ Returns translation of "Havdalah" without the time.
2515
2441
 
2516
2442
  ### havdalahEvent.getEmoji() ⇒ <code>string</code>
2517
2443
  **Kind**: instance method of [<code>HavdalahEvent</code>](#HavdalahEvent)
2518
- <a name="CandleLightingEvent"></a>
2519
-
2520
- ## CandleLightingEvent
2521
- Candle lighting before Shabbat or holiday
2522
-
2523
- **Kind**: global class
2524
-
2525
- * [CandleLightingEvent](#CandleLightingEvent)
2526
- * [new CandleLightingEvent(date, mask, eventTime, location, linkedEvent, options)](#new_CandleLightingEvent_new)
2527
- * [.getEmoji()](#CandleLightingEvent+getEmoji) ⇒ <code>string</code>
2528
-
2529
- <a name="new_CandleLightingEvent_new"></a>
2530
-
2531
- ### new CandleLightingEvent(date, mask, eventTime, location, linkedEvent, options)
2532
-
2533
- | Param | Type |
2534
- | --- | --- |
2535
- | date | [<code>HDate</code>](#HDate) |
2536
- | mask | <code>number</code> |
2537
- | eventTime | <code>Date</code> |
2538
- | location | [<code>Location</code>](#Location) |
2539
- | linkedEvent | [<code>Event</code>](#Event) |
2540
- | options | [<code>CalOptions</code>](#CalOptions) |
2541
-
2542
- <a name="CandleLightingEvent+getEmoji"></a>
2543
-
2544
- ### candleLightingEvent.getEmoji() ⇒ <code>string</code>
2545
- **Kind**: instance method of [<code>CandleLightingEvent</code>](#CandleLightingEvent)
2546
2444
  <a name="Molad"></a>
2547
2445
 
2548
2446
  ## Molad
@@ -2612,7 +2510,7 @@ Calculates the molad for a Hebrew month
2612
2510
  | Param | Type | Description |
2613
2511
  | --- | --- | --- |
2614
2512
  | [locale] | <code>string</code> | Optional locale name (defaults to active locale) |
2615
- | options | [<code>CalOptions</code>](#CalOptions) | |
2513
+ | options | <code>CalOptions</code> | |
2616
2514
 
2617
2515
  <a name="MoladEvent"></a>
2618
2516
 
@@ -2634,7 +2532,7 @@ Represents a Molad announcement on Shabbat Mevarchim
2634
2532
  | date | [<code>HDate</code>](#HDate) | Hebrew date event occurs |
2635
2533
  | hyear | <code>number</code> | molad year |
2636
2534
  | hmonth | <code>number</code> | molad month |
2637
- | options | [<code>CalOptions</code>](#CalOptions) | |
2535
+ | options | <code>CalOptions</code> | |
2638
2536
 
2639
2537
  <a name="MoladEvent+render"></a>
2640
2538
 
@@ -2730,6 +2628,110 @@ Returns translation of "Omer day 22" without ordinal numbers.
2730
2628
 
2731
2629
  ### omerEvent.url() ⇒ <code>string</code>
2732
2630
  **Kind**: instance method of [<code>OmerEvent</code>](#OmerEvent)
2631
+ <a name="Sedra"></a>
2632
+
2633
+ ## Sedra
2634
+ Represents Parashah HaShavua for an entire Hebrew year
2635
+
2636
+ **Kind**: global class
2637
+
2638
+ * [Sedra](#Sedra)
2639
+ * [new Sedra(hyear, il)](#new_Sedra_new)
2640
+ * [.get(hd)](#Sedra+get) ⇒ <code>Array.&lt;string&gt;</code>
2641
+ * [.getString(hd, [locale])](#Sedra+getString) ⇒ <code>string</code>
2642
+ * [.isParsha(hd)](#Sedra+isParsha) ⇒ <code>boolean</code>
2643
+ * [.find(parsha)](#Sedra+find) ⇒ [<code>HDate</code>](#HDate) \| <code>null</code>
2644
+ * [.getSedraArray()](#Sedra+getSedraArray) ⇒ <code>Array.&lt;NumberOrString&gt;</code>
2645
+ * [.getFirstSaturday()](#Sedra+getFirstSaturday) ⇒ <code>number</code>
2646
+ * [.getYear()](#Sedra+getYear) ⇒ <code>number</code>
2647
+ * [.lookup(hd)](#Sedra+lookup) ⇒ <code>SedraResult</code>
2648
+
2649
+ <a name="new_Sedra_new"></a>
2650
+
2651
+ ### new Sedra(hyear, il)
2652
+ Caculates the Parashah HaShavua for an entire Hebrew year
2653
+
2654
+
2655
+ | Param | Type | Description |
2656
+ | --- | --- | --- |
2657
+ | hyear | <code>number</code> | Hebrew year (e.g. 5749) |
2658
+ | il | <code>boolean</code> | Use Israel sedra schedule (false for Diaspora) |
2659
+
2660
+ <a name="Sedra+get"></a>
2661
+
2662
+ ### sedra.get(hd) ⇒ <code>Array.&lt;string&gt;</code>
2663
+ Returns the parsha (or parshiyot) read on Hebrew date
2664
+
2665
+ **Kind**: instance method of [<code>Sedra</code>](#Sedra)
2666
+
2667
+ | Param | Type | Description |
2668
+ | --- | --- | --- |
2669
+ | hd | [<code>HDate</code>](#HDate) \| <code>number</code> | Hebrew date or R.D. days |
2670
+
2671
+ <a name="Sedra+getString"></a>
2672
+
2673
+ ### sedra.getString(hd, [locale]) ⇒ <code>string</code>
2674
+ Looks up parsha for the date, then returns a translated or transliterated string
2675
+
2676
+ **Kind**: instance method of [<code>Sedra</code>](#Sedra)
2677
+
2678
+ | Param | Type | Description |
2679
+ | --- | --- | --- |
2680
+ | hd | [<code>HDate</code>](#HDate) \| <code>number</code> | Hebrew date or R.D. days |
2681
+ | [locale] | <code>string</code> | Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale |
2682
+
2683
+ <a name="Sedra+isParsha"></a>
2684
+
2685
+ ### sedra.isParsha(hd) ⇒ <code>boolean</code>
2686
+ Checks to see if this day would be a regular parasha HaShavua
2687
+ Torah reading or special holiday reading
2688
+
2689
+ **Kind**: instance method of [<code>Sedra</code>](#Sedra)
2690
+
2691
+ | Param | Type | Description |
2692
+ | --- | --- | --- |
2693
+ | hd | [<code>HDate</code>](#HDate) \| <code>number</code> | Hebrew date or R.D. days |
2694
+
2695
+ <a name="Sedra+find"></a>
2696
+
2697
+ ### sedra.find(parsha) ⇒ [<code>HDate</code>](#HDate) \| <code>null</code>
2698
+ Returns the date that a parsha occurs
2699
+ or `null` if the parsha doesn't occur this year
2700
+
2701
+ **Kind**: instance method of [<code>Sedra</code>](#Sedra)
2702
+
2703
+ | Param | Type |
2704
+ | --- | --- |
2705
+ | parsha | <code>number</code> \| <code>string</code> \| <code>Array.&lt;string&gt;</code> |
2706
+
2707
+ <a name="Sedra+getSedraArray"></a>
2708
+
2709
+ ### sedra.getSedraArray() ⇒ <code>Array.&lt;NumberOrString&gt;</code>
2710
+ Returns the underlying annual sedra schedule.
2711
+ Used by `@hebcal/triennial`
2712
+
2713
+ **Kind**: instance method of [<code>Sedra</code>](#Sedra)
2714
+ <a name="Sedra+getFirstSaturday"></a>
2715
+
2716
+ ### sedra.getFirstSaturday() ⇒ <code>number</code>
2717
+ R.D. date of the first Saturday on or after Rosh Hashana
2718
+
2719
+ **Kind**: instance method of [<code>Sedra</code>](#Sedra)
2720
+ <a name="Sedra+getYear"></a>
2721
+
2722
+ ### sedra.getYear() ⇒ <code>number</code>
2723
+ **Kind**: instance method of [<code>Sedra</code>](#Sedra)
2724
+ <a name="Sedra+lookup"></a>
2725
+
2726
+ ### sedra.lookup(hd) ⇒ <code>SedraResult</code>
2727
+ Returns an object describing the parsha on the first Saturday on or after `hd`
2728
+
2729
+ **Kind**: instance method of [<code>Sedra</code>](#Sedra)
2730
+
2731
+ | Param | Type | Description |
2732
+ | --- | --- | --- |
2733
+ | hd | [<code>HDate</code>](#HDate) \| <code>number</code> | Hebrew date or R.D. days |
2734
+
2733
2735
  <a name="ParshaEvent"></a>
2734
2736
 
2735
2737
  ## ParshaEvent
@@ -2738,22 +2740,22 @@ Represents one of 54 weekly Torah portions, always on a Saturday
2738
2740
  **Kind**: global class
2739
2741
 
2740
2742
  * [ParshaEvent](#ParshaEvent)
2741
- * [new ParshaEvent(date, parsha, il, num)](#new_ParshaEvent_new)
2743
+ * [new ParshaEvent(date, parsha, [il], [num])](#new_ParshaEvent_new)
2742
2744
  * [.render([locale])](#ParshaEvent+render) ⇒ <code>string</code>
2743
2745
  * [.basename()](#ParshaEvent+basename) ⇒ <code>string</code>
2744
- * [.url()](#ParshaEvent+url) ⇒ <code>string</code>
2746
+ * [.url()](#ParshaEvent+url) ⇒ <code>string</code> \| <code>undefined</code>
2745
2747
  * [.urlDateSuffix()](#ParshaEvent+urlDateSuffix) ⇒ <code>string</code>
2746
2748
 
2747
2749
  <a name="new_ParshaEvent_new"></a>
2748
2750
 
2749
- ### new ParshaEvent(date, parsha, il, num)
2751
+ ### new ParshaEvent(date, parsha, [il], [num])
2750
2752
 
2751
- | Param | Type | Description |
2752
- | --- | --- | --- |
2753
- | date | [<code>HDate</code>](#HDate) | |
2754
- | parsha | <code>Array.&lt;string&gt;</code> | untranslated name of single or double parsha, such as ['Bereshit'] or ['Achrei Mot', 'Kedoshim'] |
2755
- | il | <code>boolean</code> | |
2756
- | num | <code>number</code> \| <code>Array.&lt;number&gt;</code> | |
2753
+ | Param | Type | Default | Description |
2754
+ | --- | --- | --- | --- |
2755
+ | date | [<code>HDate</code>](#HDate) | | |
2756
+ | parsha | <code>Array.&lt;string&gt;</code> | | untranslated name of single or double parsha, such as ['Bereshit'] or ['Achrei Mot', 'Kedoshim'] |
2757
+ | [il] | <code>boolean</code> | <code>false</code> | |
2758
+ | [num] | <code>number</code> \| <code>Array.&lt;number&gt;</code> | | |
2757
2759
 
2758
2760
  <a name="ParshaEvent+render"></a>
2759
2761
 
@@ -2770,7 +2772,7 @@ Represents one of 54 weekly Torah portions, always on a Saturday
2770
2772
  **Kind**: instance method of [<code>ParshaEvent</code>](#ParshaEvent)
2771
2773
  <a name="ParshaEvent+url"></a>
2772
2774
 
2773
- ### parshaEvent.url() ⇒ <code>string</code>
2775
+ ### parshaEvent.url() ⇒ <code>string</code> \| <code>undefined</code>
2774
2776
  **Kind**: instance method of [<code>ParshaEvent</code>](#ParshaEvent)
2775
2777
  <a name="ParshaEvent+urlDateSuffix"></a>
2776
2778
 
@@ -2785,12 +2787,13 @@ Represents a built-in holiday like Pesach, Purim or Tu BiShvat
2785
2787
 
2786
2788
  * [HolidayEvent](#HolidayEvent)
2787
2789
  * [.basename()](#HolidayEvent+basename) ⇒ <code>string</code>
2788
- * [.url()](#HolidayEvent+url) ⇒ <code>string</code>
2790
+ * [.url()](#HolidayEvent+url) ⇒ <code>string</code> \| <code>undefined</code>
2789
2791
  * [.urlDateSuffix()](#HolidayEvent+urlDateSuffix) ⇒ <code>string</code>
2790
2792
  * [.getEmoji()](#HolidayEvent+getEmoji) ⇒ <code>string</code>
2791
2793
  * [.getCategories()](#HolidayEvent+getCategories) ⇒ <code>Array.&lt;string&gt;</code>
2792
2794
  * [.render([locale])](#HolidayEvent+render) ⇒ <code>string</code>
2793
2795
  * [.renderBrief([locale])](#HolidayEvent+renderBrief) ⇒ <code>string</code>
2796
+ * [.clone()](#HolidayEvent+clone) ⇒ [<code>Event</code>](#Event)
2794
2797
 
2795
2798
  <a name="HolidayEvent+basename"></a>
2796
2799
 
@@ -2798,7 +2801,7 @@ Represents a built-in holiday like Pesach, Purim or Tu BiShvat
2798
2801
  **Kind**: instance method of [<code>HolidayEvent</code>](#HolidayEvent)
2799
2802
  <a name="HolidayEvent+url"></a>
2800
2803
 
2801
- ### holidayEvent.url() ⇒ <code>string</code>
2804
+ ### holidayEvent.url() ⇒ <code>string</code> \| <code>undefined</code>
2802
2805
  **Kind**: instance method of [<code>HolidayEvent</code>](#HolidayEvent)
2803
2806
  <a name="HolidayEvent+urlDateSuffix"></a>
2804
2807
 
@@ -2836,6 +2839,23 @@ a shorter text (e.g. without a time or added description).
2836
2839
  | --- | --- | --- |
2837
2840
  | [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
2838
2841
 
2842
+ <a name="HolidayEvent+clone"></a>
2843
+
2844
+ ### holidayEvent.clone() ⇒ [<code>Event</code>](#Event)
2845
+ Makes a clone of this Event object
2846
+
2847
+ **Kind**: instance method of [<code>HolidayEvent</code>](#HolidayEvent)
2848
+ <a name="AsaraBTevetEvent"></a>
2849
+
2850
+ ## AsaraBTevetEvent
2851
+ Because Asara B'Tevet often occurs twice in the same Gregorian year,
2852
+ we subclass HolidayEvent to override the `url()` method.
2853
+
2854
+ **Kind**: global class
2855
+ <a name="AsaraBTevetEvent+urlDateSuffix"></a>
2856
+
2857
+ ### asaraBTevetEvent.urlDateSuffix() ⇒ <code>string</code>
2858
+ **Kind**: instance method of [<code>AsaraBTevetEvent</code>](#AsaraBTevetEvent)
2839
2859
  <a name="RoshChodeshEvent"></a>
2840
2860
 
2841
2861
  ## RoshChodeshEvent
@@ -2879,17 +2899,6 @@ Returns (translated) description of this event
2879
2899
 
2880
2900
  ### roshChodeshEvent.getEmoji() ⇒ <code>string</code>
2881
2901
  **Kind**: instance method of [<code>RoshChodeshEvent</code>](#RoshChodeshEvent)
2882
- <a name="AsaraBTevetEvent"></a>
2883
-
2884
- ## AsaraBTevetEvent
2885
- Because Asara B'Tevet often occurs twice in the same Gregorian year,
2886
- we subclass HolidayEvent to override the `url()` method.
2887
-
2888
- **Kind**: global class
2889
- <a name="AsaraBTevetEvent+urlDateSuffix"></a>
2890
-
2891
- ### asaraBTevetEvent.urlDateSuffix() ⇒ <code>string</code>
2892
- **Kind**: instance method of [<code>AsaraBTevetEvent</code>](#AsaraBTevetEvent)
2893
2902
  <a name="MevarchimChodeshEvent"></a>
2894
2903
 
2895
2904
  ## MevarchimChodeshEvent
@@ -2992,22 +3001,22 @@ Event names can be rendered in several languges using the `locale` option.
2992
3001
 
2993
3002
  * [HebrewCalendar](#HebrewCalendar)
2994
3003
  * [.calendar([options])](#HebrewCalendar.calendar) ⇒ [<code>Array.&lt;Event&gt;</code>](#Event)
2995
- * [.getBirthdayOrAnniversary(hyear, gdate)](#HebrewCalendar.getBirthdayOrAnniversary) ⇒ [<code>HDate</code>](#HDate)
2996
- * [.getYahrzeit(hyear, gdate)](#HebrewCalendar.getYahrzeit) ⇒ [<code>HDate</code>](#HDate)
2997
- * [.getHolidaysForYear(year)](#HebrewCalendar.getHolidaysForYear) ⇒ <code>Map.&lt;string, Array.&lt;Event&gt;&gt;</code>
2998
- * [.getHolidaysForYearArray(year, il)](#HebrewCalendar.getHolidaysForYearArray) ⇒ [<code>Array.&lt;Event&gt;</code>](#Event)
2999
- * [.getHolidaysOnDate(date, [il])](#HebrewCalendar.getHolidaysOnDate) ⇒ [<code>Array.&lt;Event&gt;</code>](#Event)
3004
+ * [.getBirthdayOrAnniversary(hyear, gdate)](#HebrewCalendar.getBirthdayOrAnniversary) ⇒ [<code>HDate</code>](#HDate) \| <code>undefined</code>
3005
+ * [.getYahrzeit(hyear, gdate)](#HebrewCalendar.getYahrzeit) ⇒ [<code>HDate</code>](#HDate) \| <code>undefined</code>
3006
+ * [.getHolidaysForYear(year)](#HebrewCalendar.getHolidaysForYear) ⇒ <code>HolidayYearMap</code>
3007
+ * [.getHolidaysForYearArray(year, il)](#HebrewCalendar.getHolidaysForYearArray) ⇒ [<code>Array.&lt;HolidayEvent&gt;</code>](#HolidayEvent)
3008
+ * [.getHolidaysOnDate(date, [il])](#HebrewCalendar.getHolidaysOnDate) ⇒ [<code>Array.&lt;HolidayEvent&gt;</code>](#HolidayEvent) \| <code>undefined</code>
3000
3009
  * [.eruvTavshilin(date, il)](#HebrewCalendar.eruvTavshilin) ⇒ <code>boolean</code>
3001
3010
  * [.reformatTimeStr(timeStr, suffix, options)](#HebrewCalendar.reformatTimeStr) ⇒ <code>string</code>
3002
3011
  * [.version()](#HebrewCalendar.version) ⇒ <code>string</code>
3003
3012
  * [.getSedra(hyear, il)](#HebrewCalendar.getSedra) ⇒ [<code>Sedra</code>](#Sedra)
3004
3013
  * [.hallel(hdate, il)](#HebrewCalendar.hallel) ⇒ <code>number</code>
3005
- * [.tachanun(hdate, il)](#HebrewCalendar.tachanun) ⇒ [<code>TachanunResult</code>](#TachanunResult)
3014
+ * [.tachanun(hdate, il)](#HebrewCalendar.tachanun) ⇒ <code>TachanunResult</code>
3006
3015
 
3007
3016
  <a name="HebrewCalendar.calendar"></a>
3008
3017
 
3009
3018
  ### HebrewCalendar.calendar([options]) ⇒ [<code>Array.&lt;Event&gt;</code>](#Event)
3010
- Calculates holidays and other Hebrew calendar events based on [CalOptions](#CalOptions).
3019
+ Calculates holidays and other Hebrew calendar events based on [CalOptions](CalOptions).
3011
3020
 
3012
3021
  Each holiday is represented by an [Event](#Event) object which includes a date,
3013
3022
  a description, flags and optional attributes.
@@ -3100,7 +3109,7 @@ Additional locales (such as `ru` or `fr`) are supported by the
3100
3109
 
3101
3110
  | Param | Type | Default |
3102
3111
  | --- | --- | --- |
3103
- | [options] | [<code>CalOptions</code>](#CalOptions) | <code>{}</code> |
3112
+ | [options] | <code>CalOptions</code> | <code>{}</code> |
3104
3113
 
3105
3114
  **Example**
3106
3115
  ```js
@@ -3122,7 +3131,7 @@ for (const ev of events) {
3122
3131
  ```
3123
3132
  <a name="HebrewCalendar.getBirthdayOrAnniversary"></a>
3124
3133
 
3125
- ### HebrewCalendar.getBirthdayOrAnniversary(hyear, gdate) ⇒ [<code>HDate</code>](#HDate)
3134
+ ### HebrewCalendar.getBirthdayOrAnniversary(hyear, gdate) ⇒ [<code>HDate</code>](#HDate) \| <code>undefined</code>
3126
3135
  Calculates a birthday or anniversary (non-yahrzeit).
3127
3136
  `hyear` must be after original `gdate` of anniversary.
3128
3137
  Returns `undefined` when requested year preceeds or is same as original year.
@@ -3141,7 +3150,7 @@ has his birthday postponed until the first of the following month in
3141
3150
  years where that day does not occur. [Calendrical Calculations p. 111]
3142
3151
 
3143
3152
  **Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)
3144
- **Returns**: [<code>HDate</code>](#HDate) - anniversary occurring in `hyear`
3153
+ **Returns**: [<code>HDate</code>](#HDate) \| <code>undefined</code> - anniversary occurring in `hyear`
3145
3154
 
3146
3155
  | Param | Type | Description |
3147
3156
  | --- | --- | --- |
@@ -3157,7 +3166,7 @@ console.log(hd.greg().toLocaleDateString('en-US')); // '3/26/2020'
3157
3166
  ```
3158
3167
  <a name="HebrewCalendar.getYahrzeit"></a>
3159
3168
 
3160
- ### HebrewCalendar.getYahrzeit(hyear, gdate) ⇒ [<code>HDate</code>](#HDate)
3169
+ ### HebrewCalendar.getYahrzeit(hyear, gdate) ⇒ [<code>HDate</code>](#HDate) \| <code>undefined</code>
3161
3170
  Calculates yahrzeit.
3162
3171
  `hyear` must be after original `gdate` of death.
3163
3172
  Returns `undefined` when requested year preceeds or is same as original year.
@@ -3184,7 +3193,7 @@ There are several cases:
3184
3193
  of the date of death. [Calendrical Calculations p. 113]
3185
3194
 
3186
3195
  **Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)
3187
- **Returns**: [<code>HDate</code>](#HDate) - anniversary occurring in hyear
3196
+ **Returns**: [<code>HDate</code>](#HDate) \| <code>undefined</code> - anniversary occurring in hyear
3188
3197
 
3189
3198
  | Param | Type | Description |
3190
3199
  | --- | --- | --- |
@@ -3200,7 +3209,7 @@ console.log(hd.greg().toLocaleDateString('en-US')); // '2/25/2020'
3200
3209
  ```
3201
3210
  <a name="HebrewCalendar.getHolidaysForYear"></a>
3202
3211
 
3203
- ### HebrewCalendar.getHolidaysForYear(year) ⇒ <code>Map.&lt;string, Array.&lt;Event&gt;&gt;</code>
3212
+ ### HebrewCalendar.getHolidaysForYear(year) ⇒ <code>HolidayYearMap</code>
3204
3213
  Lower-level holidays interface, which returns a `Map` of `Event`s indexed by
3205
3214
  `HDate.toString()`. These events must filtered especially for `flags.IL_ONLY`
3206
3215
  or `flags.CHUL_ONLY` depending on Israel vs. Diaspora holiday scheme.
@@ -3213,7 +3222,7 @@ or `flags.CHUL_ONLY` depending on Israel vs. Diaspora holiday scheme.
3213
3222
 
3214
3223
  <a name="HebrewCalendar.getHolidaysForYearArray"></a>
3215
3224
 
3216
- ### HebrewCalendar.getHolidaysForYearArray(year, il) ⇒ [<code>Array.&lt;Event&gt;</code>](#Event)
3225
+ ### HebrewCalendar.getHolidaysForYearArray(year, il) ⇒ [<code>Array.&lt;HolidayEvent&gt;</code>](#HolidayEvent)
3217
3226
  Returns an array of holidays for the year
3218
3227
 
3219
3228
  **Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)
@@ -3225,7 +3234,7 @@ Returns an array of holidays for the year
3225
3234
 
3226
3235
  <a name="HebrewCalendar.getHolidaysOnDate"></a>
3227
3236
 
3228
- ### HebrewCalendar.getHolidaysOnDate(date, [il]) ⇒ [<code>Array.&lt;Event&gt;</code>](#Event)
3237
+ ### HebrewCalendar.getHolidaysOnDate(date, [il]) ⇒ [<code>Array.&lt;HolidayEvent&gt;</code>](#HolidayEvent) \| <code>undefined</code>
3229
3238
  Returns an array of Events on this date (or `undefined` if no events)
3230
3239
 
3231
3240
  **Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)
@@ -3251,7 +3260,7 @@ Eruv Tavshilin
3251
3260
 
3252
3261
  ### HebrewCalendar.reformatTimeStr(timeStr, suffix, options) ⇒ <code>string</code>
3253
3262
  Helper function to format a 23-hour (00:00-23:59) time in US format ("8:13pm") or
3254
- keep as "20:13" for any other locale/country. Uses [CalOptions](#CalOptions) to determine
3263
+ keep as "20:13" for any other locale/country. Uses [CalOptions](CalOptions) to determine
3255
3264
  locale.
3256
3265
  If `options.hour12` is `false`, locale is ignored and always returns 24-hour time.
3257
3266
  If `options.hour12` is `true`, locale is ignored and always returns 12-hour time.
@@ -3262,7 +3271,7 @@ If `options.hour12` is `true`, locale is ignored and always returns 12-hour time
3262
3271
  | --- | --- | --- |
3263
3272
  | timeStr | <code>string</code> | original time like "20:30" |
3264
3273
  | suffix | <code>string</code> | "p" or "pm" or " P.M.". Add leading space if you want it |
3265
- | options | [<code>CalOptions</code>](#CalOptions) | |
3274
+ | options | <code>CalOptions</code> | |
3266
3275
 
3267
3276
  <a name="HebrewCalendar.version"></a>
3268
3277
 
@@ -3306,7 +3315,7 @@ The number is one of the following values:
3306
3315
 
3307
3316
  <a name="HebrewCalendar.tachanun"></a>
3308
3317
 
3309
- ### HebrewCalendar.tachanun(hdate, il) ⇒ [<code>TachanunResult</code>](#TachanunResult)
3318
+ ### HebrewCalendar.tachanun(hdate, il) ⇒ <code>TachanunResult</code>
3310
3319
  Return details on what Tachanun (or Tzidchatcha on Shabbat) is said on `hdate`.
3311
3320
 
3312
3321
  Tachanun is not said on Rosh Chodesh, the month of Nisan, Lag Baomer,
@@ -3485,13 +3494,6 @@ Transliterated names of holidays, used by `Event.getDesc()`
3485
3494
  | YOM_KIPPUR | <code>string</code> | <code>&quot;YOM_KIPPUR&quot;</code> | Yom Kippur |
3486
3495
  | YOM_YERUSHALAYIM | <code>string</code> | <code>&quot;YOM_YERUSHALAYIM&quot;</code> | Yom Yerushalayim |
3487
3496
 
3488
- <a name="HolidayDesc"></a>
3489
-
3490
- ## HolidayDesc : <code>enum</code>
3491
- Transliterated names of holidays, used by `Event.getDesc()`
3492
-
3493
- **Kind**: global enum
3494
- **Read only**: true
3495
3497
  <a name="parshiot"></a>
3496
3498
 
3497
3499
  ## parshiot : <code>Array.&lt;string&gt;</code>
@@ -3500,6 +3502,12 @@ parshiot[0] == 'Bereshit', parshiot[1] == 'Noach', parshiot[52] == "Ha'azinu".
3500
3502
 
3501
3503
  **Kind**: global constant
3502
3504
  **Read only**: true
3505
+ <a name="version"></a>
3506
+
3507
+ ## version
3508
+ DO NOT EDIT THIS AUTO-GENERATED FILE!
3509
+
3510
+ **Kind**: global constant
3503
3511
  <a name="hebrew2abs"></a>
3504
3512
 
3505
3513
  ## hebrew2abs(year, month, day) ⇒ <code>number</code>
@@ -3711,6 +3719,12 @@ Returns an emoji number symbol with a circle, for example `㊲`
3711
3719
  | --- | --- |
3712
3720
  | omerDay | the day of the omer, 1-49 inclusive |
3713
3721
 
3722
+ <a name="molad"></a>
3723
+
3724
+ ## molad()
3725
+ Calculates the molad for a Hebrew month
3726
+
3727
+ **Kind**: global function
3714
3728
  <a name="getPseudoISO"></a>
3715
3729
 
3716
3730
  ## getPseudoISO(tzid, date) ⇒ <code>string</code>
@@ -3763,57 +3777,3 @@ Similar to `string.padStart(2, '0')`.
3763
3777
  | --- | --- |
3764
3778
  | number | <code>number</code> |
3765
3779
 
3766
- <a name="CalOptions"></a>
3767
-
3768
- ## CalOptions : <code>Object</code>
3769
- Options to configure which events are returned
3770
-
3771
- **Kind**: global typedef
3772
- **Properties**
3773
-
3774
- | Name | Type | Description |
3775
- | --- | --- | --- |
3776
- | [location] | [<code>Location</code>](#Location) | latitude/longitude/tzid used for candle-lighting |
3777
- | [year] | <code>number</code> | Gregorian or Hebrew year |
3778
- | [isHebrewYear] | <code>boolean</code> | to interpret year as Hebrew year |
3779
- | [month] | <code>number</code> | Gregorian or Hebrew month (to filter results to a single month) |
3780
- | [numYears] | <code>number</code> | generate calendar for multiple years (default 1) |
3781
- | [start] | <code>Date</code> \| [<code>HDate</code>](#HDate) \| <code>number</code> | use specific start date (requires end date) |
3782
- | [end] | <code>Date</code> \| [<code>HDate</code>](#HDate) \| <code>number</code> | use specific end date (requires start date) |
3783
- | [candlelighting] | <code>boolean</code> | calculate candle-lighting and havdalah times |
3784
- | [candleLightingMins] | <code>number</code> | minutes before sundown to light candles (default 18) |
3785
- | [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 suppressed. |
3786
- | [havdalahDeg] | <code>number</code> | degrees for solar depression for Havdalah. Default is 8.5 degrees for 3 small stars. use 7.083 degrees for 3 medium-sized stars (observed by Dr. Baruch (Berthold) Cohn in his luach published in France in 1899). If `0`, Havdalah times are suppressed. |
3787
- | [fastEndDeg] | <code>number</code> | degrees for solar depression for end of fast days. Default is 7.083 degrees for 3 medium-sized stars. Other commonly-used values include 6.45 degrees, as calculated by Rabbi Yechiel Michel Tucazinsky. |
3788
- | [useElevation] | <code>boolean</code> | use elevation for calculations (default `false`). If `true`, use elevation to affect the calculation of all sunrise/sunset based zmanim. Note: there are some zmanim such as degree-based zmanim that are driven by the amount of light in the sky and are not impacted by elevation. These zmanim intentionally do not support elevation adjustment. |
3789
- | [sedrot] | <code>boolean</code> | calculate parashah hashavua on Saturdays |
3790
- | [il] | <code>boolean</code> | Israeli holiday and sedra schedule |
3791
- | [noMinorFast] | <code>boolean</code> | suppress minor fasts |
3792
- | [noModern] | <code>boolean</code> | suppress modern holidays |
3793
- | [noRoshChodesh] | <code>boolean</code> | suppress Rosh Chodesh |
3794
- | [shabbatMevarchim] | <code>boolean</code> | add Shabbat Mevarchim |
3795
- | [noSpecialShabbat] | <code>boolean</code> | suppress Special Shabbat |
3796
- | [noHolidays] | <code>boolean</code> | suppress regular holidays |
3797
- | [omer] | <code>boolean</code> | include Days of the Omer |
3798
- | [molad] | <code>boolean</code> | include event announcing the molad |
3799
- | [ashkenazi] | <code>boolean</code> | use Ashkenazi transliterations for event titles (default Sephardi transliterations) |
3800
- | [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 |
3801
- | [addHebrewDates] | <code>boolean</code> | print the Hebrew date for the entire date range |
3802
- | [addHebrewDatesForEvents] | <code>boolean</code> | print the Hebrew date for dates with some events |
3803
- | [mask] | <code>number</code> | use bitmask from `flags` to filter events |
3804
- | [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) |
3805
- | [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. |
3806
- | [dailyLearning] | <code>Object.&lt;string, any&gt;</code> | map of options to enable daily study calendars such as `dafYomi`, `mishnaYomi`, `nachYomi` with value `true`. For `yerushalmi` the value should be a `number` for edition (`1` for Vilna, `2` for Schottenstein). |
3807
-
3808
- <a name="TachanunResult"></a>
3809
-
3810
- ## TachanunResult : <code>Object</code>
3811
- **Kind**: global typedef
3812
- **Properties**
3813
-
3814
- | Name | Type | Description |
3815
- | --- | --- | --- |
3816
- | shacharit | <code>boolean</code> | Tachanun is said at Shacharit |
3817
- | mincha | <code>boolean</code> | Tachanun is said at Mincha |
3818
- | allCongs | <code>boolean</code> | All congregations say Tachanun on the day |
3819
-