@hebcal/core
    Preparing search index...

    Class OmerEvent

    Represents a day 1-49 of counting the Omer from Pesach to Shavuot

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    alarm? date desc emoji? mask memo? omer

    Methods

    basename getCategories getDate getDaysWithinWeeks getDesc getEmoji getFlags getTodayIs getWeeks greg observedIn observedInDiaspora observedInIsrael render renderBrief sefira url

    Constructors

    Properties

    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

    omer: number

    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

    • 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 an emoji number symbol with a circle, for example ㊲ from the “Enclosed CJK Letters and Months” block of the Unicode standard

      Returns string

      a single Unicode character from ① through ㊾

    • Returns a sentence with that evening's omer count

      Parameters

      • locale: string

      Returns string

      a string such as Today is 10 days, which is 1 week and 3 days of the Omer or הַיוֹם עֲשָׂרָה יָמִים, שְׁהֵם שָׁבוּעַ אֶחָד וְשְׁלוֹשָׁה יָמִים לָעוֹמֶר

    • 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 (defaults to empty locale)

      Returns string

    • Returns translation of "Omer day 22" without ordinal numbers.

      Parameters

      • Optionallocale: string

        Optional locale name (defaults to empty locale)

      Returns string

    • Returns the sefira. For example, on day 8:

      • חֶֽסֶד שֶׁבִּגְבוּרָה
      • Chesed shebiGevurah
      • Lovingkindness within Might

      Parameters

      • lang: OmerLang = 'en'

        en (English), he (Hebrew with nikud), or translit (Hebrew in Sephardic transliteration)

      Returns string

      a string such as Lovingkindness within Might or חֶֽסֶד שֶׁבִּגְבוּרָה

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods