Class HolidayEvent

Represents a built-in holiday like Pesach, Purim or Tu BiShvat

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties

alarm? chanukahDay? cholHaMoedDay? date desc emoji? mask memo? observed?

Methods

basename clone getCategories getDate getDesc getEmoji getFlags observedIn observedInDiaspora observedInIsrael render renderBrief url urlDateSuffix

Constructors

constructor

  • new HolidayEvent(
        date: HDate,
        desc: string,
        mask?: number,
        attrs?: object,
    ): HolidayEvent

  • Constructs Event

    Parameters

    • date: HDate

      Hebrew date event occurs

    • desc: string

      Description (not translated)

    • Optionalmask: number = 0

      optional bitmask of holiday flags (see flags)

    • Optionalattrs: object

      optional additional attributes (e.g. eventTimeStr, cholHaMoedDay)

    Returns HolidayEvent

Properties

Optionalalarm

alarm?: string | boolean | Date

Alarms are used by iCalendar feeds

OptionalchanukahDay

chanukahDay?: number

OptionalcholHaMoedDay

cholHaMoedDay?: number

During Sukkot or Pesach

Readonlydate

date: HDate

Hebrew date of this event

Readonlydesc

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.

Optionalemoji

emoji?: string

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

Readonlymask

mask: number

Bitmask of optional event flags. See flags

Optionalmemo

memo?: string

Optional longer description or memo text

Optionalobserved

observed?: boolean

true if the fast day was postponed a day to avoid Shabbat.

  • Tish'a B'Av postponed from the 9th to the 10th
  • Tzom Tammuz postponed from the 17th to the 18th

Methods

basename

  • basename(): string

  • 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

clone

getCategories

getDate

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

getFlags

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

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

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

render

  • render(locale?: string): string

  • Returns (translated) description of this event

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

    Returns string

renderBrief

  • renderBrief(locale?: string): string

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

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

    Returns string

url

urlDateSuffix

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR