@hebcal/core 5.4.7 → 5.4.9

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.
@@ -6,35 +6,28 @@ export declare class Location extends GeoLocation {
6
6
  private readonly geoid?;
7
7
  /**
8
8
  * Initialize a Location instance
9
- * @param {number} latitude - Latitude as a decimal, valid range -90 thru +90 (e.g. 41.85003)
10
- * @param {number} longitude - Longitude as a decimal, valid range -180 thru +180 (e.g. -87.65005)
11
- * @param {boolean} il - in Israel (true) or Diaspora (false)
12
- * @param {string} tzid - Olson timezone ID, e.g. "America/Chicago"
13
- * @param {string} [cityName] - optional descriptive city name
14
- * @param {string} [countryCode] - ISO 3166 alpha-2 country code (e.g. "FR")
15
- * @param {string|number} [geoid] - optional string or numeric geographic ID
16
- * @param {number} [elevation] - in meters (default `0`)
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
17
  */
18
18
  constructor(latitude: number, longitude: number, il: boolean, tzid: string, cityName?: string, countryCode?: string, geoid?: string | number, elevation?: number);
19
- /** @return {boolean} */
20
19
  getIsrael(): boolean;
21
- /** @return {string | null} */
22
20
  getName(): string | null;
23
21
  /**
24
22
  * Returns the location name, up to the first comma
25
- * @return {string | null}
26
23
  */
27
24
  getShortName(): string | null;
28
- /** @return {string | undefined} */
29
25
  getCountryCode(): string | undefined;
30
- /** @return {string} */
31
26
  getTzid(): string;
32
27
  /**
33
28
  * Gets a 24-hour time formatter (e.g. 07:41 or 20:03) for this location
34
- * @return {Intl.DateTimeFormat}
35
29
  */
36
30
  getTimeFormatter(): Intl.DateTimeFormat;
37
- /** @return {string | number | undefined} */
38
31
  getGeoId(): string | number | undefined;
39
32
  /**
40
33
  * Creates a location object from one of 60 "classic" Hebcal city names.
@@ -52,36 +45,29 @@ export declare class Location extends GeoLocation {
52
45
  * 'San Diego', 'San Francisco', 'Sao Paulo', 'Seattle', 'Sydney',
53
46
  * 'Tel Aviv', 'Tiberias', 'Toronto', 'Vancouver', 'White Plains',
54
47
  * 'Washington DC', 'Worcester'
55
- * @param {string} name
56
- * @return {Location|undefined}
48
+ * @param name
57
49
  */
58
50
  static lookup(name: string): Location | undefined;
59
- /** @return {string} */
60
51
  toString(): string;
61
52
  /**
62
53
  * Converts legacy Hebcal timezone to a standard Olson tzid.
63
- * @param {number} tz integer, GMT offset in hours
64
- * @param {string} dst 'none', 'eu', 'usa', or 'israel'
65
- * @return {string | undefined}
54
+ * @param tz integer, GMT offset in hours
55
+ * @param dst 'none', 'eu', 'usa', or 'israel'
66
56
  */
67
57
  static legacyTzToTzid(tz: number, dst: string): string | undefined;
68
58
  /**
69
59
  * Converts timezone info from Zip-Codes.com to a standard Olson tzid.
70
60
  * @example
71
61
  * Location.getUsaTzid('AZ', 7, 'Y') // 'America/Denver'
72
- * @param {string} state two-letter all-caps US state abbreviation like 'CA'
73
- * @param {number} tz positive number, 5=America/New_York, 8=America/Los_Angeles
74
- * @param {string} dst single char 'Y' or 'N'
75
- * @return {string}
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'
76
65
  */
77
66
  static getUsaTzid(state: string, tz: number, dst: string): string;
78
67
  /**
79
68
  * Adds a location name for `Location.lookup()` only if the name isn't
80
69
  * already being used. Returns `false` if the name is already taken
81
70
  * and `true` if successfully added.
82
- * @param {string} cityName
83
- * @param {Location} location
84
- * @return {boolean}
85
71
  */
86
72
  static addLocation(cityName: string, location: Location): boolean;
87
73
  }
package/dist/modern.d.ts CHANGED
@@ -7,14 +7,12 @@ import { HDate } from '@hebcal/hdate';
7
7
  * on the following Monday.
8
8
  * http://www.ushmm.org/remembrance/dor/calendar/
9
9
  * @private
10
- * @param {number} year
11
- * @return {HDate|null}
10
+ * @param year
12
11
  */
13
12
  export declare function dateYomHaShoah(year: number): HDate | null;
14
13
  /**
15
14
  * Yom HaAtzma'ut only celebrated after 1948
16
15
  * @private
17
- * @param {number} year
18
- * @return {HDate|null}
16
+ * @param year
19
17
  */
20
18
  export declare function dateYomHaZikaron(year: number): HDate | null;
package/dist/molad.d.ts CHANGED
@@ -9,42 +9,38 @@ export declare class Molad {
9
9
  private readonly m;
10
10
  /**
11
11
  * Calculates the molad for a Hebrew month
12
- * @param {number} year
13
- * @param {number} month
12
+ * @param year
13
+ * @param month
14
14
  */
15
15
  constructor(year: number, month: number);
16
16
  /**
17
- * @return {number}
18
17
  */
19
18
  getYear(): number;
20
19
  /**
21
- * @return {number}
22
20
  */
23
21
  getMonth(): number;
24
22
  /**
25
- * @return {string}
26
23
  */
27
24
  getMonthName(): string;
28
25
  /**
29
- * @return {number} Day of Week (0=Sunday, 6=Saturday)
26
+ * @returns Day of Week (0=Sunday, 6=Saturday)
30
27
  */
31
28
  getDow(): number;
32
29
  /**
33
- * @return {number} hour of day (0-23)
30
+ * @returns hour of day (0-23)
34
31
  */
35
32
  getHour(): number;
36
33
  /**
37
- * @return {number} minutes past hour (0-59)
34
+ * @returns minutes past hour (0-59)
38
35
  */
39
36
  getMinutes(): number;
40
37
  /**
41
- * @return {number} parts of a minute (0-17)
38
+ * @returns parts of a minute (0-17)
42
39
  */
43
40
  getChalakim(): number;
44
41
  /**
45
- * @param {string} [locale] Optional locale name (defaults to active locale)
46
- * @param {CalOptions} options
47
- * @return {string}
42
+ * @param [locale] Optional locale name (defaults to active locale)
43
+ * @param options
48
44
  */
49
45
  render(locale?: string, options?: CalOptions): string;
50
46
  }
@@ -53,15 +49,14 @@ export declare class MoladEvent extends Event {
53
49
  readonly molad: Molad;
54
50
  private readonly options;
55
51
  /**
56
- * @param {HDate} date Hebrew date event occurs
57
- * @param {number} hyear molad year
58
- * @param {number} hmonth molad month
59
- * @param {CalOptions} options
52
+ * @param date Hebrew date event occurs
53
+ * @param hyear molad year
54
+ * @param hmonth molad month
55
+ * @param options
60
56
  */
61
57
  constructor(date: HDate, hyear: number, hmonth: number, options: CalOptions);
62
58
  /**
63
- * @param {string} [locale] Optional locale name (defaults to active locale).
64
- * @return {string}
59
+ * @param [locale] Optional locale name (defaults to active locale).
65
60
  */
66
61
  render(locale?: string): string;
67
62
  }
package/dist/omer.d.ts CHANGED
@@ -8,38 +8,30 @@ export declare class OmerEvent extends Event {
8
8
  readonly omer: number;
9
9
  emoji?: string;
10
10
  /**
11
- * @param {HDate} date
12
- * @param {number} omerDay
11
+ * @param date
12
+ * @param omerDay
13
13
  */
14
14
  constructor(date: HDate, omerDay: number);
15
15
  /**
16
- * @param {string} lang
17
- * @return {string}
16
+ * @param lang
18
17
  */
19
18
  sefira(lang?: string): string;
20
19
  /**
21
20
  * @todo use gettext()
22
- * @param {string} [locale] Optional locale name (defaults to active locale).
23
- * @return {string}
21
+ * @param [locale] Optional locale name (defaults to active locale).
24
22
  */
25
23
  render(locale?: string): string;
26
24
  /**
27
25
  * Returns translation of "Omer day 22" without ordinal numbers.
28
- * @param {string} [locale] Optional locale name (defaults to active locale).
29
- * @return {string}
26
+ * @param [locale] Optional locale name (defaults to active locale).
30
27
  */
31
28
  renderBrief(locale?: string): string;
32
- /** @return {string} */
33
29
  getEmoji(): string;
34
- /** @return {number} */
35
30
  getWeeks(): number;
36
- /** @return {number} */
37
31
  getDaysWithinWeeks(): number;
38
32
  /**
39
- * @param {string} locale
40
- * @return {string}
33
+ * @param locale
41
34
  */
42
35
  getTodayIs(locale: string): string;
43
- /** @return {string} */
44
36
  url(): string;
45
37
  }
@@ -1,2 +1,2 @@
1
1
  /** DO NOT EDIT THIS AUTO-GENERATED FILE! */
2
- export declare const version = "5.4.7";
2
+ export declare const version = "5.4.9";
@@ -1,9 +1,8 @@
1
1
  import { CalOptions } from './CalOptions';
2
2
  /**
3
3
  * @private
4
- * @param {string} timeStr - original time like "20:30"
5
- * @param {string} suffix - "p" or "pm" or " P.M.". Add leading space if you want it
6
- * @param {CalOptions} options
7
- * @return {string}
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
8
7
  */
9
8
  export declare function reformatTimeStr(timeStr: string, suffix: string, options?: CalOptions): string;
package/dist/sedra.d.ts CHANGED
@@ -31,54 +31,45 @@ export declare class Sedra {
31
31
  private readonly theSedraArray;
32
32
  /**
33
33
  * Caculates the Parashah HaShavua for an entire Hebrew year
34
- * @param {number} hyear - Hebrew year (e.g. 5749)
35
- * @param {boolean} il - Use Israel sedra schedule (false for Diaspora)
34
+ * @param hyear - Hebrew year (e.g. 5749)
35
+ * @param il - Use Israel sedra schedule (false for Diaspora)
36
36
  */
37
37
  constructor(hyear: number, il: boolean);
38
38
  /**
39
39
  * Returns the parsha (or parshiyot) read on Hebrew date
40
- * @param {HDate|number} hd Hebrew date or R.D. days
41
- * @return {string[]}
40
+ * @param hd Hebrew date or R.D. days
42
41
  */
43
42
  get(hd: HDate | number): string[];
44
43
  /**
45
44
  * Looks up parsha for the date, then returns a translated or transliterated string
46
- * @param {HDate|number} hd Hebrew date or R.D. days
47
- * @param {string} [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale
48
- * @return {string}
45
+ * @param hd Hebrew date or R.D. days
46
+ * @param [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale
49
47
  */
50
48
  getString(hd: HDate | number, locale?: string): string;
51
49
  /**
52
50
  * Checks to see if this day would be a regular parasha HaShavua
53
51
  * Torah reading or special holiday reading
54
- * @param {HDate|number} hd Hebrew date or R.D. days
55
- * @return {boolean}
52
+ * @param hd Hebrew date or R.D. days
56
53
  */
57
54
  isParsha(hd: HDate | number): boolean;
58
55
  /**
59
56
  * Returns the date that a parsha occurs
60
57
  * or `null` if the parsha doesn't occur this year
61
- * @param {number|string|string[]} parsha
62
- * @return {HDate|null}
63
58
  */
64
59
  find(parsha: number | string | string[]): HDate | null;
65
60
  /**
66
61
  * Returns the underlying annual sedra schedule.
67
62
  * Used by `@hebcal/triennial`
68
- * @return {NumberOrString[]}
69
63
  */
70
64
  getSedraArray(): NumberOrString[];
71
65
  /**
72
66
  * R.D. date of the first Saturday on or after Rosh Hashana
73
- * @return {number}
74
67
  */
75
68
  getFirstSaturday(): number;
76
- /** @return {number} */
77
69
  getYear(): number;
78
70
  /**
79
71
  * Returns an object describing the parsha on the first Saturday on or after `hd`
80
- * @param {HDate|number} hd Hebrew date or R.D. days
81
- * @return {SedraResult}
72
+ * @param hd Hebrew date or R.D. days
82
73
  */
83
74
  lookup(hd: HDate | number): SedraResult;
84
75
  }
@@ -94,9 +85,8 @@ type NumberOrString = number | string;
94
85
  * Convenience function to create an instance of `Sedra` or reuse a previously
95
86
  * created and cached instance.
96
87
  * @private
97
- * @param {number} hyear
98
- * @param {boolean} il
99
- * @return {Sedra}
88
+ * @param hyear
89
+ * @param il
100
90
  */
101
91
  export declare function getSedra_(hyear: number, il: boolean): Sedra;
102
92
  export {};
package/dist/zmanim.d.ts CHANGED
@@ -34,10 +34,10 @@ export declare class Zmanim {
34
34
  private useElevation;
35
35
  /**
36
36
  * Initialize a Zmanim instance.
37
- * @param {GeoLocation} gloc GeoLocation including latitude, longitude, and timezone
38
- * @param {Date|HDate} date Regular or Hebrew Date. If `date` is a regular `Date`,
37
+ * @param gloc GeoLocation including latitude, longitude, and timezone
38
+ * @param date Regular or Hebrew Date. If `date` is a regular `Date`,
39
39
  * hours, minutes, seconds and milliseconds are ignored.
40
- * @param {boolean} useElevation use elevation for calculations (default `false`).
40
+ * @param useElevation use elevation for calculations (default `false`).
41
41
  * If `true`, use elevation to affect the calculation of all sunrise/sunset based
42
42
  * zmanim. Note: there are some zmanim such as degree-based zmanim that are driven
43
43
  * by the amount of light in the sky and are not impacted by elevation.
@@ -47,115 +47,98 @@ export declare class Zmanim {
47
47
  /**
48
48
  * Returns `true` if elevation adjustment is enabled
49
49
  * for zmanim support elevation adjustment
50
- * @return {boolean}
51
50
  */
52
51
  getUseElevation(): boolean;
53
52
  /**
54
53
  * Enables or disables elevation adjustment for zmanim support elevation adjustment
55
- * @param {boolean} useElevation
54
+ * @param useElevation
56
55
  */
57
56
  setUseElevation(useElevation: boolean): void;
58
57
  /**
59
58
  * Convenience function to get the time when sun is above or below the horizon
60
59
  * for a certain angle (in degrees).
61
60
  * This function does not support elevation adjustment.
62
- * @param {number} angle
63
- * @param {boolean} rising
64
- * @return {Date}
61
+ * @param angle
62
+ * @param rising
65
63
  */
66
64
  timeAtAngle(angle: number, rising: boolean): Date;
67
65
  /**
68
66
  * Upper edge of the Sun appears over the eastern horizon in the morning (0.833° above horizon)
69
67
  * If elevation is enabled, this function will include elevation in the calculation.
70
- * @return {Date}
71
68
  */
72
69
  sunrise(): Date;
73
70
  /**
74
71
  * Upper edge of the Sun appears over the eastern horizon in the morning (0.833° above horizon).
75
72
  * This function does not support elevation adjustment.
76
- * @return {Date}
77
73
  */
78
74
  seaLevelSunrise(): Date;
79
75
  /**
80
76
  * When the upper edge of the Sun disappears below the horizon (0.833° below horizon).
81
77
  * If elevation is enabled, this function will include elevation in the calculation.
82
- * @return {Date}
83
78
  */
84
79
  sunset(): Date;
85
80
  /**
86
81
  * When the upper edge of the Sun disappears below the horizon (0.833° below horizon).
87
82
  * This function does not support elevation adjustment.
88
- * @return {Date}
89
83
  */
90
84
  seaLevelSunset(): Date;
91
85
  /**
92
86
  * Civil dawn; Sun is 6° below the horizon in the morning.
93
87
  * Because degree-based functions estimate the amount of light in the sky,
94
88
  * the result is not impacted by elevation.
95
- * @return {Date}
96
89
  */
97
90
  dawn(): Date;
98
91
  /**
99
92
  * Civil dusk; Sun is 6° below the horizon in the evening.
100
93
  * Because degree-based functions estimate the amount of light in the sky,
101
94
  * the result is not impacted by elevation.
102
- * @return {Date}
103
95
  */
104
96
  dusk(): Date;
105
97
  /**
106
98
  * Returns sunset for the previous day.
107
99
  * If elevation is enabled, this function will include elevation in the calculation.
108
- * @return {Date}
109
100
  */
110
101
  gregEve(): Date;
111
102
  /**
112
103
  * @private
113
- * @return {number}
114
104
  */
115
105
  nightHour(): number;
116
106
  /**
117
107
  * Midday – Chatzot; Sunrise plus 6 halachic hours
118
- * @return {Date}
119
108
  */
120
109
  chatzot(): Date;
121
110
  /**
122
111
  * Midnight – Chatzot; Sunset plus 6 halachic hours.
123
112
  * If elevation is enabled, this function will include elevation in the calculation.
124
- * @return {Date}
125
113
  */
126
114
  chatzotNight(): Date;
127
115
  /**
128
116
  * Dawn – Alot haShachar; Sun is 16.1° below the horizon in the morning.
129
117
  * Because degree-based functions estimate the amount of light in the sky,
130
118
  * the result is not impacted by elevation.
131
- * @return {Date}
132
119
  */
133
120
  alotHaShachar(): Date;
134
121
  /**
135
122
  * Earliest talis & tefillin – Misheyakir; Sun is 11.5° below the horizon in the morning.
136
123
  * Because degree-based functions estimate the amount of light in the sky,
137
124
  * the result is not impacted by elevation.
138
- * @return {Date}
139
125
  */
140
126
  misheyakir(): Date;
141
127
  /**
142
128
  * Earliest talis & tefillin – Misheyakir Machmir; Sun is 10.2° below the horizon in the morning.
143
129
  * Because degree-based functions estimate the amount of light in the sky,
144
130
  * the result is not impacted by elevation.
145
- * @return {Date}
146
131
  */
147
132
  misheyakirMachmir(): Date;
148
133
  /**
149
134
  * Utility method for using elevation-aware sunrise/sunset
150
135
  * @private
151
- * @param {number} hours
152
- * @return {Date}
136
+ * @param hours
153
137
  */
154
138
  getShaahZmanisBasedZman(hours: number): Date;
155
139
  /**
156
140
  * Latest Shema (Gra); Sunrise plus 3 halachic hours, according to the Gra.
157
141
  * If elevation is enabled, this function will include elevation in the calculation.
158
- * @return {Date}
159
142
  */
160
143
  sofZmanShma(): Date;
161
144
  /**
@@ -167,7 +150,6 @@ export declare class Zmanim {
167
150
  * to the [GRA](https://en.wikipedia.org/wiki/Vilna_Gaon).
168
151
  *
169
152
  * If elevation is enabled, this function will include elevation in the calculation.
170
- * @return {Date}
171
153
  */
172
154
  sofZmanTfilla(): Date;
173
155
  /**
@@ -185,14 +167,12 @@ export declare class Zmanim {
185
167
  * Based on the opinion of the MGA that the day is calculated from
186
168
  * dawn being fixed 72 minutes before sea-level sunrise, and nightfall is fixed
187
169
  * 72 minutes after sea-level sunset.
188
- * @return {Date}
189
170
  */
190
171
  sofZmanShmaMGA(): Date;
191
172
  /**
192
173
  * Latest Shema (MGA); Sunrise plus 3 halachic hours, according to Magen Avraham.
193
174
  * Based on the opinion of the MGA that the day is calculated from
194
175
  * dawn to nightfall with both being 16.1° below the horizon.
195
- * @return {Date}
196
176
  */
197
177
  sofZmanShmaMGA16Point1(): Date;
198
178
  /**
@@ -203,19 +183,16 @@ export declare class Zmanim {
203
183
  * This calculation is based on the position of the sun 90 minutes after sunset in Jerusalem
204
184
  * around the equinox / equilux which calculates to 19.8° below geometric zenith.
205
185
  * https://kosherjava.com/2022/01/12/equinox-vs-equilux-zmanim-calculations/
206
- * @return {Date}
207
186
  */
208
187
  sofZmanShmaMGA19Point8(): Date;
209
188
  /**
210
189
  * Latest Shacharit (MGA); Sunrise plus 4 halachic hours, according to Magen Avraham
211
- * @return {Date}
212
190
  */
213
191
  sofZmanTfillaMGA(): Date;
214
192
  /**
215
193
  * Latest Shacharit (MGA); Sunrise plus 4 halachic hours, according to Magen Avraham.
216
194
  * Based on the opinion of the MGA that the day is calculated from
217
195
  * dawn to nightfall with both being 16.1° below the horizon.
218
- * @return {Date}
219
196
  */
220
197
  sofZmanTfillaMGA16Point1(): Date;
221
198
  /**
@@ -226,7 +203,6 @@ export declare class Zmanim {
226
203
  * This calculation is based on the position of the sun 90 minutes after sunset in Jerusalem
227
204
  * around the equinox / equilux which calculates to 19.8° below geometric zenith.
228
205
  * https://kosherjava.com/2022/01/12/equinox-vs-equilux-zmanim-calculations/
229
- * @return {Date}
230
206
  */
231
207
  sofZmanTfillaMGA19Point8(): Date;
232
208
  /**
@@ -241,7 +217,6 @@ export declare class Zmanim {
241
217
  * The Ramba"m is of the opinion that it is better to delay *mincha* until
242
218
  * *mincha ketana* while the Ra"sh, Tur, GRA and others are of the
243
219
  * opinion that *mincha* can be prayed *lechatchila* starting at *mincha gedola*.
244
- * @return {Date}
245
220
  */
246
221
  minchaGedola(): Date;
247
222
  /**
@@ -251,7 +226,6 @@ export declare class Zmanim {
251
226
  * This method returns the time of *mincha gedola* according to the Magen Avraham
252
227
  * with the day starting 72 minutes before sunrise and ending 72 minutes after sunset.
253
228
  * This is the earliest time to pray *mincha*.
254
- * @return {Date}
255
229
  */
256
230
  minchaGedolaMGA(): Date;
257
231
  /**
@@ -263,7 +237,6 @@ export declare class Zmanim {
263
237
  * that is 9.5 *shaos zmaniyos* (solar hours) after sunrise or sea level sunrise
264
238
  * (depending on the `useElevation` setting), according
265
239
  * to the [GRA](https://en.wikipedia.org/wiki/Vilna_Gaon).
266
- * @return {Date}
267
240
  */
268
241
  minchaKetana(): Date;
269
242
  /**
@@ -273,31 +246,26 @@ export declare class Zmanim {
273
246
  * the [Rambam](https://en.wikipedia.org/wiki/Maimonides) and others.
274
247
  *
275
248
  * If elevation is enabled, this function will include elevation in the calculation.
276
- * @return {Date}
277
249
  */
278
250
  minchaKetanaMGA(): Date;
279
251
  /**
280
252
  * Plag haMincha; Sunrise plus 10.75 halachic hours.
281
253
  * If elevation is enabled, this function will include elevation in the calculation.
282
- * @return {Date}
283
254
  */
284
255
  plagHaMincha(): Date;
285
256
  /**
286
- * @param {number} [angle=8.5] optional time for solar depression.
257
+ * @param [angle=8.5] optional time for solar depression.
287
258
  * Default is 8.5 degrees for 3 small stars, use 7.083 degrees for 3 medium-sized stars.
288
259
  * Because degree-based functions estimate the amount of light in the sky,
289
260
  * the result is not impacted by elevation.
290
- * @return {Date}
291
261
  */
292
262
  tzeit(angle?: number): Date;
293
263
  /**
294
264
  * Alias for sunrise
295
- * @return {Date}
296
265
  */
297
266
  neitzHaChama(): Date;
298
267
  /**
299
268
  * Alias for sunset
300
- * @return {Date}
301
269
  */
302
270
  shkiah(): Date;
303
271
  /**
@@ -307,54 +275,45 @@ export declare class Zmanim {
307
275
  * it is 13.5 minutes before tzies 7.083.
308
276
  * Because degree-based functions estimate the amount of light in the sky,
309
277
  * the result is not impacted by elevation.
310
- * @return {Date}
311
278
  */
312
279
  beinHaShmashos(): Date;
313
280
  /**
314
281
  * Uses timeFormat to return a date like '20:34'
315
- * @param {Date} dt
316
- * @param {Intl.DateTimeFormat} timeFormat
317
- * @return {string}
318
282
  */
319
283
  static formatTime(dt: Date, timeFormat: Intl.DateTimeFormat): string;
320
284
  /**
321
285
  * Discards seconds, rounding to nearest minute.
322
- * @param {Date} dt
323
- * @return {Date}
286
+ * @param dt
324
287
  */
325
288
  static roundTime(dt: Date): Date;
326
289
  /**
327
290
  * Get offset string (like "+05:00" or "-08:00") from tzid (like "Europe/Moscow")
328
- * @param {string} tzid
329
- * @param {Date} date
330
- * @return {string}
291
+ * @param tzid
292
+ * @param date
331
293
  */
332
294
  static timeZoneOffset(tzid: string, date: Date): string;
333
295
  /**
334
296
  * Returns a string like "2022-04-01T13:06:00-11:00"
335
- * @param {string} tzid
336
- * @param {Date} date
337
- * @return {string}
297
+ * @param tzid
298
+ * @param date
338
299
  */
339
300
  static formatISOWithTimeZone(tzid: string, date: Date): string;
340
301
  /**
341
302
  * Returns sunrise + `offset` minutes (either positive or negative).
342
303
  * If elevation is enabled, this function will include elevation in the calculation
343
304
  * unless `forceSeaLevel` is `true`.
344
- * @param {number} offset minutes
345
- * @param {boolean} roundMinute round time to nearest minute (default true)
346
- * @param {boolean} forceSeaLevel use sea-level sunrise (default false)
347
- * @return {Date}
305
+ * @param offset minutes
306
+ * @param roundMinute round time to nearest minute (default true)
307
+ * @param forceSeaLevel use sea-level sunrise (default false)
348
308
  */
349
309
  sunriseOffset(offset: number, roundMinute?: boolean, forceSeaLevel?: boolean): Date;
350
310
  /**
351
311
  * Returns sunset + `offset` minutes (either positive or negative).
352
312
  * If elevation is enabled, this function will include elevation in the calculation
353
313
  * unless `forceSeaLevel` is `true`.
354
- * @param {number} offset minutes
355
- * @param {boolean} roundMinute round time to nearest minute (default true)
356
- * @param {boolean} forceSeaLevel use sea-level sunset (default false)
357
- * @return {Date}
314
+ * @param offset minutes
315
+ * @param roundMinute round time to nearest minute (default true)
316
+ * @param forceSeaLevel use sea-level sunset (default false)
358
317
  */
359
318
  sunsetOffset(offset: number, roundMinute?: boolean, forceSeaLevel?: boolean): Date;
360
319
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hebcal/core",
3
- "version": "5.4.7",
3
+ "version": "5.4.9",
4
4
  "author": "Michael J. Radwin (https://github.com/mjradwin)",
5
5
  "contributors": [
6
6
  "Eyal Schachter (https://github.com/Scimonster)",
@@ -49,11 +49,13 @@
49
49
  "prepublish": "npm run build",
50
50
  "version": "node ./version.cjs package.json src/pkgVersion.ts",
51
51
  "po2json": "node ./po2json.cjs po/*.po",
52
- "readme": "cp dist/index.mjs tmp.js && npx -p jsdoc-to-markdown jsdoc2md tmp.js && rm -f tmp.js",
52
+ "docs": "typedoc",
53
53
  "pretest": "npm run build",
54
- "lint": "eslint src",
54
+ "lint": "gts lint",
55
55
  "coverage": "jest --coverage",
56
- "test": "jest"
56
+ "test": "jest",
57
+ "clean": "gts clean",
58
+ "fix": "gts fix"
57
59
  },
58
60
  "license": "GPL-2.0",
59
61
  "overrides": {
@@ -76,19 +78,18 @@
76
78
  "@rollup/plugin-terser": "^0.4.4",
77
79
  "@rollup/plugin-typescript": "^11.1.6",
78
80
  "@types/jest": "^29.5.12",
81
+ "@types/node": "^20.14.9",
79
82
  "core-js": "^3.37.1",
80
- "eslint": "<=8.57.0",
81
- "eslint-config-google": "^0.14.0",
83
+ "gts": "^5.3.1",
82
84
  "jest": "^29.7.0",
83
- "jsdoc": "^4.0.3",
84
- "jsdoc-to-markdown": "^8.0.1",
85
85
  "quick-lru": "<=6.1.2",
86
86
  "rollup": "^4.18.0",
87
87
  "ttag-cli": "^1.10.12",
88
+ "typedoc": "^0.26.3",
88
89
  "typescript": "^5.5.3"
89
90
  },
90
91
  "dependencies": {
91
- "@hebcal/hdate": "^0.10.1",
92
+ "@hebcal/hdate": "^0.11.1",
92
93
  "@hebcal/noaa": "^0.8.14",
93
94
  "tslib": "^2.6.3"
94
95
  }