@hebcal/core 6.1.0 → 6.2.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 (88) hide show
  1. package/dist/bundle.js +203 -18
  2. package/dist/bundle.js.map +1 -1
  3. package/dist/bundle.min.js +5 -5
  4. package/dist/bundle.min.js.map +1 -1
  5. package/dist/esm/DailyLearning.js +1 -1
  6. package/dist/esm/HebrewDateEvent.js +1 -1
  7. package/dist/esm/HolidayEvent.js +1 -1
  8. package/dist/esm/MevarchimChodeshEvent.js +1 -1
  9. package/dist/esm/ParshaEvent.js +1 -1
  10. package/dist/esm/TimedEvent.js +1 -1
  11. package/dist/esm/YomKippurKatanEvent.js +1 -1
  12. package/dist/esm/ashkenazi.po.js +1 -1
  13. package/dist/esm/calendar.js +1 -1
  14. package/dist/esm/candles.js +1 -1
  15. package/dist/esm/event.js +1 -1
  16. package/dist/esm/getStartAndEnd.js +1 -1
  17. package/dist/esm/hallel.js +1 -1
  18. package/dist/esm/he-x-NoNikud.po.d.ts +2 -0
  19. package/dist/esm/he-x-NoNikud.po.js +2 -2
  20. package/dist/esm/he-x-NoNikud.po.js.map +1 -1
  21. package/dist/esm/he.po.js +2 -2
  22. package/dist/esm/he.po.js.map +1 -1
  23. package/dist/esm/hebcal.js +1 -1
  24. package/dist/esm/holidays.js +1 -1
  25. package/dist/esm/index.js +1 -1
  26. package/dist/esm/isAssurBemlacha.js +1 -1
  27. package/dist/esm/locale.js +1 -1
  28. package/dist/esm/location.js +1 -1
  29. package/dist/esm/modern.js +1 -1
  30. package/dist/esm/molad.js +1 -1
  31. package/dist/esm/moladBase.js +1 -1
  32. package/dist/esm/moladDate.js +1 -1
  33. package/dist/esm/omer.js +1 -1
  34. package/dist/esm/parshaName.js +1 -1
  35. package/dist/esm/parshaYear.js +1 -1
  36. package/dist/esm/pkgVersion.d.ts +1 -1
  37. package/dist/esm/pkgVersion.js +2 -2
  38. package/dist/esm/pkgVersion.js.map +1 -1
  39. package/dist/esm/reformatTimeStr.js +1 -1
  40. package/dist/esm/sedra.js +1 -1
  41. package/dist/esm/staticHolidays.js +1 -1
  42. package/dist/esm/tachanun.js +1 -1
  43. package/dist/esm/zmanim.d.ts +159 -11
  44. package/dist/esm/zmanim.js +200 -15
  45. package/dist/esm/zmanim.js.map +1 -1
  46. package/dist/src/he-x-NoNikud.po.d.ts +2 -0
  47. package/dist/src/he-x-NoNikud.po.js +1 -1
  48. package/dist/src/he.po.js +1 -1
  49. package/dist/src/pkgVersion.d.ts +1 -1
  50. package/dist/src/pkgVersion.js +1 -1
  51. package/dist/src/zmanim.d.ts +159 -11
  52. package/dist/src/zmanim.js +199 -14
  53. package/package.json +1 -1
  54. package/dist/CalOptions.d.ts +0 -168
  55. package/dist/DailyLearning.d.ts +0 -32
  56. package/dist/HebrewDateEvent.d.ts +0 -37
  57. package/dist/HolidayEvent.d.ts +0 -84
  58. package/dist/MevarchimChodeshEvent.d.ts +0 -26
  59. package/dist/ParshaEvent.d.ts +0 -19
  60. package/dist/TimedEvent.d.ts +0 -47
  61. package/dist/YomKippurKatanEvent.d.ts +0 -23
  62. package/dist/ashkenazi.po.d.ts +0 -82
  63. package/dist/calendar.d.ts +0 -111
  64. package/dist/candles.d.ts +0 -44
  65. package/dist/event.d.ts +0 -188
  66. package/dist/getStartAndEnd.d.ts +0 -6
  67. package/dist/hallel.d.ts +0 -6
  68. package/dist/he-x-NoNikud.po.d.ts +0 -16
  69. package/dist/he.po.d.ts +0 -215
  70. package/dist/hebcal.d.ts +0 -260
  71. package/dist/holidays.d.ts +0 -22
  72. package/dist/index.d.ts +0 -28
  73. package/dist/isAssurBemlacha.d.ts +0 -9
  74. package/dist/locale.d.ts +0 -1
  75. package/dist/location.d.ts +0 -73
  76. package/dist/modern.d.ts +0 -18
  77. package/dist/molad.d.ts +0 -132
  78. package/dist/moladBase.d.ts +0 -15
  79. package/dist/moladDate.d.ts +0 -12
  80. package/dist/omer.d.ts +0 -52
  81. package/dist/parshaName.d.ts +0 -2
  82. package/dist/parshaYear.d.ts +0 -9
  83. package/dist/pkgVersion.d.ts +0 -2
  84. package/dist/reformatTimeStr.d.ts +0 -8
  85. package/dist/sedra.d.ts +0 -95
  86. package/dist/staticHolidays.d.ts +0 -176
  87. package/dist/tachanun.d.ts +0 -29
  88. package/dist/zmanim.d.ts +0 -460
package/dist/hebcal.d.ts DELETED
@@ -1,260 +0,0 @@
1
- import { HDate } from '@hebcal/hdate';
2
- import './locale';
3
- import { CalOptions } from './CalOptions';
4
- import { Event } from './event';
5
- import { Sedra } from './sedra';
6
- import { HolidayYearMap } from './holidays';
7
- import { HolidayEvent } from './HolidayEvent';
8
- import { TachanunResult } from './tachanun';
9
- /**
10
- * HebrewCalendar is the main interface to the `@hebcal/core` library.
11
- * This namespace is used to calculate holidays, rosh chodesh, candle lighting & havdalah times,
12
- * Parashat HaShavua, Daf Yomi, days of the omer, and the molad.
13
- * Event names can be rendered in several languges using the `locale` option.
14
- */
15
- export declare class HebrewCalendar {
16
- private constructor();
17
- /**
18
- * Calculates holidays and other Hebrew calendar events based on {@link CalOptions}.
19
- *
20
- * Each holiday is represented by an {@link Event} object which includes a date,
21
- * a description, flags and optional attributes.
22
- * If given no options, returns holidays for the Diaspora for the current Gregorian year.
23
- *
24
- * The date range returned by this function can be controlled by:
25
- * * `options.year` - Gregorian (e.g. 1993) or Hebrew year (e.g. 5749)
26
- * * `options.isHebrewYear` - to interpret `year` as Hebrew year
27
- * * `options.numYears` - generate calendar for multiple years (default 1)
28
- * * `options.month` - Gregorian or Hebrew month (to filter results to a single month)
29
- *
30
- * Alternatively, specify start and end days with `Date` or {@link HDate} instances:
31
- * * `options.start` - use specific start date (requires `end` date)
32
- * * `options.end` - use specific end date (requires `start` date)
33
- *
34
- * Unless `options.noHolidays == true`, default holidays include:
35
- * * Major holidays - Rosh Hashana, Yom Kippur, Pesach, Sukkot, etc.
36
- * * Minor holidays - Purim, Chanukah, Tu BiShvat, Lag BaOmer, etc.
37
- * * Minor fasts - Ta'anit Esther, Tzom Gedaliah, etc. (unless `options.noMinorFast`)
38
- * * Special Shabbatot - Shabbat Shekalim, Zachor, etc. (unless `options.noSpecialShabbat`)
39
- * * Modern Holidays - Yom HaShoah, Yom HaAtzma'ut, etc. (unless `options.noModern`)
40
- * * Rosh Chodesh (unless `options.noRoshChodesh`)
41
- *
42
- * Holiday and Torah reading schedules differ between Israel and the Disapora.
43
- * Set `options.il=true` to use the Israeli schedule.
44
- *
45
- * Additional non-default event types can be specified:
46
- * * Parashat HaShavua - weekly Torah Reading on Saturdays (`options.sedrot`)
47
- * * Counting of the Omer (`options.omer`)
48
- * * Shabbat Mevarchim HaChodesh on Saturday before Rosh Chodesh (`options.shabbatMevarchim`)
49
- * * Molad announcement on Saturday before Rosh Chodesh (`options.molad`)
50
- * * Yom Kippur Katan (`options.yomKippurKatan`)
51
- * * Yizkor (`options.yizkor`)
52
- *
53
- * Daily Study of texts are supported by the
54
- * {@link https://github.com/hebcal/hebcal-learning @hebcal/learning} package,
55
- * for example:
56
- * * Babylonian Talmud Daf Yomi (`options.dailyLearning.dafYomi`)
57
- * * Jerusalem Talmud (Yerushalmi) Yomi (`options.dailyLearning.yerushalmi`)
58
- * * Mishna Yomi (`options.dailyLearning.mishnaYomi`)
59
- * * Nach Yomi (`options.dailyLearning.nachYomi`)
60
- *
61
- * Candle-lighting and Havdalah times are approximated using latitude and longitude
62
- * specified by the {@link Location} class. The `Location` class contains a small
63
- * database of cities with their associated geographic information and time-zone information.
64
- * If you ever have any doubts about Hebcal's times, consult your local halachic authority.
65
- * If you enter geographic coordinates above the arctic circle or antarctic circle,
66
- * the times are guaranteed to be wrong.
67
- *
68
- * To add candle-lighting options, set `options.candlelighting=true` and set
69
- * `options.location` to an instance of `Location`. By default, candle lighting
70
- * time is 18 minutes before sundown (40 minutes for Jerusalem,
71
- * 30 minutes for Haifa and Zikhron Ya'akov) and Havdalah is
72
- * calculated according to Tzeit Hakochavim - Nightfall (the point when 3 small stars
73
- * are observable in the night time sky with the naked eye). The default Havdalah
74
- * option (Tzeit Hakochavim) is calculated when the sun is 8.5° below the horizon.
75
- * These defaults can be changed using these options:
76
- * * `options.candleLightingMins` - minutes before sundown to light candles
77
- * * `options.havdalahMins` - minutes after sundown for Havdalah (typical values are 42, 50, or 72).
78
- * Havdalah times are suppressed when `options.havdalahMins=0`.
79
- * * `options.havdalahDeg` - degrees for solar depression for Havdalah.
80
- * Default is 8.5 degrees for 3 small stars. Use 7.083 degrees for 3 medium-sized stars.
81
- * Havdalah times are suppressed when `options.havdalahDeg=0`.
82
- *
83
- * If both `options.candlelighting=true` and `options.location` is specified,
84
- * Chanukah candle-lighting times and minor fast start/end times will also be generated.
85
- * Chanukah candle-lighting is at Bein HaShmashos (13.5 minutes before
86
- * the sun is 7.083° below the horizon in the evening)
87
- * on weekdays, at regular candle-lighting time on Fridays, and at regular Havdalah time on
88
- * Saturday night (see above).
89
- *
90
- * Minor fasts begin at Alot HaShachar (sun is 16.1° below the horizon in the morning) and
91
- * end when 3 medium-sized stars are observable in the night sky (sun is 7.083° below the horizon
92
- * in the evening).
93
- *
94
- * Two options also exist for generating an Event with the Hebrew date:
95
- * * `options.addHebrewDates` - print the Hebrew date for the entire date range
96
- * * `options.addHebrewDatesForEvents` - print the Hebrew date for dates with some events
97
- *
98
- * Lastly, translation and transliteration of event titles is controlled by
99
- * `options.locale` and the {@link Locale} API.
100
- * `@hebcal/core` supports three locales by default:
101
- * * `en` - default, Sephardic transliterations (e.g. "Shabbat")
102
- * * `ashkenazi` - Ashkenazi transliterations (e.g. "Shabbos")
103
- * * `he` - Hebrew (e.g. "שַׁבָּת")
104
- *
105
- * Additional locales (such as `ru` or `fr`) are supported by the
106
- * {@link https://github.com/hebcal/hebcal-locales @hebcal/locales} package
107
- *
108
- * @example
109
- * import {HebrewCalendar, HDate, Location, Event} from '@hebcal/core';
110
- * const options: CalOptions = {
111
- * year: 1981,
112
- * isHebrewYear: false,
113
- * candlelighting: true,
114
- * location: Location.lookup('San Francisco'),
115
- * sedrot: true,
116
- * omer: true,
117
- * };
118
- * const events = HebrewCalendar.calendar(options);
119
- * for (const ev of events) {
120
- * const hd = ev.getDate();
121
- * const date = hd.greg();
122
- * console.log(date.toLocaleDateString(), ev.render('en'), hd.toString());
123
- * }
124
- */
125
- static calendar(options?: CalOptions): Event[];
126
- /**
127
- * Calculates a birthday or anniversary (non-yahrzeit).
128
- * `hyear` must be after original `gdate` of anniversary.
129
- * Returns `undefined` when requested year preceeds or is same as original year.
130
- *
131
- * Hebcal uses the algorithm defined in "Calendrical Calculations"
132
- * by Edward M. Reingold and Nachum Dershowitz.
133
- *
134
- * The birthday of someone born in Adar of an ordinary year or Adar II of
135
- * a leap year is also always in the last month of the year, be that Adar
136
- * or Adar II. The birthday in an ordinary year of someone born during the
137
- * first 29 days of Adar I in a leap year is on the corresponding day of Adar;
138
- * in a leap year, the birthday occurs in Adar I, as expected.
139
- *
140
- * Someone born on the thirtieth day of Marcheshvan, Kislev, or Adar I
141
- * has his birthday postponed until the first of the following month in
142
- * years where that day does not occur. [Calendrical Calculations p. 111]
143
- * @example
144
- * import {HebrewCalendar} from '@hebcal/core';
145
- * const dt = new Date(2014, 2, 2); // '2014-03-02' == '30 Adar I 5774'
146
- * const hd = HebrewCalendar.getBirthdayOrAnniversary(5780, dt); // '1 Nisan 5780'
147
- * console.log(hd.greg().toLocaleDateString('en-US')); // '3/26/2020'
148
- * @param hyear Hebrew year
149
- * @param gdate Gregorian or Hebrew date of event
150
- * @returns anniversary occurring in `hyear`
151
- */
152
- static getBirthdayOrAnniversary(hyear: number, gdate: Date | HDate): HDate | undefined;
153
- /**
154
- * Calculates yahrzeit.
155
- * `hyear` must be after original `gdate` of death.
156
- * Returns `undefined` when requested year preceeds or is same as original year.
157
- *
158
- * Hebcal uses the algorithm defined in "Calendrical Calculations"
159
- * by Edward M. Reingold and Nachum Dershowitz.
160
- *
161
- * The customary anniversary date of a death is more complicated and depends
162
- * also on the character of the year in which the first anniversary occurs.
163
- * There are several cases:
164
- *
165
- * * If the date of death is Marcheshvan 30, the anniversary in general depends
166
- * on the first anniversary; if that first anniversary was not Marcheshvan 30,
167
- * use the day before Kislev 1.
168
- * * If the date of death is Kislev 30, the anniversary in general again depends
169
- * on the first anniversary — if that was not Kislev 30, use the day before
170
- * Tevet 1.
171
- * * If the date of death is Adar II, the anniversary is the same day in the
172
- * last month of the Hebrew year (Adar or Adar II).
173
- * * If the date of death is Adar I 30, the anniversary in a Hebrew year that
174
- * is not a leap year (in which Adar only has 29 days) is the last day in
175
- * Shevat.
176
- * * In all other cases, use the normal (that is, same month number) anniversary
177
- * of the date of death. [Calendrical Calculations p. 113]
178
- * @example
179
- * import {HebrewCalendar} from '@hebcal/core';
180
- * const dt = new Date(2014, 2, 2); // '2014-03-02' == '30 Adar I 5774'
181
- * const hd = HebrewCalendar.getYahrzeit(5780, dt); // '30 Sh\'vat 5780'
182
- * console.log(hd.greg().toLocaleDateString('en-US')); // '2/25/2020'
183
- * @param hyear Hebrew year
184
- * @param gdate Gregorian or Hebrew date of death
185
- * @returns anniversary occurring in hyear
186
- */
187
- static getYahrzeit(hyear: number, gdate: Date | HDate): HDate | undefined;
188
- /**
189
- * Lower-level holidays interface, which returns a `Map` of `Event`s indexed by
190
- * `HDate.toString()`. These events must filtered especially for `flags.IL_ONLY`
191
- * or `flags.CHUL_ONLY` depending on Israel vs. Diaspora holiday scheme.
192
- * @param year Hebrew year
193
- */
194
- static getHolidaysForYear(year: number): HolidayYearMap;
195
- /**
196
- * Returns an array of holidays for the year
197
- * @param year Hebrew year
198
- * @param il use the Israeli schedule for holidays
199
- */
200
- static getHolidaysForYearArray(year: number, il: boolean): HolidayEvent[];
201
- /**
202
- * Returns an array of Events on this date (or `undefined` if no events)
203
- * @param date Hebrew Date, Gregorian date, or absolute R.D. day number
204
- * @param [il] use the Israeli schedule for holidays
205
- */
206
- static getHolidaysOnDate(date: HDate | Date | number, il?: boolean): HolidayEvent[] | undefined;
207
- /**
208
- * Eruv Tavshilin
209
- */
210
- static eruvTavshilin(date: Date | HDate, il: boolean): boolean;
211
- /**
212
- * Helper function to format a 23-hour (00:00-23:59) time in US format ("8:13pm") or
213
- * keep as "20:13" for any other locale/country. Uses {@link CalOptions} to determine
214
- * locale.
215
- * If `options.hour12` is `false`, locale is ignored and always returns 24-hour time.
216
- * If `options.hour12` is `true`, locale is ignored and always returns 12-hour time.
217
- * @param timeStr - original time like "20:30"
218
- * @param suffix - "p" or "pm" or " P.M.". Add leading space if you want it
219
- * @param options
220
- */
221
- static reformatTimeStr(timeStr: string, suffix: string, options: CalOptions): string;
222
- static version(): string;
223
- /**
224
- * Convenience function to create an instance of `Sedra` or reuse a previously
225
- * created and cached instance.
226
- */
227
- static getSedra(hyear: number, il: boolean): Sedra;
228
- /**
229
- * Return a number containing information on what Hallel is said on that day.
230
- *
231
- * Whole Hallel is said on Chanukah, the first Yom Tov of Pesach, Shavuot, Sukkot,
232
- * Yom Ha'atzmaut, and Yom Yerushalayim.
233
- *
234
- * Half Hallel is said on Rosh Chodesh (not Rosh Hashanah), and the last 6 days of Pesach.
235
- *
236
- * The number is one of the following values:
237
- *
238
- * 0 - No Hallel
239
- * 1 - Half Hallel
240
- * 2 - Whole Hallel
241
- */
242
- static hallel(hdate: HDate, il: boolean): number;
243
- /**
244
- * Return details on what Tachanun (or Tzidchatcha on Shabbat) is said on `hdate`.
245
- *
246
- * Tachanun is not said on Rosh Chodesh, the month of Nisan, Lag Baomer,
247
- * Rosh Chodesh Sivan until Isru Chag, Tisha B'av, 15 Av, Erev Rosh Hashanah,
248
- * Rosh Hashanah, Erev Yom Kippur until after Simchat Torah, Chanukah,
249
- * Tu B'shvat, Purim and Shushan Purim, and Purim and Shushan Purim Katan.
250
- *
251
- * In some congregations Tachanun is not said until from Rosh Chodesh Sivan
252
- * until 14th Sivan, Sukkot until after Rosh Chodesh Cheshvan, Pesach Sheini,
253
- * Yom Ha'atzmaut, and Yom Yerushalayim.
254
- *
255
- * Tachanun is not said at Mincha on days before it is not said at Shacharit.
256
- *
257
- * Tachanun is not said at Shacharit on Shabbat, but is at Mincha, usually.
258
- */
259
- static tachanun(hdate: HDate, il: boolean): TachanunResult;
260
- }
@@ -1,22 +0,0 @@
1
- import { HDate } from '@hebcal/hdate';
2
- import { HolidayEvent } from './HolidayEvent';
3
- /**
4
- * Returns an array of Events on this date (or `undefined` if no events)
5
- * @param date Hebrew Date, Gregorian date, or absolute R.D. day number
6
- * @param [il] use the Israeli schedule for holidays
7
- */
8
- export declare function getHolidaysOnDate(date: HDate | Date | number, il?: boolean): HolidayEvent[] | undefined;
9
- export type HolidayYearMap = Map<string, HolidayEvent[]>;
10
- /**
11
- * Lower-level holidays interface, which returns a `Map` of `Event`s indexed by
12
- * `HDate.toString()`. These events must filtered especially for `flags.IL_ONLY`
13
- * or `flags.CHUL_ONLY` depending on Israel vs. Diaspora holiday scheme.
14
- * @private
15
- */
16
- export declare function getHolidaysForYear_(year: number): HolidayYearMap;
17
- /**
18
- * Returns an array of holidays for the year
19
- * @param year Hebrew year
20
- * @param il use the Israeli schedule for holidays
21
- */
22
- export declare function getHolidaysForYearArray(year: number, il: boolean): HolidayEvent[];
package/dist/index.d.ts DELETED
@@ -1,28 +0,0 @@
1
- export { version } from './pkgVersion';
2
- export { gematriya, gematriyaStrToNum } from '@hebcal/hdate';
3
- export { greg, months, HDate, Locale, Headers, StringArrayMap, LocaleData, MonthName, } from '@hebcal/hdate';
4
- import './locale';
5
- export { CalOptions, DailyLearningValue } from './CalOptions';
6
- export { HebrewDateEvent } from './HebrewDateEvent';
7
- export { Event, flags } from './event';
8
- export { GeoLocation, NOAACalculator } from '@hebcal/noaa';
9
- export { Location } from './location';
10
- export { Zmanim } from './zmanim';
11
- export { isAssurBemlacha } from './isAssurBemlacha';
12
- export { TimedEvent, CandleLightingEvent, HavdalahEvent } from './TimedEvent';
13
- export { FastDayEvent, TimedChanukahEvent } from './candles';
14
- export { MoladBase, calculateMolad } from './moladBase';
15
- export { getMoladAsDate } from './moladDate';
16
- export { Molad, MoladEvent } from './molad';
17
- export { OmerEvent, OmerLang } from './omer';
18
- export { TachanunResult } from './tachanun';
19
- export { Sedra, SedraResult, parshiot, getSedra } from './sedra';
20
- export { ParshaEvent } from './ParshaEvent';
21
- export { parshaYear } from './parshaYear';
22
- export { HolidayEvent, ChanukahEvent, AsaraBTevetEvent, RoshChodeshEvent, RoshHashanaEvent, } from './HolidayEvent';
23
- export { HolidayYearMap, getHolidaysOnDate } from './holidays';
24
- export { MevarchimChodeshEvent } from './MevarchimChodeshEvent';
25
- export { YomKippurKatanEvent } from './YomKippurKatanEvent';
26
- export { holidayDesc } from './staticHolidays';
27
- export { DailyLearning } from './DailyLearning';
28
- export { HebrewCalendar } from './hebcal';
@@ -1,9 +0,0 @@
1
- import { Location } from './location';
2
- /**
3
- * Utility method to determine if the date and time has a <em>melacha</em> (work) prohibition.
4
- * Although there are many opinions on the time of <em>tzais</em>, for simplicity
5
- * this function uses solar depression of 8.5 degrees.
6
- *
7
- * @return `true` if <em>melacha</em> is prohibited or `false` if it is not.
8
- */
9
- export declare function isAssurBemlacha(currentTime: Date, location: Location, useElevation: boolean): boolean;
package/dist/locale.d.ts DELETED
@@ -1 +0,0 @@
1
- export { Locale } from '@hebcal/hdate';
@@ -1,73 +0,0 @@
1
- import { GeoLocation } from '@hebcal/noaa';
2
- /** Class representing Location */
3
- export declare class Location extends GeoLocation {
4
- private readonly il;
5
- private readonly cc?;
6
- private readonly geoid?;
7
- /**
8
- * Initialize a Location instance
9
- * @param latitude - Latitude as a decimal, valid range -90 thru +90 (e.g. 41.85003)
10
- * @param longitude - Longitude as a decimal, valid range -180 thru +180 (e.g. -87.65005)
11
- * @param il - in Israel (true) or Diaspora (false)
12
- * @param tzid - Olson timezone ID, e.g. "America/Chicago"
13
- * @param [cityName] - optional descriptive city name
14
- * @param [countryCode] - ISO 3166 alpha-2 country code (e.g. "FR")
15
- * @param [geoid] - optional string or numeric geographic ID
16
- * @param [elevation] - in meters (default `0`)
17
- */
18
- constructor(latitude: number, longitude: number, il: boolean, tzid: string, cityName?: string, countryCode?: string, geoid?: string | number, elevation?: number);
19
- getIsrael(): boolean;
20
- getName(): string | null;
21
- /**
22
- * Returns the location name, up to the first comma
23
- */
24
- getShortName(): string | null;
25
- getCountryCode(): string | undefined;
26
- getTzid(): string;
27
- /**
28
- * Gets a 24-hour time formatter (e.g. 07:41 or 20:03) for this location
29
- */
30
- getTimeFormatter(): Intl.DateTimeFormat;
31
- getGeoId(): string | number | undefined;
32
- /**
33
- * Creates a location object from one of 60 "classic" Hebcal city names.
34
- * The following city names are supported:
35
- * 'Ashdod', 'Atlanta', 'Austin', 'Baghdad', 'Beer Sheva',
36
- * 'Berlin', 'Baltimore', 'Bogota', 'Boston', 'Budapest',
37
- * 'Buenos Aires', 'Buffalo', 'Chicago', 'Cincinnati', 'Cleveland',
38
- * 'Dallas', 'Denver', 'Detroit', 'Eilat', 'Gibraltar', 'Haifa',
39
- * 'Hawaii', 'Helsinki', 'Houston', 'Jerusalem', 'Johannesburg',
40
- * 'Kiev', 'La Paz', 'Livingston', 'Las Vegas', 'London', 'Los Angeles',
41
- * 'Marseilles', 'Miami', 'Minneapolis', 'Melbourne', 'Mexico City',
42
- * 'Montreal', 'Moscow', 'New York', 'Omaha', 'Ottawa', 'Panama City',
43
- * 'Paris', 'Pawtucket', 'Petach Tikvah', 'Philadelphia', 'Phoenix',
44
- * 'Pittsburgh', 'Providence', 'Portland', 'Saint Louis', 'Saint Petersburg',
45
- * 'San Diego', 'San Francisco', 'Sao Paulo', 'Seattle', 'Sydney',
46
- * 'Tel Aviv', 'Tiberias', 'Toronto', 'Vancouver', 'White Plains',
47
- * 'Washington DC', 'Worcester'
48
- * @param name
49
- */
50
- static lookup(name: string): Location | undefined;
51
- toString(): string;
52
- /**
53
- * Converts legacy Hebcal timezone to a standard Olson tzid.
54
- * @param tz integer, GMT offset in hours
55
- * @param dst 'none', 'eu', 'usa', or 'israel'
56
- */
57
- static legacyTzToTzid(tz: number, dst: string): string | undefined;
58
- /**
59
- * Converts timezone info from Zip-Codes.com to a standard Olson tzid.
60
- * @example
61
- * Location.getUsaTzid('AZ', 7, 'Y') // 'America/Denver'
62
- * @param state two-letter all-caps US state abbreviation like 'CA'
63
- * @param tz positive number, 5=America/New_York, 8=America/Los_Angeles
64
- * @param dst single char 'Y' or 'N'
65
- */
66
- static getUsaTzid(state: string, tz: number, dst: string): string;
67
- /**
68
- * Adds a location name for `Location.lookup()` only if the name isn't
69
- * already being used. Returns `false` if the name is already taken
70
- * and `true` if successfully added.
71
- */
72
- static addLocation(cityName: string, location: Location): boolean;
73
- }
package/dist/modern.d.ts DELETED
@@ -1,18 +0,0 @@
1
- import { HDate } from '@hebcal/hdate';
2
- /**
3
- * Yom HaShoah first observed in 1951.
4
- * When the actual date of Yom Hashoah falls on a Friday, the
5
- * state of Israel observes Yom Hashoah on the preceding
6
- * Thursday. When it falls on a Sunday, Yom Hashoah is observed
7
- * on the following Monday.
8
- * http://www.ushmm.org/remembrance/dor/calendar/
9
- * @private
10
- * @param year
11
- */
12
- export declare function dateYomHaShoah(year: number): HDate | null;
13
- /**
14
- * Yom HaAtzma'ut only celebrated after 1948
15
- * @private
16
- * @param year
17
- */
18
- export declare function dateYomHaZikaron(year: number): HDate | null;
package/dist/molad.d.ts DELETED
@@ -1,132 +0,0 @@
1
- import 'temporal-polyfill/global';
2
- import { Event } from './event';
3
- import { CalOptions } from './CalOptions';
4
- import { HDate } from '@hebcal/hdate';
5
- import './locale';
6
- /**
7
- * Represents a molad, the moment when the new moon is "born"
8
- */
9
- export declare class Molad {
10
- private readonly m;
11
- private readonly year;
12
- private readonly month;
13
- private instant?;
14
- /**
15
- * Calculates the molad for a Hebrew month
16
- * @param year
17
- * @param month 1=NISSAN, 7=TISHREI
18
- */
19
- constructor(year: number, month: number);
20
- /**
21
- * The exact Hebrew date of the molad, which often falls on the
22
- * 28th or 30th of the preceeding month, occasionally on the first of the
23
- * month, and in extremely rare circumstances the 27th of the month.
24
- * - Molad Shevat 5541 occured on 27 Tevet / 1781-01-24T19:57:20.170Z
25
- * - Molad Shevat 5788 will occur on 27 Tevet / 2028-01-26T19:07:03.504Z
26
- * - Molad Nissan 5866 will occur on 27 Adar II / 2106-04-03T21:08:46.837Z
27
- */
28
- getMoladDate(): HDate;
29
- /**
30
- * The year of the molad (as constructed)
31
- */
32
- getYear(): number;
33
- /**
34
- * The month (1=NISSAN, 7=TISHREI) as constructed
35
- */
36
- getMonth(): number;
37
- /**
38
- * Returns a transliterated string name of the molad's Hebrew month,
39
- * for example 'Elul' or 'Cheshvan'.
40
- */
41
- getMonthName(): string;
42
- /**
43
- * @returns Day of Week (0=Sunday, 6=Saturday)
44
- */
45
- getDow(): number;
46
- /**
47
- * @returns hour of day (0-23)
48
- */
49
- getHour(): number;
50
- /**
51
- * @returns minutes past hour (0-59)
52
- */
53
- getMinutes(): number;
54
- /**
55
- * @returns parts of a minute (0-17)
56
- */
57
- getChalakim(): number;
58
- /**
59
- * Returns the molad in Standard Time in Yerushalayim as a Temporal.ZonedDateTime.
60
- * This method subtracts 20.94 minutes (20 minutes and 56.496 seconds) from the computed time (Har Habayis with a longitude
61
- * of 35.2354&deg; is 5.2354&deg; away from the %15 timezone longitude) to get to standard time. This method
62
- * intentionally uses standard time and not daylight savings time.
63
- *
64
- * @return the Temporal.ZonedDateTime representing the moment of the molad in Yerushalayim standard time (GMT + 2)
65
- */
66
- getInstant(): Temporal.ZonedDateTime;
67
- /**
68
- * Returns the earliest time of _Kiddush Levana_ calculated as 3 days after the molad. This method returns the time
69
- * even if it is during the day when _Kiddush Levana_ can't be said. Callers of this method should consider
70
- * displaying the next _tzais_ if the zman is between _alos_ and _tzais_.
71
- *
72
- * @return the Temporal.ZonedDateTime representing the moment 3 days after the molad.
73
- */
74
- getTchilasZmanKidushLevana3Days(): Temporal.ZonedDateTime;
75
- /**
76
- * Returns the earliest time of Kiddush Levana calculated as 7 days after the molad as mentioned by the <a
77
- * href="https://en.wikipedia.org/wiki/Yosef_Karo">Mechaber</a>. See the <a
78
- * href="https://en.wikipedia.org/wiki/Yoel_Sirkis">Bach's</a> opinion on this time. This method returns the time
79
- * even if it is during the day when _Kiddush Levana_ can't be said. Callers of this method should consider
80
- * displaying the next _tzais_ if the zman is between _alos_ and _tzais_.
81
- *
82
- * @return the Temporal.ZonedDateTime representing the moment 7 days after the molad.
83
- */
84
- getTchilasZmanKidushLevana7Days(): Temporal.ZonedDateTime;
85
- /**
86
- * Returns the latest time of Kiddush Levana according to the <a
87
- * href="https://en.wikipedia.org/wiki/Yaakov_ben_Moshe_Levi_Moelin">Maharil's</a> opinion that it is calculated as
88
- * halfway between molad and molad. This adds half the 29 days, 12 hours and 793 chalakim time between molad and
89
- * molad (14 days, 18 hours, 22 minutes and 666 milliseconds) to the month's molad. This method returns the time
90
- * even if it is during the day when _Kiddush Levana_ can't be said. Callers of this method should consider
91
- * displaying _alos_ before this time if the zman is between _alos_ and _tzais_.
92
- *
93
- * @return the Temporal.ZonedDateTime representing the moment halfway between molad and molad.
94
- */
95
- getSofZmanKidushLevanaBetweenMoldos(): Temporal.ZonedDateTime;
96
- /**
97
- * Returns the latest time of Kiddush Levana calculated as 15 days after the molad. This is the opinion brought down
98
- * in the Shulchan Aruch (Orach Chaim 426). It should be noted that some opinions hold that the
99
- * <a href="https://en.wikipedia.org/wiki/Moses_Isserles">Rema</a> who brings down the opinion of the <a
100
- * href="https://en.wikipedia.org/wiki/Yaakov_ben_Moshe_Levi_Moelin">Maharil's</a> of calculating
101
- * {@link Molad.getSofZmanKidushLevanaBetweenMoldos() half way between molad and mold} is of the opinion that Mechaber
102
- * agrees to his opinion. Also see the Aruch Hashulchan. For additional details on the subject, See Rabbi Dovid
103
- * Heber's very detailed writeup in Siman Daled (chapter 4) of <a
104
- * href="https://www.worldcat.org/oclc/461326125">Shaarei Zmanim</a>. This method returns the time even if it is during
105
- * the day when _Kiddush Levana_ can't be said. Callers of this method should consider displaying _alos_
106
- * before this time if the zman is between _alos_ and _tzais_.
107
- *
108
- * @return the Temporal.ZonedDateTime representing the moment 15 days after the molad.
109
- */
110
- getSofZmanKidushLevana15Days(): Temporal.ZonedDateTime;
111
- /**
112
- * @param [locale] Optional locale name (defaults to empty locale)
113
- * @param options
114
- */
115
- render(locale?: string, options?: CalOptions): string;
116
- }
117
- /** Represents a Molad announcement on Shabbat Mevarchim */
118
- export declare class MoladEvent extends Event {
119
- readonly molad: Molad;
120
- private readonly options;
121
- /**
122
- * @param date Hebrew date event occurs
123
- * @param hyear molad year
124
- * @param hmonth molad month
125
- * @param options
126
- */
127
- constructor(date: HDate, hyear: number, hmonth: number, options: CalOptions);
128
- /**
129
- * @param [locale] Optional locale name (defaults to empty locale)
130
- */
131
- render(locale?: string): string;
132
- }
@@ -1,15 +0,0 @@
1
- import { HDate } from '@hebcal/hdate';
2
- /**
3
- * Represents a molad, the moment when the new moon is "born"
4
- */
5
- export type MoladBase = {
6
- /** Hebrew date */
7
- readonly hdate: HDate;
8
- /** hour of day (0-23) */
9
- readonly hour: number;
10
- /** minutes past hour (0-59) */
11
- readonly minutes: number;
12
- /** parts of a minute (0-17) */
13
- readonly chalakim: number;
14
- };
15
- export declare function calculateMolad(year: number, month: number): MoladBase;
@@ -1,12 +0,0 @@
1
- import 'temporal-polyfill/global';
2
- import { MoladBase } from './moladBase';
3
- /**
4
- * Returns the molad in UTC as a Temporal.ZonedDateTime.
5
- * This method subtracts 20.94 minutes (20 minutes and 56.496 seconds) from the computed time (Har Habayis with a longitude
6
- * of 35.2354&deg; is 5.2354&deg; away from the %15 timezone longitude) to get to standard time. This method
7
- * intentionally uses standard time and not daylight savings time.
8
- *
9
- * @return the ZonedDateTime representing the moment of the molad in UTC
10
-
11
- */
12
- export declare function getMoladAsDate(molad: MoladBase): Temporal.ZonedDateTime;
package/dist/omer.d.ts DELETED
@@ -1,52 +0,0 @@
1
- import { HDate } from '@hebcal/hdate';
2
- import { Event } from './event';
3
- import './locale';
4
- /**
5
- * Language for counting the Omer can be English or Hebrew.
6
- * Lang for the Sefira can be English, Hebrew, or Hebrew in Sephardic transliteration.
7
- */
8
- export type OmerLang = 'en' | 'he' | 'translit';
9
- /** Represents a day 1-49 of counting the Omer from Pesach to Shavuot */
10
- export declare class OmerEvent extends Event {
11
- private readonly weekNumber;
12
- private readonly daysWithinWeeks;
13
- readonly omer: number;
14
- /**
15
- * @param date
16
- * @param omerDay
17
- */
18
- constructor(date: HDate, omerDay: number);
19
- /**
20
- * Returns the sefira. For example, on day 8:
21
- * * חֶֽסֶד שֶׁבִּגְבוּרָה
22
- * * Chesed shebiGevurah
23
- * * Lovingkindness within Might
24
- * @param lang `en` (English), `he` (Hebrew with nikud), or `translit` (Hebrew in Sephardic transliteration)
25
- * @returns a string such as `Lovingkindness within Might` or `חֶֽסֶד שֶׁבִּגְבוּרָה`
26
- */
27
- sefira(lang?: OmerLang): string;
28
- /**
29
- * @param [locale] Optional locale name (defaults to empty locale)
30
- */
31
- render(locale?: string): string;
32
- /**
33
- * Returns translation of "Omer day 22" without ordinal numbers.
34
- * @param [locale] Optional locale name (defaults to empty locale)
35
- */
36
- renderBrief(locale?: string): string;
37
- /**
38
- * Returns an emoji number symbol with a circle, for example `㊲`
39
- * from the “Enclosed CJK Letters and Months” block of the Unicode standard
40
- * @returns a single Unicode character from `①` through `㊾`
41
- */
42
- getEmoji(): string;
43
- getWeeks(): number;
44
- getDaysWithinWeeks(): number;
45
- /**
46
- * Returns a sentence with that evening's omer count
47
- * @returns a string such as `Today is 10 days, which is 1 week and 3 days of the Omer`
48
- * or `הַיוֹם עֲשָׂרָה יָמִים, שְׁהֵם שָׁבוּעַ אֶחָד וְשְׁלוֹשָׁה יָמִים לָעוֹמֶר`
49
- */
50
- getTodayIs(locale: string): string;
51
- url(): string | undefined;
52
- }
@@ -1,2 +0,0 @@
1
- /** @private */
2
- export declare function renderParshaName(parsha: string[], locale?: string): string;
@@ -1,9 +0,0 @@
1
- import { ParshaEvent } from './ParshaEvent';
2
- /**
3
- * Calculates weekly Torah Reading on Saturdays for entire year
4
- * @param year Hebrew year
5
- * @param il Israel (false for Diaspora)
6
- * @returns an array of `ParshaEvent` occurring on Saturdays that contain a regular
7
- * (non-holiday) Parashat HaShavua
8
- */
9
- export declare function parshaYear(year: number, il: boolean): ParshaEvent[];
@@ -1,2 +0,0 @@
1
- /** DO NOT EDIT THIS AUTO-GENERATED FILE! */
2
- export declare const version = "6.1.0";
@@ -1,8 +0,0 @@
1
- import { CalOptions } from './CalOptions';
2
- /**
3
- * @private
4
- * @param timeStr - original time like "20:30"
5
- * @param suffix - "p" or "pm" or " P.M.". Add leading space if you want it
6
- * @param options
7
- */
8
- export declare function reformatTimeStr(timeStr: string, suffix: string, options?: CalOptions): string;