Class ArukhHaShulchanYomiEvent

Optionalalarm

Readonlydate

Readonlydesc

Optionalemoji

Readonlymask

Optionalmemo

basename

• basename(): string

  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

clone

• clone(): Event

  Makes a clone of this Event object

  Returns Event

  Deprecated

getDate

• getDate(): HDate

  Hebrew date of this event

  Returns HDate

getDesc

• getDesc(): 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

getEmoji

• getEmoji(): null | string

  Optional holiday-specific Emoji or null.

  Returns null | string

getFlags

• getFlags(): number

  Bitmask of optional event flags. See flags

  Returns number

observedIn

• observedIn(il: boolean): boolean

  Is this event observed in Israel/Diaspora?

  Parameters

  • il: boolean

  Returns boolean

  Example

  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
  Copy

observedInDiaspora

• observedInDiaspora(): boolean

  Is this event observed in the Diaspora?

  Returns boolean

  Example

  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
  Copy

observedInIsrael

• observedInIsrael(): boolean

  Is this event observed in Israel?

  Returns boolean

  Example

  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
  Copy

renderBrief

• renderBrief(locale?: string): string

  Returns a brief (translated) description of this event. For most events, this is the same as render(). For some events, it procudes a shorter text (e.g. without a time or added description).

  Parameters

  • Optionallocale: string

    Optional locale name (defaults to active locale).

  Returns string