@hebcal/core
    Preparing search index...

    Class ParshaEvent

    Represents one of 54 weekly Torah portions, always on a Saturday.

    ParshaEvent is for regular Parashat HaShavua readings. For Shabbatot with holiday readings such as Shabbat Chol ha-Moed, use getHolidaysOnDate() from @hebcal/core, or getLeyningOnDate() from @hebcal/leyning when the display title and exact Torah readings are needed.

    Hierarchy (View Summary)

    Index
    constructor
    alarm? date desc emoji? mask memo? p
    parsha
    basename getCategories getDate getDesc getEmoji getFlags greg observedIn observedInDiaspora observedInIsrael render renderBrief url urlDateSuffix
    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 ✡️, 🕯️, 🕎, 🕍, 🌒

    mask: number

    Bitmask of optional event flags. See flags

    memo?: string

    Optional longer description or memo text

    p: SedraResult

    The parsha name(s) and date this event was constructed from

    • get parsha(): string[]

      convenience function for compatibility with previous implementation

      Returns string[]

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

    • 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

    • 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 (i.e: 'he', 'fr'). Defaults to empty locale.

      Returns string

    • Returns a brief (translated) description of this event.

      For most events this is the same as render. Some subclasses (e.g. CandleLightingEvent, HavdalahEvent, OmerEvent) produce shorter text without an attached time or extra qualifier — useful for compact UI display.

      Parameters

      • Optionallocale: string

        Optional locale name (defaults to empty locale)

      Returns string

      import {CandleLightingEvent} from '@hebcal/core';
      // For a regular Event, renderBrief() == render():
      const ev = new Event(new HDate(6, 'Sivan', 5749), 'Shavuot', flags.CHAG);
      ev.renderBrief('en'); // 'Shavuot'

    • The date portion of url, as YYYYMMDD — a parsha name recurs every year, so the full date is needed to identify the reading.

      Returns string

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods