Class YerushalmiYomiEvent

Event wrapper around a Yerushalmi Yomi result

Hierarchy

  • Event
    • YerushalmiYomiEvent

Constructors

Properties

alarm?: string | boolean | Date
category: string
date: HDate
desc: string
emoji?: string
mask: number
memo?: string

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

  • Makes a clone of this Event object

    Returns Event

  • Returns a list of event categories

    Returns string[]

  • Hebrew date of this event

    Returns HDate

  • Untranslated description of this event

    Returns string

  • Optional holiday-specific Emoji or null.

    Returns null | string

  • Bitmask of optional event flags. See flags

    Returns number

  • 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
  • Returns name of tractate and page (e.g. "Yerushalmi Beitzah 21").

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

    Returns string

  • Returns name of tractate and page (e.g. "Beitzah 21").

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

    Returns string