Class HolidayEvent

Represents a built-in holiday like Pesach, Purim or Tu BiShvat.

Most holiday-related events emitted by calendar are instances of HolidayEvent or one of its subclasses (ChanukahEvent, AsaraBTevetEvent, RoshHashanaEvent, RoshChodeshEvent).

Adds two notable behaviors over the base Event:

HolidayEvent.basename strips qualifiers like Erev , I/II, (CH''M), (observed), candle counts, etc. (e.g. "Erev Pesach" → "Pesach").
HolidayEvent.url returns a https://www.hebcal.com/holidays/... link for the holiday.

Hierarchy (View Summary)

Event
- HolidayEvent

Index

Constructors

constructor

new HolidayEvent(
    date: HDate,
    desc: string,
    mask?: number,
    attrs?: object,
): HolidayEvent
Parameters
- date: HDate
- desc: string
- mask: number = 0
- Optionalattrs: object
Returns HolidayEvent
Overrides Event.constructor
- Defined in src/HolidayEvent.ts:32

Properties

`Optional`alarm

alarm?: string | boolean | Date

Alarms are used by iCalendar feeds

`Optional` `Readonly`cholHaMoedDay

cholHaMoedDay?: number

During Sukkot or Pesach

`Readonly`date

date: HDate

Hebrew date of this event

`Readonly`desc

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.

`Optional`emoji

emoji?: string

Optional emoji character such as ✡️, 🕯️, 🕎, 🕍, 🌒

`Readonly`mask

mask: number

Bitmask of optional event flags. See flags

`Optional`memo

memo?: string

Optional longer description or memo text

`Optional` `Readonly`observed

observed?: boolean

true if the fast day was postponed a day to avoid Shabbat.

Tish'a B'Av postponed from the 9th to the 10th
Tzom Tammuz postponed from the 17th to the 18th

Methods

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'
```
Overrides Event.basename
- Defined in src/HolidayEvent.ts:52

flagNames

flagNames(): (
    | "CHAG"
    | "LIGHT_CANDLES"
    | "YOM_TOV_ENDS"
    | "CHUL_ONLY"
    | "IL_ONLY"
    | "LIGHT_CANDLES_TZEIS"
    | "CHANUKAH_CANDLES"
    | "ROSH_CHODESH"
    | "MINOR_FAST"
    | "SPECIAL_SHABBAT"
    | "PARSHA_HASHAVUA"
    | "DAF_YOMI"
    | "OMER_COUNT"
    | "MODERN_HOLIDAY"
    | "MAJOR_FAST"
    | "SHABBAT_MEVARCHIM"
    | "MOLAD"
    | "USER_EVENT"
    | "HEBREW_DATE"
    | "MINOR_HOLIDAY"
    | "EREV"
    | "CHOL_HAMOED"
    | "MISHNA_YOMI"
    | "YOM_KIPPUR_KATAN"
    | "YERUSHALMI_YOMI"
    | "NACH_YOMI"
    | "DAILY_LEARNING"
    | "YIZKOR"
    | "BEHAB"
)[]
Names of all flags set on this event, in ascending bit order. Returns an empty array for an event with no flags.

Returns (
    | "CHAG"
    | "LIGHT_CANDLES"
    | "YOM_TOV_ENDS"
    | "CHUL_ONLY"
    | "IL_ONLY"
    | "LIGHT_CANDLES_TZEIS"
    | "CHANUKAH_CANDLES"
    | "ROSH_CHODESH"
    | "MINOR_FAST"
    | "SPECIAL_SHABBAT"
    | "PARSHA_HASHAVUA"
    | "DAF_YOMI"
    | "OMER_COUNT"
    | "MODERN_HOLIDAY"
    | "MAJOR_FAST"
    | "SHABBAT_MEVARCHIM"
    | "MOLAD"
    | "USER_EVENT"
    | "HEBREW_DATE"
    | "MINOR_HOLIDAY"
    | "EREV"
    | "CHOL_HAMOED"
    | "MISHNA_YOMI"
    | "YOM_KIPPUR_KATAN"
    | "YERUSHALMI_YOMI"
    | "NACH_YOMI"
    | "DAILY_LEARNING"
    | "YIZKOR"
    | "BEHAB"
)[]
Example
```
import {Event, HDate, flags} from '@hebcal/core';
const ev = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II',
  flags.CHAG | flags.CHUL_ONLY);
ev.flagNames(); // ['CHAG', 'CHUL_ONLY']
```
Inherited from Event.flagNames
- Defined in src/event.ts:235

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']
```
Overrides Event.getCategories
- Defined in src/HolidayEvent.ts:101

getDate

getDate(): HDate
Hebrew date of this event

Returns HDate
Inherited from Event.getDate
- Defined in src/event.ts:162

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
Inherited from Event.getDesc
- Defined in src/event.ts:177

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
Overrides Event.getEmoji
- Defined in src/HolidayEvent.ts:91

getFlags

getFlags(): number
Bitmask of optional event flags. See flags

Returns number

Deprecated
Use Event.hasFlag to test for a flag, or Event.flagNames to list them. Code that genuinely needs the raw bitmask can read Event.mask.
Inherited from Event.getFlags
- Defined in src/event.ts:186

greg

greg(): Date
Gregorian date of this event

Returns Date
Inherited from Event.greg
- Defined in src/event.ts:168

hasAnyFlag

hasAnyFlag(
    ...names: (
        | "CHAG"
        | "LIGHT_CANDLES"
        | "YOM_TOV_ENDS"
        | "CHUL_ONLY"
        | "IL_ONLY"
        | "LIGHT_CANDLES_TZEIS"
        | "CHANUKAH_CANDLES"
        | "ROSH_CHODESH"
        | "MINOR_FAST"
        | "SPECIAL_SHABBAT"
        | "PARSHA_HASHAVUA"
        | "DAF_YOMI"
        | "OMER_COUNT"
        | "MODERN_HOLIDAY"
        | "MAJOR_FAST"
        | "SHABBAT_MEVARCHIM"
        | "MOLAD"
        | "USER_EVENT"
        | "HEBREW_DATE"
        | "MINOR_HOLIDAY"
        | "EREV"
        | "CHOL_HAMOED"
        | "MISHNA_YOMI"
        | "YOM_KIPPUR_KATAN"
        | "YERUSHALMI_YOMI"
        | "NACH_YOMI"
        | "DAILY_LEARNING"
        | "YIZKOR"
        | "BEHAB"
    )[],
): boolean
Does this event have at least one of the given flags?

Returns false when called with no arguments.
Parameters
- ...names: (
      | "CHAG"
      | "LIGHT_CANDLES"
      | "YOM_TOV_ENDS"
      | "CHUL_ONLY"
      | "IL_ONLY"
      | "LIGHT_CANDLES_TZEIS"
      | "CHANUKAH_CANDLES"
      | "ROSH_CHODESH"
      | "MINOR_FAST"
      | "SPECIAL_SHABBAT"
      | "PARSHA_HASHAVUA"
      | "DAF_YOMI"
      | "OMER_COUNT"
      | "MODERN_HOLIDAY"
      | "MAJOR_FAST"
      | "SHABBAT_MEVARCHIM"
      | "MOLAD"
      | "USER_EVENT"
      | "HEBREW_DATE"
      | "MINOR_HOLIDAY"
      | "EREV"
      | "CHOL_HAMOED"
      | "MISHNA_YOMI"
      | "YOM_KIPPUR_KATAN"
      | "YERUSHALMI_YOMI"
      | "NACH_YOMI"
      | "DAILY_LEARNING"
      | "YIZKOR"
      | "BEHAB"
  )[]
  flag names, each one of the keys of flags
Returns boolean
Example
```
import {Event, HDate, flags} from '@hebcal/core';
const ev = new Event(new HDate(10, 'Tishrei', 5784), 'Yom Kippur',
  flags.CHAG | flags.MAJOR_FAST);
ev.hasAnyFlag('MAJOR_FAST', 'MINOR_FAST');  // true
ev.hasAnyFlag('ROSH_CHODESH', 'MINOR_FAST'); // false
```
Throws
if any name is not a key of flags
Inherited from Event.hasAnyFlag
- Defined in src/event.ts:219

hasFlag

hasFlag(
    name:
        | "CHAG"
        | "LIGHT_CANDLES"
        | "YOM_TOV_ENDS"
        | "CHUL_ONLY"
        | "IL_ONLY"
        | "LIGHT_CANDLES_TZEIS"
        | "CHANUKAH_CANDLES"
        | "ROSH_CHODESH"
        | "MINOR_FAST"
        | "SPECIAL_SHABBAT"
        | "PARSHA_HASHAVUA"
        | "DAF_YOMI"
        | "OMER_COUNT"
        | "MODERN_HOLIDAY"
        | "MAJOR_FAST"
        | "SHABBAT_MEVARCHIM"
        | "MOLAD"
        | "USER_EVENT"
        | "HEBREW_DATE"
        | "MINOR_HOLIDAY"
        | "EREV"
        | "CHOL_HAMOED"
        | "MISHNA_YOMI"
        | "YOM_KIPPUR_KATAN"
        | "YERUSHALMI_YOMI"
        | "NACH_YOMI"
        | "DAILY_LEARNING"
        | "YIZKOR"
        | "BEHAB",
): boolean
Does this event have the given flag?

A readable alternative to testing the bitmask with &.
Parameters
- name:
      | "CHAG"
      | "LIGHT_CANDLES"
      | "YOM_TOV_ENDS"
      | "CHUL_ONLY"
      | "IL_ONLY"
      | "LIGHT_CANDLES_TZEIS"
      | "CHANUKAH_CANDLES"
      | "ROSH_CHODESH"
      | "MINOR_FAST"
      | "SPECIAL_SHABBAT"
      | "PARSHA_HASHAVUA"
      | "DAF_YOMI"
      | "OMER_COUNT"
      | "MODERN_HOLIDAY"
      | "MAJOR_FAST"
      | "SHABBAT_MEVARCHIM"
      | "MOLAD"
      | "USER_EVENT"
      | "HEBREW_DATE"
      | "MINOR_HOLIDAY"
      | "EREV"
      | "CHOL_HAMOED"
      | "MISHNA_YOMI"
      | "YOM_KIPPUR_KATAN"
      | "YERUSHALMI_YOMI"
      | "NACH_YOMI"
      | "DAILY_LEARNING"
      | "YIZKOR"
      | "BEHAB"
  flag name, one of the keys of flags
Returns boolean
Example
```
import {Event, HDate, flags} from '@hebcal/core';
const ev = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II',
  flags.CHAG | flags.CHUL_ONLY);
ev.hasFlag('CHAG');        // true
ev.hasFlag('CHUL_ONLY');   // true
ev.hasFlag('MINOR_FAST');  // false
```
Throws
if name is not a key of flags
Inherited from Event.hasFlag
- Defined in src/event.ts:203

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

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

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

render

render(locale?: string): string
Returns (translated) description of this event
Parameters
- Optionallocale: string
  Optional locale name (defaults to empty locale)
Returns string
Overrides Event.render
- Defined in src/HolidayEvent.ts:130

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
Overrides Event.renderBrief
- Defined in src/HolidayEvent.ts:140

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
Overrides Event.url
- Defined in src/HolidayEvent.ts:69

urlDateSuffix

urlDateSuffix(): string
The date portion of url. For most holidays this is just the Gregorian year; subclasses override it when a year alone is ambiguous.

Returns string
- Defined in src/HolidayEvent.ts:86

Class HolidayEvent

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns HolidayEvent

Properties

Optionalalarm

Optional ReadonlycholHaMoedDay

Readonlydate

Readonlydesc

Optionalemoji

Readonlymask

Optionalmemo

Optional Readonlyobserved

Methods

basename

Returns string

Example

flagNames

Example

getCategories

Returns string[]

Example

getDate

Returns HDate

getDesc

Returns string

getEmoji

Returns string

getFlags

Returns number

Deprecated

greg

Returns Date

hasAnyFlag

Parameters

Returns boolean

Example

Throws

hasFlag

Parameters

Returns boolean

Example

Throws

observedIn

Parameters

Returns boolean

Example

observedInDiaspora

Returns boolean

Example

observedInIsrael

Returns boolean

Example

render

Parameters

Returns string

renderBrief

Parameters

Returns string

url

Returns string | undefined

urlDateSuffix

Returns string

Settings

On This Page

`Optional`alarm

`Optional` `Readonly`cholHaMoedDay

`Readonly`date

`Readonly`desc

`Optional`emoji

`Readonly`mask

`Optional`memo

`Optional` `Readonly`observed