OptionalstartEvent: TimedEventOptionalendEvent: TimedEventOptionalalarmAlarms are used by iCalendar feeds
Optional ReadonlycholDuring Sukkot or Pesach
ReadonlydateHebrew date of this event
ReadonlydescUntranslated 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.
OptionalemojiOptional emoji character such as ✡️, 🕯️, 🕎, 🕍, 🌒
Optional Readonlyendthis will be a "Fast ends" event
Readonlylinkedoriginal event
ReadonlymaskBitmask of optional event flags. See flags
OptionalmemoOptional longer description or memo text
Optional Readonlyobservedtrue if the fast day was postponed a day to avoid Shabbat.
Optional Readonlystartthis will be a "Fast begins" event
Returns a simplified (untranslated) name for this holiday, stripping qualifiers so that related events group under one name.
Strips trailing 4-digit years, (CH''M), (observed), (Hoshana Raba),
Roman-numeral day numbers ( I, II, ...), Chanukah candle counts,
: 8th Day, and a leading "Erev ".
Names of all flags set on this event, in ascending bit order. Returns an empty array for an event with no flags.
Returns an array of category strings classifying this event, derived
from its flags bitmask. The first element is the broad category
(e.g. 'holiday', 'roshchodesh', 'parashat', 'omer'), followed
by zero or more refinements (e.g. 'major', 'minor', 'fast').
Returns ['unknown'] if no flag maps to a known category.
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.
Returns the event's emoji character (e.g. 🕯️, 🕎, 🇮🇱, 🍏🍯),
or null if no emoji is associated with this event.
Subclasses override this to provide holiday-specific emoji.
Bitmask of optional event flags. See flags
Use Event.hasFlag to test for a flag, or Event.flagNames to list them. Code that genuinely needs the raw bitmask can read Event.mask.
Gregorian date of this event
Does this event have at least one of the given flags?
Returns false when called with no arguments.
flag names, each one of the keys of flags
import {Event, HDate, flags} from '@hebcal/core';
const ev = new Event(new HDate(10, 'Tishrei', 5784), 'Yom Kippur',
flags.CHAG | flags.MAJOR_FAST);
ev.hasAnyFlag('MAJOR_FAST', 'MINOR_FAST'); // true
ev.hasAnyFlag('ROSH_CHODESH', 'MINOR_FAST'); // false
if any name is not a key of flags
Does this event have the given flag?
A readable alternative to testing the bitmask with &.
flag name, one of the keys of flags
import {Event, HDate, flags} from '@hebcal/core';
const ev = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II',
flags.CHAG | flags.CHUL_ONLY);
ev.hasFlag('CHAG'); // true
ev.hasFlag('CHUL_ONLY'); // true
ev.hasFlag('MINOR_FAST'); // false
if name is not a key of 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
Optionallocale: string
Optional locale name (defaults to empty 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).
Optionallocale: string
Optional locale name (defaults to empty locale)
Returns a https://www.hebcal.com/holidays/... URL for more detail on
this holiday. Israel-only holidays get an ?i=on query parameter.
Returns undefined for years outside [100, 2999].
The date portion of url. For most holidays this is just the Gregorian year; subclasses override it when a year alone is ambiguous.
A fast day holiday with attached start and end time events.
Wraps an underlying fast-day HolidayEvent and (when computable for the given location) exposes a "Fast begins" and "Fast ends" TimedEvent. Generated by calendar when
options.candlelightingistrueandoptions.locationis provided.options.fastStartDegoroptions.fastStartMins. By default they end at tzeit 7.083° (3 medium-sized stars) in the Diaspora, or 15 minutes after sunset in Israel (Rabbi Deblitzky's practice). This can be overridden viaoptions.fastEndDegoroptions.fastEndMins.options.fastStartDeg/options.fastStartMins. By default it ends at tzeit 6.45° below horizon (Rabbi Yechiel Michel Tucazinsky), which can be overridden viaoptions.tishaBavEndDegoroptions.tishaBavEndMins(but not byoptions.fastEndDeg/options.fastEndMins).