Class ChanukahEvent

Optionalalarm

OptionalcholHaMoedDay

Readonlydate

Readonlydesc

Optionalemoji

Readonlymask

Optionalmemo

Optionalobserved

basename

• basename(): string

  Returns a simplified (untranslated) name for this holiday, stripping qualifiers so that related events group under one name.

  Strips trailing 4-digit years, (CH''M), (observed), (Hoshana Raba), Roman-numeral day numbers ( I, II, ...), Chanukah candle counts, : 8th Day, and a leading "Erev ".

  Returns string

  Example

  // 'Erev Pesach'           => 'Pesach'
  // 'Sukkot III (CH''M)'    => 'Sukkot'
  // 'Chanukah: 5 Candles'   => 'Chanukah'
  // 'Rosh Hashana 5784'     => 'Rosh Hashana'
  Copy

getCategories

• getCategories(): string[]

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

  Example

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

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

getFlags

• getFlags(): number

  Bitmask of optional event flags. See flags

  Returns number

greg

• greg(): Date

  Gregorian date of this event

  Returns Date

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

render

• render(locale?: string): string

  Returns (translated) description of this event

  Parameters

  • Optionallocale: string

    Optional locale name (defaults to empty locale)

  Returns string

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 empty locale)

  Returns string

url

• url(): string | undefined

  Returns a https://www.hebcal.com/holidays/... URL for more detail on this holiday. Israel-only holidays get an ?i=on query parameter. Returns undefined for years outside [100, 2999].

  Returns string | undefined