@hebcal/core 6.6.0 → 6.8.0

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.
Files changed (152) hide show
  1. package/README.md +4 -4
  2. package/dist/bundle.js +224 -95
  3. package/dist/bundle.js.map +1 -1
  4. package/dist/bundle.min.js +18 -18
  5. package/dist/bundle.min.js.map +1 -1
  6. package/dist/esm/CalOptions.d.ts +15 -3
  7. package/dist/esm/DailyLearning.js +1 -1
  8. package/dist/esm/HebrewDateEvent.js +1 -1
  9. package/dist/esm/HolidayEvent.d.ts +2 -2
  10. package/dist/esm/HolidayEvent.js +3 -5
  11. package/dist/esm/HolidayEvent.js.map +1 -1
  12. package/dist/esm/MevarchimChodeshEvent.js +1 -1
  13. package/dist/esm/ParshaEvent.js +16 -6
  14. package/dist/esm/ParshaEvent.js.map +1 -1
  15. package/dist/esm/TimedEvent.js +1 -1
  16. package/dist/esm/TimedEvent.js.map +1 -1
  17. package/dist/esm/YomKippurKatanEvent.js +1 -1
  18. package/dist/esm/ashkenazi.po.js +2 -2
  19. package/dist/esm/ashkenazi.po.js.map +1 -1
  20. package/dist/esm/calendar.js +17 -23
  21. package/dist/esm/calendar.js.map +1 -1
  22. package/dist/esm/candles.d.ts +8 -3
  23. package/dist/esm/candles.js +65 -11
  24. package/dist/esm/candles.js.map +1 -1
  25. package/dist/esm/cities.json.js +1 -1
  26. package/dist/esm/event.js +2 -2
  27. package/dist/esm/event.js.map +1 -1
  28. package/dist/esm/getStartAndEnd.js +8 -6
  29. package/dist/esm/getStartAndEnd.js.map +1 -1
  30. package/dist/esm/hallel.js +1 -1
  31. package/dist/esm/he-x-NoNikud.po.js +1 -1
  32. package/dist/esm/he.po.js +1 -1
  33. package/dist/esm/hebcal.js +1 -1
  34. package/dist/esm/holidays.js +6 -5
  35. package/dist/esm/holidays.js.map +1 -1
  36. package/dist/esm/index.js +1 -1
  37. package/dist/esm/isAssurBemlacha.js +1 -1
  38. package/dist/esm/isAveilut.js +1 -1
  39. package/dist/esm/isFastDay.js +1 -1
  40. package/dist/esm/locale.js +1 -1
  41. package/dist/esm/location.js +12 -13
  42. package/dist/esm/location.js.map +1 -1
  43. package/dist/esm/modern.js +1 -1
  44. package/dist/esm/molad.js +5 -5
  45. package/dist/esm/molad.js.map +1 -1
  46. package/dist/esm/moladBase.js +1 -1
  47. package/dist/esm/moladDate.js +1 -1
  48. package/dist/esm/moladDate.js.map +1 -1
  49. package/dist/esm/omer.js +1 -1
  50. package/dist/esm/parshaName.js +1 -1
  51. package/dist/esm/parshaYear.js +1 -1
  52. package/dist/esm/pkgVersion.d.ts +1 -1
  53. package/dist/esm/pkgVersion.js +2 -2
  54. package/dist/esm/pkgVersion.js.map +1 -1
  55. package/dist/esm/reformatTimeStr.js +1 -1
  56. package/dist/esm/reformatTimeStr.js.map +1 -1
  57. package/dist/esm/sedra.d.ts +14 -0
  58. package/dist/esm/sedra.js +70 -13
  59. package/dist/esm/sedra.js.map +1 -1
  60. package/dist/esm/sefira.json.js +1 -1
  61. package/dist/esm/staticHolidays.js +1 -1
  62. package/dist/esm/string.js +1 -1
  63. package/dist/esm/tachanun.js +1 -1
  64. package/dist/esm/tachanun.js.map +1 -1
  65. package/dist/esm/zmanim.js +2 -3
  66. package/dist/esm/zmanim.js.map +1 -1
  67. package/package.json +14 -17
  68. package/po/ashkenazi.po +1 -12
  69. package/dist/eslint.config.d.mts +0 -83
  70. package/dist/eslint.config.mjs +0 -29
  71. package/dist/po2json.d.ts +0 -1
  72. package/dist/po2json.js +0 -40
  73. package/dist/src/CalOptions.d.ts +0 -171
  74. package/dist/src/CalOptions.js +0 -1
  75. package/dist/src/DailyLearning.d.ts +0 -69
  76. package/dist/src/DailyLearning.js +0 -92
  77. package/dist/src/HebrewDateEvent.d.ts +0 -37
  78. package/dist/src/HebrewDateEvent.js +0 -72
  79. package/dist/src/HolidayEvent.d.ts +0 -117
  80. package/dist/src/HolidayEvent.js +0 -236
  81. package/dist/src/MevarchimChodeshEvent.d.ts +0 -26
  82. package/dist/src/MevarchimChodeshEvent.js +0 -52
  83. package/dist/src/ParshaEvent.d.ts +0 -24
  84. package/dist/src/ParshaEvent.js +0 -50
  85. package/dist/src/TimedEvent.d.ts +0 -76
  86. package/dist/src/TimedEvent.js +0 -134
  87. package/dist/src/YomKippurKatanEvent.d.ts +0 -23
  88. package/dist/src/YomKippurKatanEvent.js +0 -40
  89. package/dist/src/ashkenazi.po.d.ts +0 -84
  90. package/dist/src/ashkenazi.po.js +0 -1
  91. package/dist/src/calendar.d.ts +0 -112
  92. package/dist/src/calendar.js +0 -721
  93. package/dist/src/candles.d.ts +0 -57
  94. package/dist/src/candles.js +0 -185
  95. package/dist/src/cities.json +0 -67
  96. package/dist/src/event.d.ts +0 -233
  97. package/dist/src/event.js +0 -295
  98. package/dist/src/getStartAndEnd.d.ts +0 -6
  99. package/dist/src/getStartAndEnd.js +0 -105
  100. package/dist/src/hallel.d.ts +0 -6
  101. package/dist/src/hallel.js +0 -39
  102. package/dist/src/he-x-NoNikud.po.d.ts +0 -28
  103. package/dist/src/he-x-NoNikud.po.js +0 -1
  104. package/dist/src/he.po.d.ts +0 -217
  105. package/dist/src/he.po.js +0 -1
  106. package/dist/src/hebcal.d.ts +0 -338
  107. package/dist/src/hebcal.js +0 -413
  108. package/dist/src/holidays.d.ts +0 -41
  109. package/dist/src/holidays.js +0 -324
  110. package/dist/src/index.d.ts +0 -30
  111. package/dist/src/index.js +0 -29
  112. package/dist/src/isAssurBemlacha.d.ts +0 -29
  113. package/dist/src/isAssurBemlacha.js +0 -82
  114. package/dist/src/isAveilut.d.ts +0 -22
  115. package/dist/src/isAveilut.js +0 -48
  116. package/dist/src/isFastDay.d.ts +0 -21
  117. package/dist/src/isFastDay.js +0 -31
  118. package/dist/src/locale.d.ts +0 -1
  119. package/dist/src/locale.js +0 -11
  120. package/dist/src/location.d.ts +0 -167
  121. package/dist/src/location.js +0 -342
  122. package/dist/src/modern.d.ts +0 -18
  123. package/dist/src/modern.js +0 -59
  124. package/dist/src/molad.d.ts +0 -164
  125. package/dist/src/molad.js +0 -298
  126. package/dist/src/moladBase.d.ts +0 -15
  127. package/dist/src/moladBase.js +0 -78
  128. package/dist/src/moladDate.d.ts +0 -12
  129. package/dist/src/moladDate.js +0 -58
  130. package/dist/src/omer.d.ts +0 -128
  131. package/dist/src/omer.js +0 -385
  132. package/dist/src/parshaName.d.ts +0 -2
  133. package/dist/src/parshaName.js +0 -13
  134. package/dist/src/parshaYear.d.ts +0 -20
  135. package/dist/src/parshaYear.js +0 -35
  136. package/dist/src/pkgVersion.d.ts +0 -2
  137. package/dist/src/pkgVersion.js +0 -2
  138. package/dist/src/reformatTimeStr.d.ts +0 -8
  139. package/dist/src/reformatTimeStr.js +0 -47
  140. package/dist/src/sedra.d.ts +0 -175
  141. package/dist/src/sedra.js +0 -563
  142. package/dist/src/sefira.json +0 -63
  143. package/dist/src/staticHolidays.d.ts +0 -192
  144. package/dist/src/staticHolidays.js +0 -637
  145. package/dist/src/string.d.ts +0 -2
  146. package/dist/src/string.js +0 -6
  147. package/dist/src/tachanun.d.ts +0 -29
  148. package/dist/src/tachanun.js +0 -120
  149. package/dist/src/zmanim.d.ts +0 -620
  150. package/dist/src/zmanim.js +0 -1003
  151. package/dist/version.d.ts +0 -1
  152. package/dist/version.js +0 -8
@@ -1,620 +0,0 @@
1
- import 'temporal-polyfill/global';
2
- import { GeoLocation } from '@hebcal/noaa';
3
- import { HDate } from '@hebcal/hdate';
4
- /**
5
- * Calculate halachic times (zmanim / זְמַנִּים) for a given day and location.
6
- * Calculations are available for tzeit / tzais (nightfall),
7
- * shkiah (sunset) and more.
8
- *
9
- * Zmanim are estimated using an algorithm published by the US National Oceanic
10
- * and Atmospheric Administration. The NOAA solar calculator is based on equations
11
- * from _Astronomical Algorithms_ by Jean Meeus.
12
- *
13
- * The sunrise and sunset results are theoretically accurate to within a minute for
14
- * locations between +/- 72° latitude, and within 10 minutes outside of those latitudes.
15
- * However, due to variations in atmospheric composition, temperature, pressure and
16
- * conditions, observed values may vary from calculations.
17
- * https://gml.noaa.gov/grad/solcalc/calcdetails.html
18
- *
19
- * @example
20
- * const {GeoLocation, Zmanim} = require('@hebcal/core');
21
- * const latitude = 41.822232;
22
- * const longitude = -71.448292;
23
- * const tzid = 'America/New_York';
24
- * const friday = new Date(2023, 8, 8);
25
- * const gloc = new GeoLocation(null, latitude, longitude, 0, tzid);
26
- * const zmanim = new Zmanim(gloc, friday, false);
27
- * const candleLighting = zmanim.sunsetOffset(-18, true);
28
- * const timeStr = Zmanim.formatISOWithTimeZone(tzid, candleLighting);
29
- */
30
- export declare class Zmanim {
31
- private readonly hdate;
32
- private readonly plainDate;
33
- private readonly gloc;
34
- private readonly noaa;
35
- private useElevation;
36
- /**
37
- * Initialize a Zmanim instance.
38
- * @param gloc GeoLocation including latitude, longitude, and timezone
39
- * @param date Regular or Hebrew Date. If `date` is a regular `Date`,
40
- * hours, minutes, seconds and milliseconds are ignored.
41
- * @param useElevation use elevation for calculations (default `false`).
42
- * If `true`, use elevation to affect the calculation of all sunrise/sunset based
43
- * zmanim. Note: there are some zmanim such as degree-based zmanim that are driven
44
- * by the amount of light in the sky and are not impacted by elevation.
45
- * These zmanim intentionally do not support elevation adjustment.
46
- */
47
- constructor(gloc: GeoLocation, date: Date | HDate, useElevation: boolean);
48
- /**
49
- * Returns `true` if elevation adjustment is enabled
50
- * for zmanim support elevation adjustment
51
- */
52
- getUseElevation(): boolean;
53
- /**
54
- * Enables or disables elevation adjustment for zmanim support elevation adjustment
55
- * @param useElevation
56
- */
57
- setUseElevation(useElevation: boolean): void;
58
- /**
59
- * Convenience function to get the time when sun is above or below the horizon
60
- * for a certain angle (in degrees).
61
- * This function does not support elevation adjustment.
62
- * @param angle
63
- * @param rising
64
- */
65
- timeAtAngle(angle: number, rising: boolean): Date;
66
- /**
67
- * Upper edge of the Sun appears over the eastern horizon in the morning (0.833° above horizon)
68
- * If elevation is enabled, this function will include elevation in the calculation.
69
- */
70
- sunrise(): Date;
71
- /**
72
- * Upper edge of the Sun appears over the eastern horizon in the morning (0.833° above horizon).
73
- * This function does not support elevation adjustment.
74
- */
75
- seaLevelSunrise(): Date;
76
- /**
77
- * When the upper edge of the Sun disappears below the horizon (0.833° below horizon).
78
- * If elevation is enabled, this function will include elevation in the calculation.
79
- */
80
- sunset(): Date;
81
- /**
82
- * When the upper edge of the Sun disappears below the horizon (0.833° below horizon).
83
- * This function does not support elevation adjustment.
84
- */
85
- seaLevelSunset(): Date;
86
- /**
87
- * Civil dawn; Sun is 6° below the horizon in the morning.
88
- * Because degree-based functions estimate the amount of light in the sky,
89
- * the result is not impacted by elevation.
90
- */
91
- dawn(): Date;
92
- /**
93
- * Civil dusk; Sun is 6° below the horizon in the evening.
94
- * Because degree-based functions estimate the amount of light in the sky,
95
- * the result is not impacted by elevation.
96
- */
97
- dusk(): Date;
98
- /**
99
- * Returns sunset for the previous day.
100
- * If elevation is enabled, this function will include elevation in the calculation.
101
- */
102
- gregEve(): Date;
103
- /**
104
- * @private
105
- */
106
- nightHour(): number;
107
- /**
108
- * Midday – Chatzot; Sunrise plus 6 halachic hours
109
- */
110
- chatzot(): Date;
111
- /**
112
- * Midnight – Chatzot; Sunset plus 6 halachic hours.
113
- * If elevation is enabled, this function will include elevation in the calculation.
114
- */
115
- chatzotNight(): Date;
116
- /**
117
- * Dawn – Alot haShachar; Sun is 16.1° below the horizon in the morning.
118
- * Because degree-based functions estimate the amount of light in the sky,
119
- * the result is not impacted by elevation.
120
- */
121
- alotHaShachar(): Date;
122
- /**
123
- * Dawn – Alot haShachar; calculated as 72 minutes before sunrise or
124
- * sea level sunrise.
125
- */
126
- alotHaShachar72(): Date;
127
- alotHaShachar72zdt(): Temporal.ZonedDateTime | null;
128
- /**
129
- * Earliest talis & tefillin – Misheyakir; Sun is 11.5° below the horizon in the morning.
130
- * Because degree-based functions estimate the amount of light in the sky,
131
- * the result is not impacted by elevation.
132
- */
133
- misheyakir(): Date;
134
- /**
135
- * Earliest talis & tefillin – Misheyakir Machmir; Sun is 10.2° below the horizon in the morning.
136
- * Because degree-based functions estimate the amount of light in the sky,
137
- * the result is not impacted by elevation.
138
- */
139
- misheyakirMachmir(): Date;
140
- private getShaahZmanisBasedZmanZdt;
141
- /**
142
- * Utility method for using elevation-aware sunrise/sunset
143
- * @private
144
- * @param hours
145
- */
146
- private getShaahZmanisBasedZman;
147
- /**
148
- * Latest Shema (Gra); Sunrise plus 3 halachic hours, according to the Gra.
149
- * If elevation is enabled, this function will include elevation in the calculation.
150
- */
151
- sofZmanShma(): Date;
152
- /**
153
- * Latest Shacharit (Gra); Sunrise plus 4 halachic hours, according to the Gra.
154
- *
155
- * This method returns the latest *zman tfila* (time to recite shema in the morning)
156
- * that is 4 *shaos zmaniyos* (solar hours) after sunrise or sea level sunrise
157
- * (depending on the `useElevation` setting), according
158
- * to the [GRA](https://en.wikipedia.org/wiki/Vilna_Gaon).
159
- *
160
- * If elevation is enabled, this function will include elevation in the calculation.
161
- */
162
- sofZmanTfilla(): Date;
163
- /**
164
- * This method returns the latest time for burning _chametz_ on _Erev Pesach_ according to the opinion
165
- * of the <a href="https://en.wikipedia.org/wiki/Vilna_Gaon">GRA</a>. This time is 5 hours into the day based on the
166
- * opinion of the <a href="https://en.wikipedia.org/wiki/Vilna_Gaon">GRA</a> that the day is calculated from
167
- * sunrise to sunset. This returns the time 5 * {@link #getShaahZmanisGra()} after {@link #getSeaLevelSunrise() sea
168
- * level sunrise}.
169
- * @return the <code>Date</code> of the latest time for burning _chametz_ on _Erev Pesach_. If it is not
170
- * _erev Pesach_ or the calculation can't be computed such as in the Arctic Circle where there is at least
171
- * one day a year where the sun does not rise, and one where it does not set, a <code>null</code> will be
172
- * returned.
173
- */
174
- sofZmanBiurChametzGRA(): Date;
175
- /**
176
- * Returns an array with alot (Date) and ms in hour (number)
177
- * @private
178
- */
179
- getTemporalHour72(forceSeaLevel: boolean): [Date, number];
180
- /**
181
- * Returns an array with alot (Date) and ms in hour (number)
182
- * @private
183
- */
184
- getTemporalHourByDeg(angle: number): [Date, number];
185
- /**
186
- * Latest Shema (MGA); Sunrise plus 3 halachic hours, according to Magen Avraham.
187
- * Based on the opinion of the MGA that the day is calculated from
188
- * dawn being fixed 72 minutes before sea-level sunrise, and nightfall is fixed
189
- * 72 minutes after sea-level sunset.
190
- */
191
- sofZmanShmaMGA(): Date;
192
- /**
193
- * Latest Shema (MGA); Sunrise plus 3 halachic hours, according to Magen Avraham.
194
- * Based on the opinion of the MGA that the day is calculated from
195
- * dawn to nightfall with both being 16.1° below the horizon.
196
- */
197
- sofZmanShmaMGA16Point1(): Date;
198
- /**
199
- * Latest Shema (MGA); Sunrise plus 3 halachic hours, according to Magen Avraham.
200
- * Based on the opinion of the MGA that the day is calculated from
201
- * dawn to nightfall with both being 19.8° below the horizon.
202
- *
203
- * This calculation is based on the position of the sun 90 minutes after sunset in Jerusalem
204
- * around the equinox / equilux which calculates to 19.8° below geometric zenith.
205
- * https://kosherjava.com/2022/01/12/equinox-vs-equilux-zmanim-calculations/
206
- */
207
- sofZmanShmaMGA19Point8(): Date;
208
- /**
209
- * Latest Shacharit (MGA); Sunrise plus 4 halachic hours, according to Magen Avraham
210
- */
211
- sofZmanTfillaMGA(): Date;
212
- /**
213
- * Latest Shacharit (MGA); Sunrise plus 4 halachic hours, according to Magen Avraham.
214
- * Based on the opinion of the MGA that the day is calculated from
215
- * dawn to nightfall with both being 16.1° below the horizon.
216
- */
217
- sofZmanTfillaMGA16Point1(): Date;
218
- /**
219
- * Latest Shacharit (MGA); Sunrise plus 4 halachic hours, according to Magen Avraham.
220
- * Based on the opinion of the MGA that the day is calculated from
221
- * dawn to nightfall with both being 19.8° below the horizon.
222
- *
223
- * This calculation is based on the position of the sun 90 minutes after sunset in Jerusalem
224
- * around the equinox / equilux which calculates to 19.8° below geometric zenith.
225
- * https://kosherjava.com/2022/01/12/equinox-vs-equilux-zmanim-calculations/
226
- */
227
- sofZmanTfillaMGA19Point8(): Date;
228
- /**
229
- * Earliest Mincha – Mincha Gedola (GRA); Sunrise plus 6.5 halachic hours.
230
- * If elevation is enabled, this function will include elevation in the calculation.
231
- *
232
- * This method returns the latest mincha gedola, the earliest time one can pray mincha
233
- * that is 6.5 shaos zmaniyos (solar hours) after sunrise or sea level sunrise
234
- * (depending on the `useElevation` setting), according
235
- * to the [GRA](https://en.wikipedia.org/wiki/Vilna_Gaon).
236
- *
237
- * The Ramba"m is of the opinion that it is better to delay *mincha* until
238
- * *mincha ketana* while the Ra"sh, Tur, GRA and others are of the
239
- * opinion that *mincha* can be prayed *lechatchila* starting at *mincha gedola*.
240
- */
241
- minchaGedola(): Date;
242
- /**
243
- * Earliest Mincha – Mincha Gedola (MGA); Sunrise plus 6.5 halachic hours.
244
- * If elevation is enabled, this function will include elevation in the calculation.
245
- *
246
- * This method returns the time of *mincha gedola* according to the Magen Avraham
247
- * with the day starting 72 minutes before sunrise and ending 72 minutes after sunset.
248
- * This is the earliest time to pray *mincha*.
249
- */
250
- minchaGedolaMGA(): Date;
251
- /**
252
- * Preferable earliest time to recite Minchah – Mincha Ketana; Sunrise plus 9.5 halachic hours.
253
- * If elevation is enabled, this function will include elevation in the calculation.
254
- *
255
- * This method returns *mincha ketana*, the preferred earliest time to pray *mincha* in the
256
- * opinion of the [Rambam](https://en.wikipedia.org/wiki/Maimonides) and others,
257
- * that is 9.5 *shaos zmaniyos* (solar hours) after sunrise or sea level sunrise
258
- * (depending on the `useElevation` setting), according
259
- * to the [GRA](https://en.wikipedia.org/wiki/Vilna_Gaon).
260
- */
261
- minchaKetana(): Date;
262
- /**
263
- * This method returns the time of *mincha ketana* according to the Magen Avraham
264
- * with the day starting 72 minutes before sunrise and ending 72 minutes after sunset.
265
- * This is the preferred earliest time to pray *mincha* according to the opinion of
266
- * the [Rambam](https://en.wikipedia.org/wiki/Maimonides) and others.
267
- *
268
- * If elevation is enabled, this function will include elevation in the calculation.
269
- */
270
- minchaKetanaMGA(): Date;
271
- /**
272
- * Plag haMincha; Sunrise plus 10.75 halachic hours.
273
- * If elevation is enabled, this function will include elevation in the calculation.
274
- */
275
- plagHaMincha(): Date;
276
- /**
277
- * @param [angle=8.5] optional time for solar depression.
278
- * Default is 8.5 degrees for 3 small stars, use 7.083 degrees for 3 medium-sized stars.
279
- * Because degree-based functions estimate the amount of light in the sky,
280
- * the result is not impacted by elevation.
281
- */
282
- tzeit(angle?: number): Date;
283
- tzeit72(): Temporal.ZonedDateTime | null;
284
- /**
285
- * Alias for sunrise
286
- */
287
- neitzHaChama(): Date;
288
- /**
289
- * Alias for sunset
290
- */
291
- shkiah(): Date;
292
- /**
293
- * Rabbeinu Tam holds that bein hashmashos is a specific time
294
- * between sunset and tzeis hakochavim.
295
- * One opinion on how to calculate this time is that
296
- * it is 13.5 minutes before tzies 7.083.
297
- * Because degree-based functions estimate the amount of light in the sky,
298
- * the result is not impacted by elevation.
299
- */
300
- beinHaShmashos(): Date;
301
- /**
302
- * Used by Molad based _zmanim_ to determine if _zmanim_ occur during the current day.
303
- * @return previous midnight
304
- */
305
- private getMidnightLastNight;
306
- /**
307
- * Used by Molad based _zmanim_ to determine if _zmanim_ occur during the current day.
308
- * @return following midnight
309
- */
310
- private getMidnightTonight;
311
- /**
312
- * Returns the Date of the _molad_ based time if it occurs on the current date. Since _Kiddush Levana_
313
- * can only be said during the day, there are parameters to limit it to between _alos_ and _tzais_. If
314
- * the time occurs between _alos_ and _tzais_, _tzais_ will be returned.
315
- *
316
- * @param moladBasedTime
317
- * the _molad_ based time such as _molad_, _tchilas_ and _sof zman Kiddush Levana_
318
- * @param alos
319
- * optional start of day to limit _molad_ times to the end of the night before or beginning of the next night.
320
- * Ignored if either _alos_ or _tzais_ are null.
321
- * @param tzais
322
- * optional end of day to limit _molad_ times to the end of the night before or beginning of the next night.
323
- * Ignored if either _tzais_ or _alos_ are null
324
- * @param techila
325
- * is it the start of _Kiddush Levana_ time or the end? If it is start roll it to the next _tzais_,
326
- * and if it is the end, return the end of the previous night (_alos_ passed in). Ignored if either
327
- * _alos_ or _tzais_ are null.
328
- * @return the _molad_ based time. If the _zman_ does not occur during the current date, `null` will be
329
- * returned.
330
- */
331
- private getMoladBasedTime;
332
- /**
333
- * Returns the latest time of Kiddush Levana according to the <a
334
- * href="https://en.wikipedia.org/wiki/Yaakov_ben_Moshe_Levi_Moelin">Maharil's</a> opinion that it is calculated as
335
- * halfway between _molad_ and _molad_. This adds half the 29 days, 12 hours and 793 chalakim time between
336
- * _molad_ and _molad_ (14 days, 18 hours, 22 minutes and 666 milliseconds) to the month's _molad_.
337
- * The _sof zman Kiddush Levana_ will be returned even if it occurs during the day. To limit the time to between
338
- * _tzais_ and _alos_, see {@link getSofZmanKidushLevanaBetweenMoldos}.
339
- *
340
- * @param alos
341
- * the beginning of the Jewish day. If _Kidush Levana_ occurs during the day (starting at _alos_ and
342
- * ending at _tzais_), the time returned will be alos. If either the _alos_ or _tzais_ parameters
343
- * are null, no daytime adjustment will be made.
344
- * @param tzais
345
- * the end of the Jewish day. If Kidush Levana occurs during the day (starting at alos and ending at
346
- * tzais), the time returned will be alos. If either the alos or tzais parameters are null, no daytime
347
- * adjustment will be made.
348
- * @return the Date representing the moment halfway between molad and molad. If the time occurs between
349
- * _alos_ and _tzais_, _alos_ will be returned. If the _zman_ will not occur on this
350
- * day, a `null` will be returned.
351
- */
352
- getSofZmanKidushLevanaBetweenMoldos(alos?: Temporal.ZonedDateTime | null, tzais?: Temporal.ZonedDateTime | null): Temporal.ZonedDateTime | null;
353
- /**
354
- * Returns the latest time of _Kiddush Levana_ calculated as 15 days after the molad. This is the opinion of
355
- * the Shulchan Aruch (Orach Chaim 426). It should be noted that some opinions hold that the
356
- * <a href="https://en.wikipedia.org/wiki/Moses_Isserles">Rema</a> who brings down the opinion of the <a
357
- * href="https://en.wikipedia.org/wiki/Yaakov_ben_Moshe_Levi_Moelin">Maharil's</a> of calculating
358
- * {@link getSofZmanKidushLevanaBetweenMoldos half way between _molad_ and _molad_} is of
359
- * the opinion that the Mechaber agrees to his opinion. Also see the Aruch Hashulchan. For additional details on the subject,
360
- * See Rabbi Dovid Heber's very detailed write-up in Siman Daled (chapter 4) of <a href="https://hebrewbooks.org/53000">Shaarei
361
- * Zmanim</a>. The _sof zman Kiddush Levana_ will be returned even if it occurs during the day. To limit the time to
362
- * between _tzais_ and _alos_, see {@link getSofZmanKidushLevana15Days}.
363
- *
364
- * @return the Date representing the moment 15 days after the _molad_. If the time occurs between
365
- * _alos_ and _tzais_, _alos_ will be returned. If the _zman_ will not occur on this day, a
366
- * `null` will be returned.
367
- *
368
- *
369
- */
370
- getSofZmanKidushLevana15Days(alos?: Temporal.ZonedDateTime | null, tzais?: Temporal.ZonedDateTime | null): Temporal.ZonedDateTime | null;
371
- /**
372
- * Returns the earliest time of _Kiddush Levana_ according to <a href=
373
- * "https://en.wikipedia.org/wiki/Yonah_Gerondi">Rabbeinu Yonah</a>'s opinion that it can be said 3 days after the _molad_.
374
- * If the time of _tchilas zman Kiddush Levana_ occurs during the day (between _alos_ and _tzais_ passed to
375
- * this method) it will return the following _tzais_. If null is passed for either _alos_ or _tzais_, the actual
376
- * _tchilas zman Kiddush Levana_ will be returned, regardless of if it is during the day or not.
377
- *
378
- * @param alos
379
- * the beginning of the Jewish day. If Kidush Levana occurs during the day (starting at _alos_ and ending
380
- * at _tzais_), the time returned will be _tzais_. If either the _alos_ or _tzais_ parameters
381
- * are null, no daytime adjustment will be made.
382
- * @param tzais
383
- * the end of the Jewish day. If _Kidush Levana_ occurs during the day (starting at _alos_ and ending at
384
- * _tzais_), the time returned will be _tzais_. If either the _alos_ or _tzais_ parameters
385
- * are null, no daytime adjustment will be made.
386
- *
387
- * @return the Date representing the moment 3 days after the molad. If the time occurs between _alos_ and
388
- * _tzais_, _tzais_ will be returned. If the _zman_ will not occur on this day, a
389
- * `null` will be returned.
390
- */
391
- getTchilasZmanKidushLevana3Days(alos?: Temporal.ZonedDateTime | null, tzais?: Temporal.ZonedDateTime | null): Temporal.ZonedDateTime | null;
392
- /**
393
- * Returns the point in time of _Molad_ as a <code>Date</code> Object. For the traditional day of week, hour,
394
- * minute and chalakim, {@link Molad.getInstant()} and the not yet completed
395
- * {@link HebrewDateFormatter} that will have formatting for this.
396
- *
397
- * @return the Date representing the moment of the molad. If the _molad_ does not occur on this day, a
398
- * `null` will be returned.
399
- *
400
- */
401
- getZmanMolad(): Temporal.ZonedDateTime | null;
402
- /**
403
- * Returns the earliest time of _Kiddush Levana_ according to the opinions that it should not be said until 7
404
- * days after the _molad_. The time will be returned even if it occurs during the day when _Kiddush Levana_
405
- * can't be recited. Use {@link getTchilasZmanKidushLevana7Days} if you want to limit the time to night hours.
406
- *
407
- * @return the Date representing the moment 7 days after the molad regardless of it is day or night. If the _zman_
408
- * will not occur on this day, a `null` will be returned.
409
- */
410
- getTchilasZmanKidushLevana7Days(alos?: Temporal.ZonedDateTime | null, tzais?: Temporal.ZonedDateTime | null): Temporal.ZonedDateTime | null;
411
- /**
412
- * A method that returns the <a href="https://en.wikipedia.org/wiki/Shneur_Zalman_of_Liadi">Baal Hatanya</a>'s
413
- * _netz amiti_ (sunrise) without
414
- * elevation adjustment. This forms the base for the Baal Hatanya's dawn-based calculations that are
415
- * calculated as a dip below the horizon before sunrise.
416
- *
417
- * According to the Baal Hatanya, _netz amiti_, or true (halachic) sunrise, is when the top of the sun's
418
- * disk is visible at an elevation similar to the mountains of Eretz Yisrael. The time is calculated as the point at which
419
- * the center of the sun's disk is 1.583&deg; below the horizon. This degree-based calculation can be found in Rabbi Shalom
420
- * DovBer Levine's commentary on The <a href="https://www.chabadlibrary.org/books/pdf/Seder-Hachnosas-Shabbos.pdf">Baal
421
- * Hatanya's Seder Hachnasas Shabbos</a>. From an elevation of 546 meters, the top of <a href=
422
- * "https://en.wikipedia.org/wiki/Mount_Carmel">Har Hacarmel</a>, the sun disappears when it is 1&deg; 35' or 1.583&deg;
423
- * below the sea level horizon. This in turn is based on the Gemara <a href=
424
- * "https://hebrewbooks.org/shas.aspx?mesechta=2&daf=35">Shabbos 35a</a>. There are other opinions brought down by
425
- * Rabbi Levine, including Rabbi Yosef Yitzchok Feigelstock who calculates it as the degrees below the horizon 4 minutes after
426
- * sunset in Yerushalayim (on the equinox). That is brought down as 1.583&deg;. This is identical to the 1&deg; 35' _zman_
427
- * and is probably a typo and should be 1.683&deg;. These calculations are used by most <a href=
428
- * "https://en.wikipedia.org/wiki/Chabad">Chabad</a> calendars that use the Baal Hatanya's _zmanim_. See
429
- * <a href="https://www.chabad.org/library/article_cdo/aid/3209349/jewish/About-Our-Zmanim-Calculations.htm">About Our
430
- * _Zmanim_ Calculations @ Chabad.org</a>.
431
- *
432
- * Note: _netz amiti_ is used only for calculating certain _zmanim_, and is intentionally unpublished. For
433
- * practical purposes, daytime _mitzvos_ like _shofar_ and _lulav_ should not be done until after the
434
- * published time for _netz_ / sunrise.
435
- *
436
- * @return the <code>Date</code> representing the exact sea level _netz amiti_ (sunrise) time. If the calculation can't be
437
- * computed such as in the Arctic Circle where there is at least one day a year where the sun does not rise, and one
438
- * where it does not set, a `null` will be returned. See detailed explanation on top of the page.
439
- *
440
- * @see ZENITH_1_POINT_583
441
- */
442
- private getSunriseBaalHatanya;
443
- /**
444
- * A method that returns the <a href="https://en.wikipedia.org/wiki/Shneur_Zalman_of_Liadi">Baal Hatanya</a>'s
445
- * _shkiah amiti_ (sunset) without
446
- * elevation adjustment. This forms the base for the Baal Hatanya's dusk-based calculations that are calculated
447
- * as a dip below the horizon after sunset.
448
- *
449
- * According to the Baal Hatanya, _shkiah amiti_, true (_halachic_) sunset, is when the top of the
450
- * sun's disk disappears from view at an elevation similar to the mountains of _Eretz Yisrael_.
451
- * This time is calculated as the point at which the center of the sun's disk is 1.583 degrees below the horizon.
452
- *
453
- * Note: _shkiah amiti_ is used only for calculating certain _zmanim_, and is intentionally unpublished. For
454
- * practical purposes, all daytime mitzvos should be completed before the published time for _shkiah_ / sunset.
455
- *
456
- * For further explanation of the calculations used for the Baal Hatanya's _zmanim_ in this library, see
457
- * <a href="https://www.chabad.org/library/article_cdo/aid/3209349/jewish/About-Our-Zmanim-Calculations.htm">About Our
458
- * _Zmanim_ Calculations @ Chabad.org</a>.
459
- *
460
- * @return the <code>Date</code> representing the exact sea level _shkiah amiti_ (sunset) time. If the calculation
461
- * can't be computed such as in the Arctic Circle where there is at least one day a year where the sun does not
462
- * rise, and one where it does not set, a `null` will be returned.
463
- *
464
- * @see ZENITH_1_POINT_583
465
- */
466
- private getSunsetBaalHatanya;
467
- /**
468
- * Returns the <a href="https://en.wikipedia.org/wiki/Shneur_Zalman_of_Liadi">Baal Hatanya</a>'s _alos_
469
- * (dawn) calculated as the time when the sun is 16.9&deg; below the eastern {@link GEOMETRIC_ZENITH geometric horizon}
470
- * before {@link getSunrise() sunrise}.
471
- *
472
- * The zenith of 16.9&deg; below is based on the calculation that the time between dawn
473
- * and _netz amiti_ (sunrise) is 72 minutes, the time that is takes to walk 4 mil at 18 minutes
474
- * a mil (<a href="https://en.wikipedia.org/wiki/Maimonides">Rambam</a> and others). The sun's position at 72
475
- * minutes before {@link getSunriseBaalHatanya _netz amiti_ (sunrise)} in Jerusalem <a href=
476
- * "https://kosherjava.com/2022/01/12/equinox-vs-equilux-zmanim-calculations/">around the equinox / equilux</a> is
477
- * 16.9&deg; below {@link GEOMETRIC_ZENITH geometric zenith}.
478
- *
479
- * @return The <code>Date</code> of dawn. If the calculation can't be computed such as northern and southern
480
- * locations even south of the Arctic Circle and north of the Antarctic Circle where the sun may not reach
481
- * low enough below the horizon for this calculation, a `null` will be returned. */
482
- alosBaalHatanya(): Date;
483
- private getShaahZmanisBaalHatanya;
484
- /**
485
- * This method returns the latest _zman krias shema_ (time to recite Shema in the morning). This time is 3
486
- * {@link shaahZmanisBaalHatanya() _shaos zmaniyos_} (solar hours) after {@link getSunriseBaalHatanya()
487
- * _netz amiti_ (sunrise)} based on the opinion of the Baal Hatanya that the day is calculated from
488
- * sunrise to sunset. This returns the time 3 * {@link getShaahZmanisBaalHatanya()} after {@link getSunriseBaalHatanya()
489
- * _netz amiti_ (sunrise)}.
490
- *
491
- * @return the <code>Date</code> of the latest _zman shema_ according to the Baal Hatanya. If the calculation
492
- * can't be computed such as in the Arctic Circle where there is at least one day a year where the sun does
493
- * not rise, and one where it does not set, a `null` will be returned.
494
- */
495
- sofZmanShmaBaalHatanya(): Date;
496
- /**
497
- * This method returns the latest _zman tfilah_ (time to recite the morning prayers). This time is 4
498
- * hours into the day based on the opinion of the Baal Hatanya that the day is
499
- * calculated from sunrise to sunset. This returns the time 4 * {@link getShaahZmanisBaalHatanya()} after
500
- * {@link getSunriseBaalHatanya() _netz amiti_ (sunrise)}.
501
- *
502
- * @return the <code>Date</code> of the latest _zman tfilah_. If the calculation can't be computed such as in
503
- * the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it does
504
- * not set, a `null` will be returned.
505
- */
506
- sofZmanTfilaBaalHatanya(): Date;
507
- /**
508
- * This method returns the time of _mincha gedola_. _Mincha gedola_ is the earliest time one can pray
509
- * _mincha_. The <a href="https://en.wikipedia.org/wiki/Maimonides">Rambam</a> is of the opinion that it is
510
- * better to delay _mincha_ until {@link minchaKetanaBaalHatanya() _mincha ketana_} while the
511
- * <a href="https://en.wikipedia.org/wiki/Asher_ben_Jehiel">Ra"sh</a>,
512
- * <a href="https://en.wikipedia.org/wiki/Jacob_ben_Asher">Tur</a>, <a href=
513
- * "https://en.wikipedia.org/wiki/Vilna_Gaon">GRA</a> and others are of the opinion that _mincha_ can be prayed
514
- * _lechatchila_ starting at _mincha gedola_. This is calculated as 6.5 {@link getShaahZmanisBaalHatanya()
515
- * sea level solar hours} after {@link getSunriseBaalHatanya() _netz amiti_ (sunrise)}. This calculation is based
516
- * on the opinion of the Baal Hatanya that the day is calculated from sunrise to sunset. This returns the time 6.5
517
- * * {@link getShaahZmanisBaalHatanya()} after {@link getSunriseBaalHatanya() _netz amiti_ ("real" sunrise)}.
518
- * @return the <code>Date</code> of the time of _mincha gedola_ according to the Baal Hatanya. If the calculation
519
- * can't be computed such as in the Arctic Circle where there is at least one day a year where the sun does not rise,
520
- * and one where it does not set, a `null` will be returned.
521
- */
522
- minchaGedolaBaalHatanya(): Date;
523
- /**
524
- * This method returns the time of _mincha ketana_. This is the preferred earliest time to pray
525
- * _mincha_ in the opinion of the <a href="https://en.wikipedia.org/wiki/Maimonides">Rambam</a> and others.
526
- * For more information on this see the documentation on {@link minchaGedolaBaalHatanya() _mincha gedola_}.
527
- * This is calculated as 9.5 sea level solar hours after {@link getSunriseBaalHatanya
528
- * _netz amiti_ (sunrise)}. This calculation is calculated based on the opinion of the Baal Hatanya that the
529
- * day is calculated from sunrise to sunset. This returns the time 9.5 * after
530
- * _netz amiti_ (sunrise).
531
- *
532
- * @return the <code>Date</code> of the time of _mincha ketana_. If the calculation can't be computed such as
533
- * in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it
534
- * does not set, a `null` will be returned.
535
- */
536
- minchaKetanaBaalHatanya(): Date;
537
- /**
538
- * This method returns the time of _plag hamincha_. This is calculated as 10.75 hours after sunrise. This
539
- * calculation is based on the opinion of the Baal Hatanya that the day is calculated
540
- * from sunrise to sunset. This returns the time 10.75 * {@link getShaahZmanisBaalHatanya()} after
541
- * {@link getSunriseBaalHatanya() _netz amiti_ (sunrise)}.
542
- *
543
- * @return the <code>Date</code> of the time of _plag hamincha_. If the calculation can't be computed such as
544
- * in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it
545
- * does not set, a `null` will be returned.
546
- */
547
- plagHaminchaBaalHatanya(): Date;
548
- /**
549
- * A method that returns _tzais_ (nightfall) when the sun is 6&deg; below the western geometric horizon
550
- * (90&deg;) after {@link getSunset() sunset}. For information on the source of this calculation see
551
- * {@link ZENITH_6_DEGREES}.
552
- *
553
- * @return The <code>Date</code> of nightfall. If the calculation can't be computed such as northern and southern
554
- * locations even south of the Arctic Circle and north of the Antarctic Circle where the sun may not reach
555
- * low enough below the horizon for this calculation, a `null` will be returned. * @see ZENITH_6_DEGREES
556
- */
557
- tzaisBaalHatanya(): Date;
558
- /**
559
- * Uses timeFormat to return a date like '20:34'.
560
- * Returns `XX:XX` if the date is invalid.
561
- */
562
- static formatTime(dt: Date, timeFormat: Intl.DateTimeFormat): string;
563
- /**
564
- * Discards seconds, rounding to nearest minute.
565
- * @param dt
566
- */
567
- static roundTime(dt: Date): Date;
568
- /**
569
- * Get offset string (like "+05:00" or "-08:00") from tzid (like "Europe/Moscow")
570
- * @param tzid
571
- * @param date
572
- */
573
- static timeZoneOffset(tzid: string, date: Date): string;
574
- /**
575
- * Returns a string like "2022-04-01T13:06:00-11:00"
576
- * @param tzid
577
- * @param date
578
- */
579
- static formatISOWithTimeZone(tzid: string, date: Date): string;
580
- /**
581
- * Returns sunrise + `offset` minutes (either positive or negative).
582
- * If elevation is enabled, this function will include elevation in the calculation
583
- * unless `forceSeaLevel` is `true`.
584
- * @param offset minutes
585
- * @param roundMinute round time to nearest minute (default true)
586
- * @param forceSeaLevel use sea-level sunrise (default false)
587
- */
588
- sunriseOffset(offset: number, roundMinute?: boolean, forceSeaLevel?: boolean): Date;
589
- /**
590
- * Returns sunset + `offset` minutes (either positive or negative).
591
- * If elevation is enabled, this function will include elevation in the calculation
592
- * unless `forceSeaLevel` is `true`.
593
- * @param offset minutes
594
- * @param roundMinute round time to nearest minute (default true)
595
- * @param forceSeaLevel use sea-level sunset (default false)
596
- */
597
- sunsetOffset(offset: number, roundMinute?: boolean, forceSeaLevel?: boolean): Date;
598
- /**
599
- * Returns the Hebrew date relative to the specified location and Gregorian date,
600
- * taking into consideration whether the time is before or after sunset.
601
- *
602
- * For example, if the given date and is `2024-09-22T10:35` (before sunset), and
603
- * sunset for the specified location is **19:04**, then this function would
604
- * return a Hebrew date of `19th of Elul, 5784`.
605
- * If the given date is the same Gregorian day after sunset
606
- * (for example `2024-09-22T20:07`), this function would return a
607
- * Hebrew date of `20th of Elul, 5784`.
608
- * @example
609
- * const {GeoLocation, Zmanim, HDate} = require('@hebcal/core');
610
- * const latitude = 48.85341;
611
- * const longitude = 2.3488;
612
- * const timezone = 'Europe/Paris';
613
- * const gloc = new GeoLocation(null, latitude, longitude, 0, timezone);
614
- * const before = Zmanim.makeSunsetAwareHDate(gloc, new Date('2024-09-22T17:38:46.123Z'), false);
615
- * console.log(before.toString()); // '19 Elul 5784'
616
- * const after = Zmanim.makeSunsetAwareHDate(gloc, new Date('2024-09-22T23:45:18.345Z'), false);
617
- * console.log(after.toString()); // '20 Elul 5784'
618
- */
619
- static makeSunsetAwareHDate(gloc: GeoLocation, date: Date, useElevation: boolean): HDate;
620
- }