@hebcal/learning
    Preparing search index...

    Class DirshuAmudYomiEvent

    Event wrapper around a Dirshu Amud HaYomi result

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    alarm? amud date desc emoji? mask memo?

    Accessors

    category

    Methods

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

    Constructors

    Properties

    alarm?: string | boolean | Date

    Alarms are used by iCalendar feeds

    amud: DirshuAmudYomi
    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 ✡️, 🕯️, 🕎, 🕍, 🌒

    mask: number

    Bitmask of optional event flags. See flags

    memo?: string

    Optional longer description or memo text

    Accessors

    • get category(): string

      Category name used as the location field in iCalendar event feeds.

      Returns 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

    • Hebrew date of this event

      Returns HDate

    • 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

    • Optional holiday-specific Emoji or null.

      Returns string | null

    • Bitmask of optional event flags. See flags

      Returns number

    • Gregorian date of this event

      Returns Date

    • 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 the name with "Dirshu Amud HaYomi: " prefix (e.g. "Dirshu Amud HaYomi: Shekalim 4b"). In Hebrew, uses full amud notation with "דף" and "ע״א"/"ע״ב" (e.g. "פסחים דף פ״ד ע״ב").

      Parameters

      • Optionallocale: string

        Optional locale name (defaults to active locale).

      Returns string

    • Returns name of tractate and amud (e.g. "Shekalim 4b"). In Hebrew, uses short notation without "דף" and with plain "א"/"ב" (e.g. "פסחים פ״ד ב").

      Parameters

      • Optionallocale: string

        Optional locale name (defaults to active locale).

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods