@hebcal/learning
    Preparing search index...

    Class DafWeeklyEvent

    Event wrapper around the Daf-a-Week Talmud page — the same daf is repeated each day of the week.

    The cycle began on Sunday, 6 March 2005 (25 Adar I 5765). Looking up a date earlier than that returns null from DailyLearning.lookup('dafWeekly', ...).

    Two calendars use this event: dafWeekly (every day of the week) and dafWeeklySunday (only on Sundays — lookup returns null on Mon-Sat).

    import {HDate} from '@hebcal/hdate';
    import {DailyLearning} from '@hebcal/core/dist/esm/DailyLearning';
    import '@hebcal/learning/dafWeekly';

    const hd = new HDate(new Date(2024, 3, 8)); // 29 Adar II 5784
    const ev = DailyLearning.lookup('dafWeekly', hd);
    console.log(ev.render('en'));
    // => "Ketubot 83"

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    alarm?: string | boolean | Date

    Alarms are used by iCalendar feeds

    daf: DafPage
    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. Subclasses override this with their calendar's display name (e.g. "Daf Yomi", "Daily Rambam", "929").

      Returns string

    Methods

    • 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

      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'
    • 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[]

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

    • 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

    • 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 Daf Yomi name including the 'Daf Yomi: ' prefix (e.g. "Daf Yomi: Pesachim 107").

      Parameters

      • Optionallocale: string

        Optional locale name (defaults to active locale).

      Returns string

    • Returns Daf Yomi name without the 'Daf Yomi: ' prefix (e.g. "Pesachim 107").

      Parameters

      • Optionallocale: string

        Optional locale name (defaults to active locale).

      Returns string