Class DailyLearningEventAbstract

Optionalalarm

Readonlydate

Readonlydesc

Optionalemoji

Readonlymask

Optionalmemo

basename

• basename(): string

  Returns a simplified (untranslated) description for this event, suitable for grouping related events under a single name.

  For example, HolidayEvent strips qualifiers so that "Erev Pesach" → "Pesach" and "Sukkot III (CH''M)" → "Sukkot". For many events the basename and the event description are identical.

  Returns string

  Example

  import {HolidayEvent, HDate, months, flags} from '@hebcal/core';
  const ev = new HolidayEvent(
    new HDate(14, months.NISAN, 5784), 'Erev Pesach', flags.EREV);
  ev.getDesc();    // 'Erev Pesach'
  ev.basename();   // 'Pesach'
  Copy

getCategories

• getCategories(): string[]

  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.

  Returns string[]

  Example

  import {Event, HDate, flags} from '@hebcal/core';
  new Event(new HDate(10, 'Tishrei', 5784), 'Yom Kippur', flags.MAJOR_FAST)
    .getCategories(); // ['holiday', 'major', 'fast']
  new Event(new HDate(1, 'Shvat', 5784), 'Rosh Chodesh Sh\'vat', flags.ROSH_CHODESH)
    .getCategories(); // ['roshchodesh']
  Copy

getDate

• getDate(): HDate

  Hebrew date of this event

  Returns HDate

getDesc

• getDesc(): string

  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 string

getEmoji

• getEmoji(): string | null

  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.

  Returns string | null

getFlags

• getFlags(): number

  Bitmask of optional event flags. See flags

  Returns number

greg

• greg(): Date

  Gregorian date of this event

  Returns Date

observedIn

• observedIn(il: boolean): boolean

  Is this event observed in Israel/Diaspora?

  Parameters

  • il: boolean

  Returns boolean

  Example

  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
  Copy

observedInDiaspora

• observedInDiaspora(): boolean

  Is this event observed in the Diaspora?

  Returns boolean

  Example

  const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
  ev1.observedInDiaspora(); // true
  const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
  ev2.observedInDiaspora(); // true
  Copy

observedInIsrael

• observedInIsrael(): boolean

  Is this event observed in Israel?

  Returns boolean

  Example

  const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
  ev1.observedInIsrael(); // false
  const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
  ev2.observedInIsrael(); // true
  Copy

render

• render(locale?: string): string

  Returns (translated) description of this event

  Parameters

  • Optionallocale: string

    Optional locale name (defaults to empty locale)

  Returns string

  Example

  const ev = new Event(new HDate(6, 'Sivan', 5749), 'Shavuot', flags.CHAG);
  ev.render('en'); // 'Shavuot'
  ev.render('he'); // 'שָׁבוּעוֹת'
  ev.render('ashkenazi'); // 'Shavuos'
  Copy

renderBrief

• renderBrief(locale?: string): string

  Returns a brief (translated) description of this event.

  For most events this is the same as render. Some subclasses (e.g. CandleLightingEvent, HavdalahEvent, OmerEvent) produce shorter text without an attached time or extra qualifier — useful for compact UI display.

  Parameters

  • Optionallocale: string

    Optional locale name (defaults to empty locale)

  Returns string

  Example

  import {CandleLightingEvent} from '@hebcal/core';
  // For a regular Event, renderBrief() == render():
  const ev = new Event(new HDate(6, 'Sivan', 5749), 'Shavuot', flags.CHAG);
  ev.renderBrief('en'); // 'Shavuot'
  Copy

url

• url(): string | undefined

  Returns a URL to hebcal.com or sefaria.org for more detail on the event, or undefined for events with no detail page.

  Subclasses such as HolidayEvent, ChanukahEvent, AsaraBTevetEvent, ParshaEvent, and OmerEvent override this with their own URL patterns.

  Returns string | undefined