@hebcal/core 5.3.6 → 5.3.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -217,6 +217,19 @@ we omit the thousands (which is presently 5 [ה]).</p>
217
217
  Ignores final Hebrew letters such as <code>ך</code> (kaf sofit) or <code>ם</code> (mem sofit)
218
218
  and vowels (nekudot).</p>
219
219
  </dd>
220
+ <dt><a href="#omerSefira">omerSefira(omerDay, lang)</a> ⇒</dt>
221
+ <dd><p>Returns the sefira. For example, on day 8
222
+ חֶֽסֶד שֶׁבִּגְבוּרָה
223
+ Chesed shebiGevurah
224
+ Lovingkindness within Might</p>
225
+ </dd>
226
+ <dt><a href="#omerTodayIs">omerTodayIs(omerDay, lang)</a> ⇒</dt>
227
+ <dd><p>Returns a sentence with that evening&#39;s omer count</p>
228
+ </dd>
229
+ <dt><a href="#omerEmoji">omerEmoji(omerDay)</a> ⇒</dt>
230
+ <dd><p>Returns an emoji number symbol with a circle, for example <code>㊲</code>
231
+ from the “Enclosed CJK Letters and Months” block of the Unicode standard</p>
232
+ </dd>
220
233
  </dl>
221
234
 
222
235
  ## Typedefs
@@ -1234,9 +1247,6 @@ href="http://en.wikipedia.org/wiki/Sunrise_equation">Wikipedia Sunrise Equation<
1234
1247
  * [NOAACalculator](#NOAACalculator)
1235
1248
  * [new NOAACalculator(geoLocation, date)](#new_NOAACalculator_new)
1236
1249
  * _instance_
1237
- * [.CIVIL_ZENITH](#NOAACalculator+CIVIL_ZENITH)
1238
- * [.NAUTICAL_ZENITH](#NOAACalculator+NAUTICAL_ZENITH)
1239
- * [.ASTRONOMICAL_ZENITH](#NOAACalculator+ASTRONOMICAL_ZENITH)
1240
1250
  * [.getSunrise()](#NOAACalculator+getSunrise) ⇒ <code>Temporal.ZonedDateTime</code> \| <code>null</code>
1241
1251
  * [.getSeaLevelSunrise()](#NOAACalculator+getSeaLevelSunrise) ⇒ <code>Temporal.ZonedDateTime</code> \| <code>null</code>
1242
1252
  * [.getBeginCivilTwilight()](#NOAACalculator+getBeginCivilTwilight) ⇒ <code>Temporal.ZonedDateTime</code> \| <code>null</code>
@@ -1261,6 +1271,9 @@ href="http://en.wikipedia.org/wiki/Sunrise_equation">Wikipedia Sunrise Equation<
1261
1271
  * [.getSunTransit(startOfDay, endOfDay)](#NOAACalculator+getSunTransit) ⇒ <code>Temporal.ZonedDateTime</code> \| <code>null</code>
1262
1272
  * [.getDateFromTime(time, isSunrise)](#NOAACalculator+getDateFromTime) ⇒ <code>Temporal.ZonedDateTime</code> \| <code>null</code>
1263
1273
  * _static_
1274
+ * [.CIVIL_ZENITH](#NOAACalculator.CIVIL_ZENITH)
1275
+ * [.NAUTICAL_ZENITH](#NOAACalculator.NAUTICAL_ZENITH)
1276
+ * [.ASTRONOMICAL_ZENITH](#NOAACalculator.ASTRONOMICAL_ZENITH)
1264
1277
  * [.getTimeOffset(time, offset)](#NOAACalculator.getTimeOffset) ⇒ <code>Temporal.ZonedDateTime</code> \| <code>null</code>
1265
1278
  * [.getSolarElevation(date, lat, lon)](#NOAACalculator.getSolarElevation) ⇒ <code>number</code>
1266
1279
  * [.getSolarAzimuth(date, latitude, lon)](#NOAACalculator.getSolarAzimuth) ⇒ <code>number</code>
@@ -1277,24 +1290,6 @@ parameter.
1277
1290
  | geoLocation | [<code>GeoLocation</code>](#GeoLocation) | The location information used for calculating astronomical sun times. |
1278
1291
  | date | <code>Temporal.PlainDate</code> | |
1279
1292
 
1280
- <a name="NOAACalculator+CIVIL_ZENITH"></a>
1281
-
1282
- ### noaaCalculator.CIVIL\_ZENITH
1283
- Sun's zenith at civil twilight (96&deg;).
1284
-
1285
- **Kind**: instance property of [<code>NOAACalculator</code>](#NOAACalculator)
1286
- <a name="NOAACalculator+NAUTICAL_ZENITH"></a>
1287
-
1288
- ### noaaCalculator.NAUTICAL\_ZENITH
1289
- Sun's zenith at nautical twilight (102&deg;).
1290
-
1291
- **Kind**: instance property of [<code>NOAACalculator</code>](#NOAACalculator)
1292
- <a name="NOAACalculator+ASTRONOMICAL_ZENITH"></a>
1293
-
1294
- ### noaaCalculator.ASTRONOMICAL\_ZENITH
1295
- Sun's zenith at astronomical twilight (108&deg;).
1296
-
1297
- **Kind**: instance property of [<code>NOAACalculator</code>](#NOAACalculator)
1298
1293
  <a name="NOAACalculator+getSunrise"></a>
1299
1294
 
1300
1295
  ### noaaCalculator.getSunrise() ⇒ <code>Temporal.ZonedDateTime</code> \| <code>null</code>
@@ -1686,6 +1681,24 @@ A method that returns a `Date` from the time passed in as a parameter.
1686
1681
  | time | <code>number</code> | The time to be set as the time for the `Date`. The time expected is in the format: 18.75 for 6:45:00 PM. |
1687
1682
  | isSunrise | <code>boolean</code> | true if the time is sunrise, and false if it is sunset |
1688
1683
 
1684
+ <a name="NOAACalculator.CIVIL_ZENITH"></a>
1685
+
1686
+ ### NOAACalculator.CIVIL\_ZENITH
1687
+ Sun's zenith at civil twilight (96&deg;).
1688
+
1689
+ **Kind**: static property of [<code>NOAACalculator</code>](#NOAACalculator)
1690
+ <a name="NOAACalculator.NAUTICAL_ZENITH"></a>
1691
+
1692
+ ### NOAACalculator.NAUTICAL\_ZENITH
1693
+ Sun's zenith at nautical twilight (102&deg;).
1694
+
1695
+ **Kind**: static property of [<code>NOAACalculator</code>](#NOAACalculator)
1696
+ <a name="NOAACalculator.ASTRONOMICAL_ZENITH"></a>
1697
+
1698
+ ### NOAACalculator.ASTRONOMICAL\_ZENITH
1699
+ Sun's zenith at astronomical twilight (108&deg;).
1700
+
1701
+ **Kind**: static property of [<code>NOAACalculator</code>](#NOAACalculator)
1689
1702
  <a name="NOAACalculator.getTimeOffset"></a>
1690
1703
 
1691
1704
  ### NOAACalculator.getTimeOffset(time, offset) ⇒ <code>Temporal.ZonedDateTime</code> \| <code>null</code>
@@ -1917,8 +1930,10 @@ https://gml.noaa.gov/grad/solcalc/calcdetails.html
1917
1930
  * [.sofZmanTfilla()](#Zmanim+sofZmanTfilla) ⇒ <code>Date</code>
1918
1931
  * [.sofZmanShmaMGA()](#Zmanim+sofZmanShmaMGA) ⇒ <code>Date</code>
1919
1932
  * [.sofZmanShmaMGA16Point1()](#Zmanim+sofZmanShmaMGA16Point1) ⇒ <code>Date</code>
1933
+ * [.sofZmanShmaMGA19Point8()](#Zmanim+sofZmanShmaMGA19Point8) ⇒ <code>Date</code>
1920
1934
  * [.sofZmanTfillaMGA()](#Zmanim+sofZmanTfillaMGA) ⇒ <code>Date</code>
1921
1935
  * [.sofZmanTfillaMGA16Point1()](#Zmanim+sofZmanTfillaMGA16Point1) ⇒ <code>Date</code>
1936
+ * [.sofZmanTfillaMGA19Point8()](#Zmanim+sofZmanTfillaMGA19Point8) ⇒ <code>Date</code>
1922
1937
  * [.minchaGedola()](#Zmanim+minchaGedola) ⇒ <code>Date</code>
1923
1938
  * [.minchaKetana()](#Zmanim+minchaKetana) ⇒ <code>Date</code>
1924
1939
  * [.plagHaMincha()](#Zmanim+plagHaMincha) ⇒ <code>Date</code>
@@ -2069,6 +2084,18 @@ Latest Shema (MGA); Sunrise plus 3 halachic hours, according to Magen Avraham.
2069
2084
  Based on the opinion of the MGA that the day is calculated from
2070
2085
  dawn to nightfall with both being 16.1° below the horizon.
2071
2086
 
2087
+ **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
2088
+ <a name="Zmanim+sofZmanShmaMGA19Point8"></a>
2089
+
2090
+ ### zmanim.sofZmanShmaMGA19Point8() ⇒ <code>Date</code>
2091
+ Latest Shema (MGA); Sunrise plus 3 halachic hours, according to Magen Avraham.
2092
+ Based on the opinion of the MGA that the day is calculated from
2093
+ dawn to nightfall with both being 19.8° below the horizon.
2094
+
2095
+ This calculation is based on the position of the sun 90 minutes after sunset in Jerusalem
2096
+ around the equinox / equilux which calculates to 19.8° below geometric zenith.
2097
+ https://kosherjava.com/2022/01/12/equinox-vs-equilux-zmanim-calculations/
2098
+
2072
2099
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
2073
2100
  <a name="Zmanim+sofZmanTfillaMGA"></a>
2074
2101
 
@@ -2083,6 +2110,18 @@ Latest Shacharit (MGA); Sunrise plus 4 halachic hours, according to Magen Avraha
2083
2110
  Based on the opinion of the MGA that the day is calculated from
2084
2111
  dawn to nightfall with both being 16.1° below the horizon.
2085
2112
 
2113
+ **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
2114
+ <a name="Zmanim+sofZmanTfillaMGA19Point8"></a>
2115
+
2116
+ ### zmanim.sofZmanTfillaMGA19Point8() ⇒ <code>Date</code>
2117
+ Latest Shacharit (MGA); Sunrise plus 4 halachic hours, according to Magen Avraham.
2118
+ Based on the opinion of the MGA that the day is calculated from
2119
+ dawn to nightfall with both being 19.8° below the horizon.
2120
+
2121
+ This calculation is based on the position of the sun 90 minutes after sunset in Jerusalem
2122
+ around the equinox / equilux which calculates to 19.8° below geometric zenith.
2123
+ https://kosherjava.com/2022/01/12/equinox-vs-equilux-zmanim-calculations/
2124
+
2086
2125
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
2087
2126
  <a name="Zmanim+minchaGedola"></a>
2088
2127
 
@@ -3453,6 +3492,49 @@ and vowels (nekudot).
3453
3492
  | --- | --- |
3454
3493
  | str | <code>string</code> |
3455
3494
 
3495
+ <a name="omerSefira"></a>
3496
+
3497
+ ## omerSefira(omerDay, lang) ⇒
3498
+ Returns the sefira. For example, on day 8
3499
+ חֶֽסֶד שֶׁבִּגְבוּרָה
3500
+ Chesed shebiGevurah
3501
+ Lovingkindness within Might
3502
+
3503
+ **Kind**: global function
3504
+ **Returns**: a string such as `Lovingkindness within Might` or `חֶֽסֶד שֶׁבִּגְבוּרָה`
3505
+
3506
+ | Param | Description |
3507
+ | --- | --- |
3508
+ | omerDay | the day of the omer, 1-49 inclusive |
3509
+ | lang | `en` (English), `he` (Hebrew with nikud), or `translit` (Hebrew in Sephardic transliteration) |
3510
+
3511
+ <a name="omerTodayIs"></a>
3512
+
3513
+ ## omerTodayIs(omerDay, lang) ⇒
3514
+ Returns a sentence with that evening's omer count
3515
+
3516
+ **Kind**: global function
3517
+ **Returns**: a string such as `Today is 10 days, which is 1 week and 3 days of the Omer`
3518
+ or `הַיוֹם עֲשָׂרָה יָמִים, שְׁהֵם שָׁבוּעַ אֶחָד וְשְׁלוֹשָׁה יָמִים לָעוֹמֶר`
3519
+
3520
+ | Param | Description |
3521
+ | --- | --- |
3522
+ | omerDay | the day of the omer, 1-49 inclusive |
3523
+ | lang | `en` (English), `he` (Hebrew with nikud) |
3524
+
3525
+ <a name="omerEmoji"></a>
3526
+
3527
+ ## omerEmoji(omerDay) ⇒
3528
+ Returns an emoji number symbol with a circle, for example `㊲`
3529
+ from the “Enclosed CJK Letters and Months” block of the Unicode standard
3530
+
3531
+ **Kind**: global function
3532
+ **Returns**: a single Unicode character from `①` through `㊾`
3533
+
3534
+ | Param | Description |
3535
+ | --- | --- |
3536
+ | omerDay | the day of the omer, 1-49 inclusive |
3537
+
3456
3538
  <a name="SedraResult"></a>
3457
3539
 
3458
3540
  ## SedraResult : <code>Object</code>
package/dist/bundle.js CHANGED
@@ -1,4 +1,4 @@
1
- /*! @hebcal/core v5.3.6 */
1
+ /*! @hebcal/core v5.3.7 */
2
2
  var hebcal = (function (exports) {
3
3
  'use strict';
4
4
 
@@ -9321,8 +9321,8 @@ class Zmanim {
9321
9321
  * @return {Date}
9322
9322
  */
9323
9323
  getShaahZmanisBasedZman(hours) {
9324
- const startOfDay = this.noaa.getSunrise();
9325
- const endOfDay = this.noaa.getSunset();
9324
+ const startOfDay = this.useElevation ? this.noaa.getSunrise() : this.noaa.getSeaLevelSunrise();
9325
+ const endOfDay = this.useElevation ? this.noaa.getSunset() : this.noaa.getSeaLevelSunset();
9326
9326
  const temporalHour = this.noaa.getTemporalHour(startOfDay, endOfDay);
9327
9327
  const offset = Math.round(temporalHour * hours);
9328
9328
  const zdt = NOAACalculator.getTimeOffset(startOfDay, offset);
@@ -9358,13 +9358,14 @@ class Zmanim {
9358
9358
  /**
9359
9359
  * Returns an array with alot (Date) and ms in hour (number)
9360
9360
  * @private
9361
+ * @param {number} angle
9361
9362
  * @return {any[]}
9362
9363
  */
9363
- getTemporalHour16Point1() {
9364
- const alot16one = this.alotHaShachar();
9365
- const tzeit16one = this.tzeit(16.1);
9366
- const temporalHour = (tzeit16one - alot16one) / 12;
9367
- return [alot16one, temporalHour];
9364
+ getTemporalHourByDeg(angle) {
9365
+ const alot = this.timeAtAngle(angle, true);
9366
+ const tzeit = this.timeAtAngle(angle, false);
9367
+ const temporalHour = (tzeit - alot) / 12;
9368
+ return [alot, temporalHour];
9368
9369
  }
9369
9370
  /**
9370
9371
  * Latest Shema (MGA); Sunrise plus 3 halachic hours, according to Magen Avraham.
@@ -9385,7 +9386,21 @@ class Zmanim {
9385
9386
  * @return {Date}
9386
9387
  */
9387
9388
  sofZmanShmaMGA16Point1() {
9388
- const [alot, temporalHour] = this.getTemporalHour16Point1();
9389
+ const [alot, temporalHour] = this.getTemporalHourByDeg(16.1);
9390
+ return new Date(alot.getTime() + 3 * temporalHour);
9391
+ }
9392
+ /**
9393
+ * Latest Shema (MGA); Sunrise plus 3 halachic hours, according to Magen Avraham.
9394
+ * Based on the opinion of the MGA that the day is calculated from
9395
+ * dawn to nightfall with both being 19.8° below the horizon.
9396
+ *
9397
+ * This calculation is based on the position of the sun 90 minutes after sunset in Jerusalem
9398
+ * around the equinox / equilux which calculates to 19.8° below geometric zenith.
9399
+ * https://kosherjava.com/2022/01/12/equinox-vs-equilux-zmanim-calculations/
9400
+ * @return {Date}
9401
+ */
9402
+ sofZmanShmaMGA19Point8() {
9403
+ const [alot, temporalHour] = this.getTemporalHourByDeg(19.8);
9389
9404
  return new Date(alot.getTime() + 3 * temporalHour);
9390
9405
  }
9391
9406
  /**
@@ -9404,7 +9419,21 @@ class Zmanim {
9404
9419
  * @return {Date}
9405
9420
  */
9406
9421
  sofZmanTfillaMGA16Point1() {
9407
- const [alot, temporalHour] = this.getTemporalHour16Point1();
9422
+ const [alot, temporalHour] = this.getTemporalHourByDeg(16.1);
9423
+ return new Date(alot.getTime() + 4 * temporalHour);
9424
+ }
9425
+ /**
9426
+ * Latest Shacharit (MGA); Sunrise plus 4 halachic hours, according to Magen Avraham.
9427
+ * Based on the opinion of the MGA that the day is calculated from
9428
+ * dawn to nightfall with both being 19.8° below the horizon.
9429
+ *
9430
+ * This calculation is based on the position of the sun 90 minutes after sunset in Jerusalem
9431
+ * around the equinox / equilux which calculates to 19.8° below geometric zenith.
9432
+ * https://kosherjava.com/2022/01/12/equinox-vs-equilux-zmanim-calculations/
9433
+ * @return {Date}
9434
+ */
9435
+ sofZmanTfillaMGA19Point8() {
9436
+ const [alot, temporalHour] = this.getTemporalHourByDeg(19.8);
9408
9437
  return new Date(alot.getTime() + 4 * temporalHour);
9409
9438
  }
9410
9439
  /**
@@ -11878,7 +11907,7 @@ class DailyLearning {
11878
11907
  }
11879
11908
 
11880
11909
  // DO NOT EDIT THIS AUTO-GENERATED FILE!
11881
- const version = '5.3.6';
11910
+ const version = '5.3.7';
11882
11911
 
11883
11912
  const NONE$1 = 0;
11884
11913
  const HALF = 1;