@hebcal/core 5.3.12 → 5.4.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.
- package/README.md +251 -173
- package/dist/DailyLearning.d.ts +22 -0
- package/dist/HebrewDateEvent.d.ts +14 -0
- package/dist/ParshaEvent.d.ts +19 -0
- package/dist/ashkenazi.po.d.ts +68 -0
- package/dist/bundle.js +11621 -11437
- package/dist/bundle.min.js +2 -2
- package/dist/candles.d.ts +74 -0
- package/dist/dateFormat.d.ts +33 -0
- package/dist/event.d.ts +144 -0
- package/dist/hallel.d.ts +7 -0
- package/dist/hdate.d.ts +395 -0
- package/dist/he.po.d.ts +306 -0
- package/dist/hebcal.d.ts +451 -0
- package/dist/holidays.d.ts +65 -0
- package/dist/index.cjs +1837 -1947
- package/dist/index.d.ts +18 -0
- package/dist/index.mjs +1838 -1948
- package/dist/locale-ashkenazi.d.ts +1 -0
- package/dist/locale-he.d.ts +1 -0
- package/dist/locale.d.ts +80 -0
- package/dist/location.d.ts +85 -0
- package/dist/modern.d.ts +20 -0
- package/dist/molad.d.ts +65 -0
- package/dist/omer.d.ts +26 -0
- package/dist/pkgVersion.d.ts +1 -0
- package/dist/reformatTimeStr.d.ts +8 -0
- package/dist/sedra.d.ts +8 -0
- package/dist/staticHolidays.d.ts +212 -0
- package/dist/staticHols.d.ts +175 -0
- package/dist/tachanun.d.ts +8 -0
- package/dist/throwTypeError.d.ts +5 -0
- package/dist/zmanim.d.ts +321 -0
- package/package.json +17 -14
- package/hebcal.d.ts +0 -1361
- package/po/ashkenazi.po +0 -195
- package/po/he.min.po +0 -50
- package/po/he.po +0 -931
package/README.md
CHANGED
|
@@ -50,7 +50,7 @@ for (const ev of events) {
|
|
|
50
50
|
<dl>
|
|
51
51
|
<dt><a href="#Locale">Locale</a></dt>
|
|
52
52
|
<dd><p>A locale in Hebcal is used for translations/transliterations of
|
|
53
|
-
holidays. <code>@hebcal/
|
|
53
|
+
holidays. <code>@hebcal/hdate</code> supports four locales by default</p>
|
|
54
54
|
<ul>
|
|
55
55
|
<li><code>en</code> - default, Sephardic transliterations (e.g. "Shabbat")</li>
|
|
56
56
|
<li><code>ashkenazi</code> - Ashkenazi transliterations (e.g. "Shabbos")</li>
|
|
@@ -61,6 +61,9 @@ holidays. <code>@hebcal/core</code> supports four locales by default</p>
|
|
|
61
61
|
<dt><a href="#HDate">HDate</a></dt>
|
|
62
62
|
<dd><p>Represents a Hebrew date</p>
|
|
63
63
|
</dd>
|
|
64
|
+
<dt><a href="#Sedra">Sedra</a></dt>
|
|
65
|
+
<dd><p>Represents Parashah HaShavua for an entire Hebrew year</p>
|
|
66
|
+
</dd>
|
|
64
67
|
<dt><a href="#Event">Event</a></dt>
|
|
65
68
|
<dd><p>Represents an Event with a title, date, and flags</p>
|
|
66
69
|
</dd>
|
|
@@ -116,9 +119,6 @@ conditions, observed values may vary from calculations.
|
|
|
116
119
|
<dt><a href="#OmerEvent">OmerEvent</a></dt>
|
|
117
120
|
<dd><p>Represents a day 1-49 of counting the Omer from Pesach to Shavuot</p>
|
|
118
121
|
</dd>
|
|
119
|
-
<dt><a href="#Sedra">Sedra</a></dt>
|
|
120
|
-
<dd><p>Represents Parashah HaShavua for an entire Hebrew year</p>
|
|
121
|
-
</dd>
|
|
122
122
|
<dt><a href="#ParshaEvent">ParshaEvent</a></dt>
|
|
123
123
|
<dd><p>Represents one of 54 weekly Torah portions, always on a Saturday</p>
|
|
124
124
|
</dd>
|
|
@@ -160,7 +160,7 @@ Event names can be rendered in several languges using the <code>locale</code> op
|
|
|
160
160
|
<dl>
|
|
161
161
|
<dt><a href="#parshiot">parshiot</a> : <code>Array.<string></code></dt>
|
|
162
162
|
<dd><p>The 54 parshiyot of the Torah as transilterated strings
|
|
163
|
-
parshiot[0] == 'Bereshit', parshiot[1] == 'Noach', parshiot[
|
|
163
|
+
parshiot[0] == 'Bereshit', parshiot[1] == 'Noach', parshiot[52] == "Ha'azinu".</p>
|
|
164
164
|
</dd>
|
|
165
165
|
</dl>
|
|
166
166
|
|
|
@@ -230,14 +230,29 @@ and vowels (nekudot).</p>
|
|
|
230
230
|
<dd><p>Returns an emoji number symbol with a circle, for example <code>㊲</code>
|
|
231
231
|
from the “Enclosed CJK Letters and Months” block of the Unicode standard</p>
|
|
232
232
|
</dd>
|
|
233
|
+
<dt><a href="#getPseudoISO">getPseudoISO(tzid, date)</a> ⇒ <code>string</code></dt>
|
|
234
|
+
<dd><p>Returns a string similar to <code>Date.toISOString()</code> but in the
|
|
235
|
+
timezone <code>tzid</code>. Contrary to the typical meaning of <code>Z</code> at the end
|
|
236
|
+
of the string, this is not actually a UTC date.</p>
|
|
237
|
+
</dd>
|
|
238
|
+
<dt><a href="#getTimezoneOffset">getTimezoneOffset(tzid, date)</a> ⇒ <code>number</code></dt>
|
|
239
|
+
<dd><p>Returns number of minutes <code>tzid</code> is offset from UTC on date <code>date</code>.</p>
|
|
240
|
+
</dd>
|
|
241
|
+
<dt><a href="#pad4">pad4(number)</a> ⇒ <code>string</code></dt>
|
|
242
|
+
<dd><p>Formats a number with leading zeros so the resulting string is 4 digits long.
|
|
243
|
+
Similar to <code>string.padStart(4, '0')</code> but will also format
|
|
244
|
+
negative numbers similar to how the JavaScript date formats
|
|
245
|
+
negative year numbers (e.g. <code>-37</code> is formatted as <code>-000037</code>).</p>
|
|
246
|
+
</dd>
|
|
247
|
+
<dt><a href="#pad2">pad2(number)</a> ⇒ <code>string</code></dt>
|
|
248
|
+
<dd><p>Formats a number with leading zeros so the resulting string is 2 digits long.
|
|
249
|
+
Similar to <code>string.padStart(2, '0')</code>.</p>
|
|
250
|
+
</dd>
|
|
233
251
|
</dl>
|
|
234
252
|
|
|
235
253
|
## Typedefs
|
|
236
254
|
|
|
237
255
|
<dl>
|
|
238
|
-
<dt><a href="#SedraResult">SedraResult</a> : <code>Object</code></dt>
|
|
239
|
-
<dd><p>Result of Sedra.lookup</p>
|
|
240
|
-
</dd>
|
|
241
256
|
<dt><a href="#CalOptions">CalOptions</a> : <code>Object</code></dt>
|
|
242
257
|
<dd><p>Options to configure which events are returned</p>
|
|
243
258
|
</dd>
|
|
@@ -249,7 +264,7 @@ and vowels (nekudot).</p>
|
|
|
249
264
|
|
|
250
265
|
## Locale
|
|
251
266
|
A locale in Hebcal is used for translations/transliterations of
|
|
252
|
-
holidays. `@hebcal/
|
|
267
|
+
holidays. `@hebcal/hdate` supports four locales by default
|
|
253
268
|
* `en` - default, Sephardic transliterations (e.g. "Shabbat")
|
|
254
269
|
* `ashkenazi` - Ashkenazi transliterations (e.g. "Shabbos")
|
|
255
270
|
* `he` - Hebrew (e.g. "שַׁבָּת")
|
|
@@ -263,7 +278,7 @@ holidays. `@hebcal/core` supports four locales by default
|
|
|
263
278
|
* [.addLocale(locale, data)](#Locale.addLocale)
|
|
264
279
|
* [.addTranslation(locale, id, translation)](#Locale.addTranslation)
|
|
265
280
|
* [.addTranslations(locale, data)](#Locale.addTranslations)
|
|
266
|
-
* [.useLocale(locale)](#Locale.useLocale)
|
|
281
|
+
* [.useLocale(locale)](#Locale.useLocale)
|
|
267
282
|
* [.getLocaleName()](#Locale.getLocaleName) ⇒ <code>string</code>
|
|
268
283
|
* [.getLocaleNames()](#Locale.getLocaleNames) ⇒ <code>Array.<string></code>
|
|
269
284
|
* [.ordinal(n, [locale])](#Locale.ordinal) ⇒ <code>string</code>
|
|
@@ -333,7 +348,7 @@ Adds multiple translations to `locale`, replacing any previous translations.
|
|
|
333
348
|
|
|
334
349
|
<a name="Locale.useLocale"></a>
|
|
335
350
|
|
|
336
|
-
### Locale.useLocale(locale)
|
|
351
|
+
### Locale.useLocale(locale)
|
|
337
352
|
Activates a locale. Throws an error if the locale has not been previously added.
|
|
338
353
|
After setting the locale to be used, all strings marked for translations
|
|
339
354
|
will be represented by the corresponding translation in the specified locale.
|
|
@@ -399,15 +414,15 @@ Represents a Hebrew date
|
|
|
399
414
|
* [.getMonthName()](#HDate+getMonthName) ⇒ <code>string</code>
|
|
400
415
|
* [.render([locale], [showYear])](#HDate+render) ⇒ <code>string</code>
|
|
401
416
|
* [.renderGematriya([suppressNikud])](#HDate+renderGematriya) ⇒ <code>string</code>
|
|
402
|
-
* [.before(
|
|
417
|
+
* [.before(dow)](#HDate+before) ⇒ [<code>HDate</code>](#HDate)
|
|
403
418
|
* [.onOrBefore(dow)](#HDate+onOrBefore) ⇒ [<code>HDate</code>](#HDate)
|
|
404
419
|
* [.nearest(dow)](#HDate+nearest) ⇒ [<code>HDate</code>](#HDate)
|
|
405
420
|
* [.onOrAfter(dow)](#HDate+onOrAfter) ⇒ [<code>HDate</code>](#HDate)
|
|
406
|
-
* [.after(
|
|
421
|
+
* [.after(dow)](#HDate+after) ⇒ [<code>HDate</code>](#HDate)
|
|
407
422
|
* [.next()](#HDate+next) ⇒ [<code>HDate</code>](#HDate)
|
|
408
423
|
* [.prev()](#HDate+prev) ⇒ [<code>HDate</code>](#HDate)
|
|
409
|
-
* [.add(
|
|
410
|
-
* [.subtract(
|
|
424
|
+
* [.add(amount, [units])](#HDate+add) ⇒ [<code>HDate</code>](#HDate)
|
|
425
|
+
* [.subtract(amount, [units])](#HDate+subtract) ⇒ [<code>HDate</code>](#HDate)
|
|
411
426
|
* [.deltaDays(other)](#HDate+deltaDays) ⇒ <code>number</code>
|
|
412
427
|
* [.isSameDate(other)](#HDate+isSameDate) ⇒ <code>boolean</code>
|
|
413
428
|
* [.toString()](#HDate+toString) ⇒ <code>string</code>
|
|
@@ -451,7 +466,7 @@ Create a Hebrew date. There are 3 basic forms for the `HDate()` constructor.
|
|
|
451
466
|
|
|
452
467
|
**Example**
|
|
453
468
|
```js
|
|
454
|
-
import {HDate, months} from '@hebcal/
|
|
469
|
+
import {HDate, months} from '@hebcal/hdate';
|
|
455
470
|
|
|
456
471
|
const hd1 = new HDate();
|
|
457
472
|
const hd2 = new HDate(new Date(2008, 10, 13));
|
|
@@ -534,12 +549,12 @@ including ordinal e.g. `'15th of Cheshvan, 5769'`.
|
|
|
534
549
|
|
|
535
550
|
| Param | Type | Default | Description |
|
|
536
551
|
| --- | --- | --- | --- |
|
|
537
|
-
| [locale] | <code>string</code> |
|
|
552
|
+
| [locale] | <code>string</code> | | Optional locale name (defaults to active locale). |
|
|
538
553
|
| [showYear] | <code>boolean</code> | <code>true</code> | Display year (defaults to true). |
|
|
539
554
|
|
|
540
555
|
**Example**
|
|
541
556
|
```js
|
|
542
|
-
import {HDate, months} from '@hebcal/
|
|
557
|
+
import {HDate, months} from '@hebcal/hdate';
|
|
543
558
|
|
|
544
559
|
const hd = new HDate(15, months.CHESHVAN, 5769);
|
|
545
560
|
console.log(hd.render('en')); // '15th of Cheshvan, 5769'
|
|
@@ -558,13 +573,13 @@ Renders this Hebrew date in Hebrew gematriya, regardless of locale.
|
|
|
558
573
|
|
|
559
574
|
**Example**
|
|
560
575
|
```js
|
|
561
|
-
import {HDate, months} from '@hebcal/
|
|
576
|
+
import {HDate, months} from '@hebcal/hdate';
|
|
562
577
|
const hd = new HDate(15, months.CHESHVAN, 5769);
|
|
563
578
|
console.log(hd.renderGematriya()); // 'ט״ו חֶשְׁוָן תשס״ט'
|
|
564
579
|
```
|
|
565
580
|
<a name="HDate+before"></a>
|
|
566
581
|
|
|
567
|
-
### hDate.before(
|
|
582
|
+
### hDate.before(dow) ⇒ [<code>HDate</code>](#HDate)
|
|
568
583
|
Returns an `HDate` representing the a dayNumber before the current date.
|
|
569
584
|
Sunday=0, Saturday=6
|
|
570
585
|
|
|
@@ -572,7 +587,7 @@ Sunday=0, Saturday=6
|
|
|
572
587
|
|
|
573
588
|
| Param | Type | Description |
|
|
574
589
|
| --- | --- | --- |
|
|
575
|
-
|
|
|
590
|
+
| dow | <code>number</code> | day of week |
|
|
576
591
|
|
|
577
592
|
**Example**
|
|
578
593
|
```js
|
|
@@ -633,7 +648,7 @@ new HDate(new Date('Sunday February 23, 2014')).onOrAfter(6).greg() // Sat Mar 0
|
|
|
633
648
|
```
|
|
634
649
|
<a name="HDate+after"></a>
|
|
635
650
|
|
|
636
|
-
### hDate.after(
|
|
651
|
+
### hDate.after(dow) ⇒ [<code>HDate</code>](#HDate)
|
|
637
652
|
Returns an `HDate` representing the a dayNumber after the current date.
|
|
638
653
|
Sunday=0, Saturday=6
|
|
639
654
|
|
|
@@ -641,7 +656,7 @@ Sunday=0, Saturday=6
|
|
|
641
656
|
|
|
642
657
|
| Param | Type | Description |
|
|
643
658
|
| --- | --- | --- |
|
|
644
|
-
|
|
|
659
|
+
| dow | <code>number</code> | day of week |
|
|
645
660
|
|
|
646
661
|
**Example**
|
|
647
662
|
```js
|
|
@@ -663,7 +678,7 @@ Returns the previous Hebrew date
|
|
|
663
678
|
**Kind**: instance method of [<code>HDate</code>](#HDate)
|
|
664
679
|
<a name="HDate+add"></a>
|
|
665
680
|
|
|
666
|
-
### hDate.add(
|
|
681
|
+
### hDate.add(amount, [units]) ⇒ [<code>HDate</code>](#HDate)
|
|
667
682
|
Returns a cloned `HDate` object with a specified amount of time added
|
|
668
683
|
|
|
669
684
|
Units are case insensitive, and support plural and short forms.
|
|
@@ -680,12 +695,12 @@ Note, short forms are case sensitive.
|
|
|
680
695
|
|
|
681
696
|
| Param | Type | Default |
|
|
682
697
|
| --- | --- | --- |
|
|
683
|
-
|
|
|
698
|
+
| amount | <code>number</code> | |
|
|
684
699
|
| [units] | <code>string</code> | <code>"d"</code> |
|
|
685
700
|
|
|
686
701
|
<a name="HDate+subtract"></a>
|
|
687
702
|
|
|
688
|
-
### hDate.subtract(
|
|
703
|
+
### hDate.subtract(amount, [units]) ⇒ [<code>HDate</code>](#HDate)
|
|
689
704
|
Returns a cloned `HDate` object with a specified amount of time subracted
|
|
690
705
|
|
|
691
706
|
Units are case insensitive, and support plural and short forms.
|
|
@@ -702,12 +717,12 @@ Note, short forms are case sensitive.
|
|
|
702
717
|
|
|
703
718
|
| Param | Type | Default |
|
|
704
719
|
| --- | --- | --- |
|
|
705
|
-
|
|
|
720
|
+
| amount | <code>number</code> | |
|
|
706
721
|
| [units] | <code>string</code> | <code>"d"</code> |
|
|
707
722
|
|
|
708
723
|
**Example**
|
|
709
724
|
```js
|
|
710
|
-
import {HDate, months} from '@hebcal/
|
|
725
|
+
import {HDate, months} from '@hebcal/hdate';
|
|
711
726
|
|
|
712
727
|
const hd1 = new HDate(15, months.CHESHVAN, 5769);
|
|
713
728
|
const hd2 = hd1.add(1, 'weeks'); // 7 Kislev 5769
|
|
@@ -732,7 +747,7 @@ The result is zero if the two dates are identical.
|
|
|
732
747
|
|
|
733
748
|
**Example**
|
|
734
749
|
```js
|
|
735
|
-
import {HDate, months} from '@hebcal/
|
|
750
|
+
import {HDate, months} from '@hebcal/hdate';
|
|
736
751
|
|
|
737
752
|
const hd1 = new HDate(25, months.KISLEV, 5770);
|
|
738
753
|
const hd2 = new HDate(15, months.CHESHVAN, 5769);
|
|
@@ -914,6 +929,110 @@ HDate.fromGematriyaString('כ״ז בְּתַמּוּז תשפ״ג') // 27 Tamuz
|
|
|
914
929
|
HDate.fromGematriyaString('כ׳ סיון תש״ד') // 20 Sivan 5704
|
|
915
930
|
HDate.fromGematriyaString('ה׳ אִיָיר תש״ח') // 5 Iyyar 5708
|
|
916
931
|
```
|
|
932
|
+
<a name="Sedra"></a>
|
|
933
|
+
|
|
934
|
+
## Sedra
|
|
935
|
+
Represents Parashah HaShavua for an entire Hebrew year
|
|
936
|
+
|
|
937
|
+
**Kind**: global class
|
|
938
|
+
|
|
939
|
+
* [Sedra](#Sedra)
|
|
940
|
+
* [new Sedra(hyear, il)](#new_Sedra_new)
|
|
941
|
+
* [.get(hd)](#Sedra+get) ⇒ <code>Array.<string></code>
|
|
942
|
+
* [.getString(hd, [locale])](#Sedra+getString) ⇒ <code>string</code>
|
|
943
|
+
* [.isParsha(hd)](#Sedra+isParsha) ⇒ <code>boolean</code>
|
|
944
|
+
* [.find(parsha)](#Sedra+find) ⇒ [<code>HDate</code>](#HDate) \| <code>null</code>
|
|
945
|
+
* [.getSedraArray()](#Sedra+getSedraArray) ⇒ <code>Array.<NumberOrString></code>
|
|
946
|
+
* [.getFirstSaturday()](#Sedra+getFirstSaturday) ⇒ <code>number</code>
|
|
947
|
+
* [.getYear()](#Sedra+getYear) ⇒ <code>number</code>
|
|
948
|
+
* [.lookup(hd)](#Sedra+lookup) ⇒ <code>SedraResult</code>
|
|
949
|
+
|
|
950
|
+
<a name="new_Sedra_new"></a>
|
|
951
|
+
|
|
952
|
+
### new Sedra(hyear, il)
|
|
953
|
+
Caculates the Parashah HaShavua for an entire Hebrew year
|
|
954
|
+
|
|
955
|
+
|
|
956
|
+
| Param | Type | Description |
|
|
957
|
+
| --- | --- | --- |
|
|
958
|
+
| hyear | <code>number</code> | Hebrew year (e.g. 5749) |
|
|
959
|
+
| il | <code>boolean</code> | Use Israel sedra schedule (false for Diaspora) |
|
|
960
|
+
|
|
961
|
+
<a name="Sedra+get"></a>
|
|
962
|
+
|
|
963
|
+
### sedra.get(hd) ⇒ <code>Array.<string></code>
|
|
964
|
+
Returns the parsha (or parshiyot) read on Hebrew date
|
|
965
|
+
|
|
966
|
+
**Kind**: instance method of [<code>Sedra</code>](#Sedra)
|
|
967
|
+
|
|
968
|
+
| Param | Type | Description |
|
|
969
|
+
| --- | --- | --- |
|
|
970
|
+
| hd | [<code>HDate</code>](#HDate) \| <code>number</code> | Hebrew date or R.D. days |
|
|
971
|
+
|
|
972
|
+
<a name="Sedra+getString"></a>
|
|
973
|
+
|
|
974
|
+
### sedra.getString(hd, [locale]) ⇒ <code>string</code>
|
|
975
|
+
Looks up parsha for the date, then returns a translated or transliterated string
|
|
976
|
+
|
|
977
|
+
**Kind**: instance method of [<code>Sedra</code>](#Sedra)
|
|
978
|
+
|
|
979
|
+
| Param | Type | Description |
|
|
980
|
+
| --- | --- | --- |
|
|
981
|
+
| hd | [<code>HDate</code>](#HDate) \| <code>number</code> | Hebrew date or R.D. days |
|
|
982
|
+
| [locale] | <code>string</code> | Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale |
|
|
983
|
+
|
|
984
|
+
<a name="Sedra+isParsha"></a>
|
|
985
|
+
|
|
986
|
+
### sedra.isParsha(hd) ⇒ <code>boolean</code>
|
|
987
|
+
Checks to see if this day would be a regular parasha HaShavua
|
|
988
|
+
Torah reading or special holiday reading
|
|
989
|
+
|
|
990
|
+
**Kind**: instance method of [<code>Sedra</code>](#Sedra)
|
|
991
|
+
|
|
992
|
+
| Param | Type | Description |
|
|
993
|
+
| --- | --- | --- |
|
|
994
|
+
| hd | [<code>HDate</code>](#HDate) \| <code>number</code> | Hebrew date or R.D. days |
|
|
995
|
+
|
|
996
|
+
<a name="Sedra+find"></a>
|
|
997
|
+
|
|
998
|
+
### sedra.find(parsha) ⇒ [<code>HDate</code>](#HDate) \| <code>null</code>
|
|
999
|
+
Returns the date that a parsha occurs
|
|
1000
|
+
or `null` if the parsha doesn't occur this year
|
|
1001
|
+
|
|
1002
|
+
**Kind**: instance method of [<code>Sedra</code>](#Sedra)
|
|
1003
|
+
|
|
1004
|
+
| Param | Type |
|
|
1005
|
+
| --- | --- |
|
|
1006
|
+
| parsha | <code>number</code> \| <code>string</code> \| <code>Array.<string></code> |
|
|
1007
|
+
|
|
1008
|
+
<a name="Sedra+getSedraArray"></a>
|
|
1009
|
+
|
|
1010
|
+
### sedra.getSedraArray() ⇒ <code>Array.<NumberOrString></code>
|
|
1011
|
+
Returns the underlying annual sedra schedule.
|
|
1012
|
+
Used by `@hebcal/triennial`
|
|
1013
|
+
|
|
1014
|
+
**Kind**: instance method of [<code>Sedra</code>](#Sedra)
|
|
1015
|
+
<a name="Sedra+getFirstSaturday"></a>
|
|
1016
|
+
|
|
1017
|
+
### sedra.getFirstSaturday() ⇒ <code>number</code>
|
|
1018
|
+
R.D. date of the first Saturday on or after Rosh Hashana
|
|
1019
|
+
|
|
1020
|
+
**Kind**: instance method of [<code>Sedra</code>](#Sedra)
|
|
1021
|
+
<a name="Sedra+getYear"></a>
|
|
1022
|
+
|
|
1023
|
+
### sedra.getYear() ⇒ <code>number</code>
|
|
1024
|
+
**Kind**: instance method of [<code>Sedra</code>](#Sedra)
|
|
1025
|
+
<a name="Sedra+lookup"></a>
|
|
1026
|
+
|
|
1027
|
+
### sedra.lookup(hd) ⇒ <code>SedraResult</code>
|
|
1028
|
+
Returns an object describing the parsha on the first Saturday on or after `hd`
|
|
1029
|
+
|
|
1030
|
+
**Kind**: instance method of [<code>Sedra</code>](#Sedra)
|
|
1031
|
+
|
|
1032
|
+
| Param | Type | Description |
|
|
1033
|
+
| --- | --- | --- |
|
|
1034
|
+
| hd | [<code>HDate</code>](#HDate) \| <code>number</code> | Hebrew date or R.D. days |
|
|
1035
|
+
|
|
917
1036
|
<a name="Event"></a>
|
|
918
1037
|
|
|
919
1038
|
## Event
|
|
@@ -2611,106 +2730,6 @@ Returns translation of "Omer day 22" without ordinal numbers.
|
|
|
2611
2730
|
|
|
2612
2731
|
### omerEvent.url() ⇒ <code>string</code>
|
|
2613
2732
|
**Kind**: instance method of [<code>OmerEvent</code>](#OmerEvent)
|
|
2614
|
-
<a name="Sedra"></a>
|
|
2615
|
-
|
|
2616
|
-
## Sedra
|
|
2617
|
-
Represents Parashah HaShavua for an entire Hebrew year
|
|
2618
|
-
|
|
2619
|
-
**Kind**: global class
|
|
2620
|
-
|
|
2621
|
-
* [Sedra](#Sedra)
|
|
2622
|
-
* [new Sedra(hebYr, il)](#new_Sedra_new)
|
|
2623
|
-
* [.get(hDate)](#Sedra+get) ⇒ <code>Array.<string></code>
|
|
2624
|
-
* [.getString(hDate, [locale])](#Sedra+getString) ⇒ <code>string</code>
|
|
2625
|
-
* [.isParsha(hDate)](#Sedra+isParsha) ⇒ <code>boolean</code>
|
|
2626
|
-
* [.find(parsha)](#Sedra+find) ⇒ [<code>HDate</code>](#HDate)
|
|
2627
|
-
* [.getSedraArray()](#Sedra+getSedraArray) ⇒ <code>Array.<Object></code>
|
|
2628
|
-
* [.getFirstSaturday()](#Sedra+getFirstSaturday) ⇒ <code>number</code>
|
|
2629
|
-
* [.getYear()](#Sedra+getYear) ⇒ <code>number</code>
|
|
2630
|
-
* [.lookup(hDate)](#Sedra+lookup) ⇒ [<code>SedraResult</code>](#SedraResult)
|
|
2631
|
-
|
|
2632
|
-
<a name="new_Sedra_new"></a>
|
|
2633
|
-
|
|
2634
|
-
### new Sedra(hebYr, il)
|
|
2635
|
-
Caculates the Parashah HaShavua for an entire Hebrew year
|
|
2636
|
-
|
|
2637
|
-
|
|
2638
|
-
| Param | Type | Description |
|
|
2639
|
-
| --- | --- | --- |
|
|
2640
|
-
| hebYr | <code>number</code> | Hebrew year (e.g. 5749) |
|
|
2641
|
-
| il | <code>boolean</code> | Use Israel sedra schedule (false for Diaspora) |
|
|
2642
|
-
|
|
2643
|
-
<a name="Sedra+get"></a>
|
|
2644
|
-
|
|
2645
|
-
### sedra.get(hDate) ⇒ <code>Array.<string></code>
|
|
2646
|
-
Returns the parsha (or parshiyot) read on Hebrew date
|
|
2647
|
-
|
|
2648
|
-
**Kind**: instance method of [<code>Sedra</code>](#Sedra)
|
|
2649
|
-
|
|
2650
|
-
| Param | Type | Description |
|
|
2651
|
-
| --- | --- | --- |
|
|
2652
|
-
| hDate | [<code>HDate</code>](#HDate) \| <code>number</code> | Hebrew date or R.D. days |
|
|
2653
|
-
|
|
2654
|
-
<a name="Sedra+getString"></a>
|
|
2655
|
-
|
|
2656
|
-
### sedra.getString(hDate, [locale]) ⇒ <code>string</code>
|
|
2657
|
-
Looks up parsha for the date, then returns a translated or transliterated string
|
|
2658
|
-
|
|
2659
|
-
**Kind**: instance method of [<code>Sedra</code>](#Sedra)
|
|
2660
|
-
|
|
2661
|
-
| Param | Type | Description |
|
|
2662
|
-
| --- | --- | --- |
|
|
2663
|
-
| hDate | [<code>HDate</code>](#HDate) \| <code>number</code> | Hebrew date or R.D. days |
|
|
2664
|
-
| [locale] | <code>string</code> | Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale |
|
|
2665
|
-
|
|
2666
|
-
<a name="Sedra+isParsha"></a>
|
|
2667
|
-
|
|
2668
|
-
### sedra.isParsha(hDate) ⇒ <code>boolean</code>
|
|
2669
|
-
Checks to see if this day would be a regular parasha HaShavua
|
|
2670
|
-
Torah reading or special holiday reading
|
|
2671
|
-
|
|
2672
|
-
**Kind**: instance method of [<code>Sedra</code>](#Sedra)
|
|
2673
|
-
|
|
2674
|
-
| Param | Type | Description |
|
|
2675
|
-
| --- | --- | --- |
|
|
2676
|
-
| hDate | [<code>HDate</code>](#HDate) \| <code>number</code> | Hebrew date or R.D. days |
|
|
2677
|
-
|
|
2678
|
-
<a name="Sedra+find"></a>
|
|
2679
|
-
|
|
2680
|
-
### sedra.find(parsha) ⇒ [<code>HDate</code>](#HDate)
|
|
2681
|
-
Returns the date that a parsha occurs
|
|
2682
|
-
|
|
2683
|
-
**Kind**: instance method of [<code>Sedra</code>](#Sedra)
|
|
2684
|
-
|
|
2685
|
-
| Param | Type |
|
|
2686
|
-
| --- | --- |
|
|
2687
|
-
| parsha | <code>number</code> \| <code>string</code> \| <code>Array.<string></code> |
|
|
2688
|
-
|
|
2689
|
-
<a name="Sedra+getSedraArray"></a>
|
|
2690
|
-
|
|
2691
|
-
### sedra.getSedraArray() ⇒ <code>Array.<Object></code>
|
|
2692
|
-
**Kind**: instance method of [<code>Sedra</code>](#Sedra)
|
|
2693
|
-
<a name="Sedra+getFirstSaturday"></a>
|
|
2694
|
-
|
|
2695
|
-
### sedra.getFirstSaturday() ⇒ <code>number</code>
|
|
2696
|
-
R.D. date of the first Saturday on or after Rosh Hashana
|
|
2697
|
-
|
|
2698
|
-
**Kind**: instance method of [<code>Sedra</code>](#Sedra)
|
|
2699
|
-
<a name="Sedra+getYear"></a>
|
|
2700
|
-
|
|
2701
|
-
### sedra.getYear() ⇒ <code>number</code>
|
|
2702
|
-
**Kind**: instance method of [<code>Sedra</code>](#Sedra)
|
|
2703
|
-
<a name="Sedra+lookup"></a>
|
|
2704
|
-
|
|
2705
|
-
### sedra.lookup(hDate) ⇒ [<code>SedraResult</code>](#SedraResult)
|
|
2706
|
-
Returns an object describing the parsha on the first Saturday on or after absdate
|
|
2707
|
-
|
|
2708
|
-
**Kind**: instance method of [<code>Sedra</code>](#Sedra)
|
|
2709
|
-
|
|
2710
|
-
| Param | Type | Description |
|
|
2711
|
-
| --- | --- | --- |
|
|
2712
|
-
| hDate | [<code>HDate</code>](#HDate) \| <code>number</code> | Hebrew date or R.D. days |
|
|
2713
|
-
|
|
2714
2733
|
<a name="ParshaEvent"></a>
|
|
2715
2734
|
|
|
2716
2735
|
## ParshaEvent
|
|
@@ -2933,7 +2952,7 @@ Learning schedules are provided by the `@hebcal/learning` package.
|
|
|
2933
2952
|
|
|
2934
2953
|
* [DailyLearning](#DailyLearning)
|
|
2935
2954
|
* [.addCalendar(name, calendar)](#DailyLearning.addCalendar)
|
|
2936
|
-
* [.lookup(name, hd)](#DailyLearning.lookup) ⇒ [<code>Event</code>](#Event)
|
|
2955
|
+
* [.lookup(name, hd, il)](#DailyLearning.lookup) ⇒ [<code>Event</code>](#Event) \| <code>null</code>
|
|
2937
2956
|
|
|
2938
2957
|
<a name="DailyLearning.addCalendar"></a>
|
|
2939
2958
|
|
|
@@ -2949,7 +2968,7 @@ Register a new learning calendar.
|
|
|
2949
2968
|
|
|
2950
2969
|
<a name="DailyLearning.lookup"></a>
|
|
2951
2970
|
|
|
2952
|
-
### DailyLearning.lookup(name, hd) ⇒ [<code>Event</code>](#Event)
|
|
2971
|
+
### DailyLearning.lookup(name, hd, il) ⇒ [<code>Event</code>](#Event) \| <code>null</code>
|
|
2953
2972
|
Returns an event from daily calendar for a given date. Returns `null` if there
|
|
2954
2973
|
is no learning from this calendar on this date.
|
|
2955
2974
|
|
|
@@ -2959,6 +2978,7 @@ is no learning from this calendar on this date.
|
|
|
2959
2978
|
| --- | --- |
|
|
2960
2979
|
| name | <code>string</code> |
|
|
2961
2980
|
| hd | [<code>HDate</code>](#HDate) |
|
|
2981
|
+
| il | <code>boolean</code> |
|
|
2962
2982
|
|
|
2963
2983
|
<a name="HebrewCalendar"></a>
|
|
2964
2984
|
|
|
@@ -2977,6 +2997,7 @@ Event names can be rendered in several languges using the `locale` option.
|
|
|
2977
2997
|
* [.getHolidaysForYear(year)](#HebrewCalendar.getHolidaysForYear) ⇒ <code>Map.<string, Array.<Event>></code>
|
|
2978
2998
|
* [.getHolidaysForYearArray(year, il)](#HebrewCalendar.getHolidaysForYearArray) ⇒ [<code>Array.<Event></code>](#Event)
|
|
2979
2999
|
* [.getHolidaysOnDate(date, [il])](#HebrewCalendar.getHolidaysOnDate) ⇒ [<code>Array.<Event></code>](#Event)
|
|
3000
|
+
* [.eruvTavshilin(date, il)](#HebrewCalendar.eruvTavshilin) ⇒ <code>boolean</code>
|
|
2980
3001
|
* [.reformatTimeStr(timeStr, suffix, options)](#HebrewCalendar.reformatTimeStr) ⇒ <code>string</code>
|
|
2981
3002
|
* [.version()](#HebrewCalendar.version) ⇒ <code>string</code>
|
|
2982
3003
|
* [.getSedra(hyear, il)](#HebrewCalendar.getSedra) ⇒ [<code>Sedra</code>](#Sedra)
|
|
@@ -3214,6 +3235,18 @@ Returns an array of Events on this date (or `undefined` if no events)
|
|
|
3214
3235
|
| date | [<code>HDate</code>](#HDate) \| <code>Date</code> \| <code>number</code> | Hebrew Date, Gregorian date, or absolute R.D. day number |
|
|
3215
3236
|
| [il] | <code>boolean</code> | use the Israeli schedule for holidays |
|
|
3216
3237
|
|
|
3238
|
+
<a name="HebrewCalendar.eruvTavshilin"></a>
|
|
3239
|
+
|
|
3240
|
+
### HebrewCalendar.eruvTavshilin(date, il) ⇒ <code>boolean</code>
|
|
3241
|
+
Eruv Tavshilin
|
|
3242
|
+
|
|
3243
|
+
**Kind**: static method of [<code>HebrewCalendar</code>](#HebrewCalendar)
|
|
3244
|
+
|
|
3245
|
+
| Param | Type |
|
|
3246
|
+
| --- | --- |
|
|
3247
|
+
| date | <code>Date</code> \| [<code>HDate</code>](#HDate) |
|
|
3248
|
+
| il | <code>boolean</code> |
|
|
3249
|
+
|
|
3217
3250
|
<a name="HebrewCalendar.reformatTimeStr"></a>
|
|
3218
3251
|
|
|
3219
3252
|
### HebrewCalendar.reformatTimeStr(timeStr, suffix, options) ⇒ <code>string</code>
|
|
@@ -3452,11 +3485,18 @@ Transliterated names of holidays, used by `Event.getDesc()`
|
|
|
3452
3485
|
| YOM_KIPPUR | <code>string</code> | <code>"YOM_KIPPUR"</code> | Yom Kippur |
|
|
3453
3486
|
| YOM_YERUSHALAYIM | <code>string</code> | <code>"YOM_YERUSHALAYIM"</code> | Yom Yerushalayim |
|
|
3454
3487
|
|
|
3488
|
+
<a name="HolidayDesc"></a>
|
|
3489
|
+
|
|
3490
|
+
## HolidayDesc : <code>enum</code>
|
|
3491
|
+
Transliterated names of holidays, used by `Event.getDesc()`
|
|
3492
|
+
|
|
3493
|
+
**Kind**: global enum
|
|
3494
|
+
**Read only**: true
|
|
3455
3495
|
<a name="parshiot"></a>
|
|
3456
3496
|
|
|
3457
3497
|
## parshiot : <code>Array.<string></code>
|
|
3458
3498
|
The 54 parshiyot of the Torah as transilterated strings
|
|
3459
|
-
parshiot[0] == 'Bereshit', parshiot[1] == 'Noach', parshiot[
|
|
3499
|
+
parshiot[0] == 'Bereshit', parshiot[1] == 'Noach', parshiot[52] == "Ha'azinu".
|
|
3460
3500
|
|
|
3461
3501
|
**Kind**: global constant
|
|
3462
3502
|
**Read only**: true
|
|
@@ -3671,19 +3711,57 @@ Returns an emoji number symbol with a circle, for example `㊲`
|
|
|
3671
3711
|
| --- | --- |
|
|
3672
3712
|
| omerDay | the day of the omer, 1-49 inclusive |
|
|
3673
3713
|
|
|
3674
|
-
<a name="
|
|
3714
|
+
<a name="getPseudoISO"></a>
|
|
3675
3715
|
|
|
3676
|
-
##
|
|
3677
|
-
|
|
3716
|
+
## getPseudoISO(tzid, date) ⇒ <code>string</code>
|
|
3717
|
+
Returns a string similar to `Date.toISOString()` but in the
|
|
3718
|
+
timezone `tzid`. Contrary to the typical meaning of `Z` at the end
|
|
3719
|
+
of the string, this is not actually a UTC date.
|
|
3678
3720
|
|
|
3679
|
-
**Kind**: global
|
|
3680
|
-
**Properties**
|
|
3721
|
+
**Kind**: global function
|
|
3681
3722
|
|
|
3682
|
-
|
|
|
3683
|
-
| --- | --- |
|
|
3684
|
-
|
|
|
3685
|
-
|
|
|
3686
|
-
|
|
3723
|
+
| Param | Type |
|
|
3724
|
+
| --- | --- |
|
|
3725
|
+
| tzid | <code>string</code> |
|
|
3726
|
+
| date | <code>Date</code> |
|
|
3727
|
+
|
|
3728
|
+
<a name="getTimezoneOffset"></a>
|
|
3729
|
+
|
|
3730
|
+
## getTimezoneOffset(tzid, date) ⇒ <code>number</code>
|
|
3731
|
+
Returns number of minutes `tzid` is offset from UTC on date `date`.
|
|
3732
|
+
|
|
3733
|
+
**Kind**: global function
|
|
3734
|
+
|
|
3735
|
+
| Param | Type |
|
|
3736
|
+
| --- | --- |
|
|
3737
|
+
| tzid | <code>string</code> |
|
|
3738
|
+
| date | <code>Date</code> |
|
|
3739
|
+
|
|
3740
|
+
<a name="pad4"></a>
|
|
3741
|
+
|
|
3742
|
+
## pad4(number) ⇒ <code>string</code>
|
|
3743
|
+
Formats a number with leading zeros so the resulting string is 4 digits long.
|
|
3744
|
+
Similar to `string.padStart(4, '0')` but will also format
|
|
3745
|
+
negative numbers similar to how the JavaScript date formats
|
|
3746
|
+
negative year numbers (e.g. `-37` is formatted as `-000037`).
|
|
3747
|
+
|
|
3748
|
+
**Kind**: global function
|
|
3749
|
+
|
|
3750
|
+
| Param | Type |
|
|
3751
|
+
| --- | --- |
|
|
3752
|
+
| number | <code>number</code> |
|
|
3753
|
+
|
|
3754
|
+
<a name="pad2"></a>
|
|
3755
|
+
|
|
3756
|
+
## pad2(number) ⇒ <code>string</code>
|
|
3757
|
+
Formats a number with leading zeros so the resulting string is 2 digits long.
|
|
3758
|
+
Similar to `string.padStart(2, '0')`.
|
|
3759
|
+
|
|
3760
|
+
**Kind**: global function
|
|
3761
|
+
|
|
3762
|
+
| Param | Type |
|
|
3763
|
+
| --- | --- |
|
|
3764
|
+
| number | <code>number</code> |
|
|
3687
3765
|
|
|
3688
3766
|
<a name="CalOptions"></a>
|
|
3689
3767
|
|
|
@@ -3695,37 +3773,37 @@ Options to configure which events are returned
|
|
|
3695
3773
|
|
|
3696
3774
|
| Name | Type | Description |
|
|
3697
3775
|
| --- | --- | --- |
|
|
3698
|
-
| location | [<code>Location</code>](#Location) | latitude/longitude/tzid used for candle-lighting |
|
|
3699
|
-
| year | <code>number</code> | Gregorian or Hebrew year |
|
|
3700
|
-
| isHebrewYear | <code>boolean</code> | to interpret year as Hebrew year |
|
|
3701
|
-
| month | <code>number</code> | Gregorian or Hebrew month (to filter results to a single month) |
|
|
3702
|
-
| numYears | <code>number</code> | generate calendar for multiple years (default 1) |
|
|
3703
|
-
| start | <code>Date</code> \| [<code>HDate</code>](#HDate) \| <code>number</code> | use specific start date (requires end date) |
|
|
3704
|
-
| end | <code>Date</code> \| [<code>HDate</code>](#HDate) \| <code>number</code> | use specific end date (requires start date) |
|
|
3705
|
-
| candlelighting | <code>boolean</code> | calculate candle-lighting and havdalah times |
|
|
3706
|
-
| candleLightingMins | <code>number</code> | minutes before sundown to light candles (default 18) |
|
|
3707
|
-
| havdalahMins | <code>number</code> | minutes after sundown for Havdalah (typical values are 42, 50, or 72). If `undefined` (the default), calculate Havdalah according to Tzeit Hakochavim - Nightfall (the point when 3 small stars are observable in the night time sky with the naked eye). If `0`, Havdalah times are suppressed. |
|
|
3708
|
-
| havdalahDeg | <code>number</code> | degrees for solar depression for Havdalah. Default is 8.5 degrees for 3 small stars. use 7.083 degrees for 3 medium-sized stars (observed by Dr. Baruch (Berthold) Cohn in his luach published in France in 1899). If `0`, Havdalah times are suppressed. |
|
|
3709
|
-
| fastEndDeg | <code>number</code> | degrees for solar depression for end of fast days. Default is 7.083 degrees for 3 medium-sized stars. Other commonly-used values include 6.45 degrees, as calculated by Rabbi Yechiel Michel Tucazinsky. |
|
|
3710
|
-
| useElevation | <code>boolean</code> | use elevation for calculations (default `false`). If `true`, use elevation to affect the calculation of all sunrise/sunset based zmanim. Note: there are some zmanim such as degree-based zmanim that are driven by the amount of light in the sky and are not impacted by elevation. These zmanim intentionally do not support elevation adjustment. |
|
|
3711
|
-
| sedrot | <code>boolean</code> | calculate parashah hashavua on Saturdays |
|
|
3712
|
-
| il | <code>boolean</code> | Israeli holiday and sedra schedule |
|
|
3713
|
-
| noMinorFast | <code>boolean</code> | suppress minor fasts |
|
|
3714
|
-
| noModern | <code>boolean</code> | suppress modern holidays |
|
|
3715
|
-
| noRoshChodesh | <code>boolean</code> | suppress Rosh Chodesh |
|
|
3716
|
-
| shabbatMevarchim | <code>boolean</code> | add Shabbat Mevarchim |
|
|
3717
|
-
| noSpecialShabbat | <code>boolean</code> | suppress Special Shabbat |
|
|
3718
|
-
| noHolidays | <code>boolean</code> | suppress regular holidays |
|
|
3719
|
-
| omer | <code>boolean</code> | include Days of the Omer |
|
|
3720
|
-
| molad | <code>boolean</code> | include event announcing the molad |
|
|
3721
|
-
| ashkenazi | <code>boolean</code> | use Ashkenazi transliterations for event titles (default Sephardi transliterations) |
|
|
3722
|
-
| locale | <code>string</code> | translate event titles according to a locale Default value is `en`, also built-in are `he` and `ashkenazi`. Additional locales (such as `ru` or `fr`) are provided by the [@hebcal/locales](https://github.com/hebcal/hebcal-locales) package |
|
|
3723
|
-
| addHebrewDates | <code>boolean</code> | print the Hebrew date for the entire date range |
|
|
3724
|
-
| addHebrewDatesForEvents | <code>boolean</code> | print the Hebrew date for dates with some events |
|
|
3725
|
-
| mask | <code>number</code> | use bitmask from `flags` to filter events |
|
|
3726
|
-
| yomKippurKatan | <code>boolean</code> | include Yom Kippur Katan (default `false`). יוֹם כִּפּוּר קָטָן is a minor day of atonement occurring monthly on the day preceeding each Rosh Chodesh. Yom Kippur Katan is omitted in Elul (on the day before Rosh Hashanah), Tishrei (Yom Kippur has just passed), Kislev (due to Chanukah) and Nisan (fasting not permitted during Nisan). When Rosh Chodesh occurs on Shabbat or Sunday, Yom Kippur Katan is observed on the preceding Thursday. See [Wikipedia Yom Kippur Katan practices](https://en.wikipedia.org/wiki/Yom_Kippur_Katan#Practices) |
|
|
3727
|
-
| hour12 | <code>boolean</code> | Whether to use 12-hour time (as opposed to 24-hour time). Possible values are `true` and `false`; the default is locale dependent. |
|
|
3728
|
-
| dailyLearning | <code>Object.<string, any></code> | map of options to enable daily study calendars such as `dafYomi`, `mishnaYomi`, `nachYomi` with value `true`. For `yerushalmi` the value should be a `number` for edition (`1` for Vilna, `2` for Schottenstein). |
|
|
3776
|
+
| [location] | [<code>Location</code>](#Location) | latitude/longitude/tzid used for candle-lighting |
|
|
3777
|
+
| [year] | <code>number</code> | Gregorian or Hebrew year |
|
|
3778
|
+
| [isHebrewYear] | <code>boolean</code> | to interpret year as Hebrew year |
|
|
3779
|
+
| [month] | <code>number</code> | Gregorian or Hebrew month (to filter results to a single month) |
|
|
3780
|
+
| [numYears] | <code>number</code> | generate calendar for multiple years (default 1) |
|
|
3781
|
+
| [start] | <code>Date</code> \| [<code>HDate</code>](#HDate) \| <code>number</code> | use specific start date (requires end date) |
|
|
3782
|
+
| [end] | <code>Date</code> \| [<code>HDate</code>](#HDate) \| <code>number</code> | use specific end date (requires start date) |
|
|
3783
|
+
| [candlelighting] | <code>boolean</code> | calculate candle-lighting and havdalah times |
|
|
3784
|
+
| [candleLightingMins] | <code>number</code> | minutes before sundown to light candles (default 18) |
|
|
3785
|
+
| [havdalahMins] | <code>number</code> | minutes after sundown for Havdalah (typical values are 42, 50, or 72). If `undefined` (the default), calculate Havdalah according to Tzeit Hakochavim - Nightfall (the point when 3 small stars are observable in the night time sky with the naked eye). If `0`, Havdalah times are suppressed. |
|
|
3786
|
+
| [havdalahDeg] | <code>number</code> | degrees for solar depression for Havdalah. Default is 8.5 degrees for 3 small stars. use 7.083 degrees for 3 medium-sized stars (observed by Dr. Baruch (Berthold) Cohn in his luach published in France in 1899). If `0`, Havdalah times are suppressed. |
|
|
3787
|
+
| [fastEndDeg] | <code>number</code> | degrees for solar depression for end of fast days. Default is 7.083 degrees for 3 medium-sized stars. Other commonly-used values include 6.45 degrees, as calculated by Rabbi Yechiel Michel Tucazinsky. |
|
|
3788
|
+
| [useElevation] | <code>boolean</code> | use elevation for calculations (default `false`). If `true`, use elevation to affect the calculation of all sunrise/sunset based zmanim. Note: there are some zmanim such as degree-based zmanim that are driven by the amount of light in the sky and are not impacted by elevation. These zmanim intentionally do not support elevation adjustment. |
|
|
3789
|
+
| [sedrot] | <code>boolean</code> | calculate parashah hashavua on Saturdays |
|
|
3790
|
+
| [il] | <code>boolean</code> | Israeli holiday and sedra schedule |
|
|
3791
|
+
| [noMinorFast] | <code>boolean</code> | suppress minor fasts |
|
|
3792
|
+
| [noModern] | <code>boolean</code> | suppress modern holidays |
|
|
3793
|
+
| [noRoshChodesh] | <code>boolean</code> | suppress Rosh Chodesh |
|
|
3794
|
+
| [shabbatMevarchim] | <code>boolean</code> | add Shabbat Mevarchim |
|
|
3795
|
+
| [noSpecialShabbat] | <code>boolean</code> | suppress Special Shabbat |
|
|
3796
|
+
| [noHolidays] | <code>boolean</code> | suppress regular holidays |
|
|
3797
|
+
| [omer] | <code>boolean</code> | include Days of the Omer |
|
|
3798
|
+
| [molad] | <code>boolean</code> | include event announcing the molad |
|
|
3799
|
+
| [ashkenazi] | <code>boolean</code> | use Ashkenazi transliterations for event titles (default Sephardi transliterations) |
|
|
3800
|
+
| [locale] | <code>string</code> | translate event titles according to a locale Default value is `en`, also built-in are `he` and `ashkenazi`. Additional locales (such as `ru` or `fr`) are provided by the [@hebcal/locales](https://github.com/hebcal/hebcal-locales) package |
|
|
3801
|
+
| [addHebrewDates] | <code>boolean</code> | print the Hebrew date for the entire date range |
|
|
3802
|
+
| [addHebrewDatesForEvents] | <code>boolean</code> | print the Hebrew date for dates with some events |
|
|
3803
|
+
| [mask] | <code>number</code> | use bitmask from `flags` to filter events |
|
|
3804
|
+
| [yomKippurKatan] | <code>boolean</code> | include Yom Kippur Katan (default `false`). יוֹם כִּפּוּר קָטָן is a minor day of atonement occurring monthly on the day preceeding each Rosh Chodesh. Yom Kippur Katan is omitted in Elul (on the day before Rosh Hashanah), Tishrei (Yom Kippur has just passed), Kislev (due to Chanukah) and Nisan (fasting not permitted during Nisan). When Rosh Chodesh occurs on Shabbat or Sunday, Yom Kippur Katan is observed on the preceding Thursday. See [Wikipedia Yom Kippur Katan practices](https://en.wikipedia.org/wiki/Yom_Kippur_Katan#Practices) |
|
|
3805
|
+
| [hour12] | <code>boolean</code> | Whether to use 12-hour time (as opposed to 24-hour time). Possible values are `true` and `false`; the default is locale dependent. |
|
|
3806
|
+
| [dailyLearning] | <code>Object.<string, any></code> | map of options to enable daily study calendars such as `dafYomi`, `mishnaYomi`, `nachYomi` with value `true`. For `yerushalmi` the value should be a `number` for edition (`1` for Vilna, `2` for Schottenstein). |
|
|
3729
3807
|
|
|
3730
3808
|
<a name="TachanunResult"></a>
|
|
3731
3809
|
|