Class TimedEvent

An event that has an eventTime and eventTimeStr

Hierarchy (view full)

Constructors

Properties

alarm?: string | boolean | Date

Alarms are used by iCalendar feeds

date: HDate

Hebrew date of this event

desc: 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.

emoji?: string

Optional emoji character such as ✡️, 🕯️, 🕎, 🕍, 🌒

eventTime: Date
eventTimeStr: string
fmtTime: string
linkedEvent?: Event
location: Location
mask: number

Bitmask of optional event flags. See flags

memo?: string

Optional longer description or memo text

Methods

  • 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 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

  • Is this event observed in Israel/Diaspora?

    Parameters

    • il: boolean

    Returns boolean

    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 boolean

    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
  • Is this event observed in Israel?

    Returns boolean

    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
  • Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

    Returns string

  • Returns translation of "Candle lighting" without the time.

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

    Returns string

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

    Returns undefined | string