Optional
alarmAlarms are used by iCalendar feeds
Optional
chanukahOptional
cholDuring Sukkot or Pesach
Readonly
dateHebrew date of this event
Readonly
descUntranslated title of this event. Note that these description
strings are always in English and will remain stable across releases.
To get the title of the event in another language, use the
render()
method.
Optional
emojiOptional emoji character such as ✡️, 🕯️, 🕎, 🕍, 🌒
Readonly
maskBitmask of optional event flags. See flags
Optional
memoOptional longer description or memo text
Optional
observedtrue
if the fast day was postponed a day to avoid Shabbat.
Returns a simplified (untranslated) description for this event. For example,
the HolidayEvent
class supports
"Erev Pesach" => "Pesach", and "Sukkot III (CH''M)" => "Sukkot".
For many holidays the basename and the event description are the same.
Returns a list of event categories
Hebrew date of this event
Untranslated title of this event. Note that these description
strings are always in English and will remain stable across releases.
To get the title of the event in another language, use the
render()
method.
Optional holiday-specific Emoji or null
.
Bitmask of optional event flags. See flags
Is this event observed in Israel/Diaspora?
const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
ev1.observedIn(false); // true
ev1.observedIn(true); // false
const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
ev2.observedIn(false); // true
ev2.observedIn(true); // true
Is this event observed in the Diaspora?
Returns (translated) description of this event
Optional
locale: stringOptional locale name (defaults to active locale).
Returns a brief (translated) description of this event. For most events, this is the same as render(). For some events, it procudes a shorter text (e.g. without a time or added description).
Optional
locale: stringOptional locale name (defaults to active locale).
Returns a URL to hebcal.com or sefaria.org for more detail on the event.
Returns undefined
for events with no detail page.
Because Asara B'Tevet often occurs twice in the same Gregorian year, we subclass HolidayEvent to generate the correct URL.