@hebcal/core 6.8.2 → 6.9.0

package/dist/esm/event.js.map

@@ -1 +1 @@
-{"version":3,"file":"event.js","sources":["../../../src/event.ts"],"sourcesContent":["import {HDate, Locale} from '@hebcal/hdate';\nimport './locale'; // Adds Hebrew and Ashkenazic translations\n\n/**\n * Holiday flags for Event. These flags are typically\n * combined using bitwise arithmetic to form a mask.\n * @readonly\n * @enum {number}\n */\nexport const flags = {\n  /** Chag, yontiff, yom tov */\n  CHAG: 0x000001,\n  /** Light candles 18 minutes before sundown */\n  LIGHT_CANDLES: 0x000002,\n  /** End of holiday (end of Yom Tov)  */\n  YOM_TOV_ENDS: 0x000004,\n  /** Observed only in the Diaspora (chutz l'aretz)  */\n  CHUL_ONLY: 0x000008,\n  /** Observed only in Israel */\n  IL_ONLY: 0x000010,\n  /** Light candles in the evening at Tzeit time (3 small stars) */\n  LIGHT_CANDLES_TZEIS: 0x000020,\n  /** Candle-lighting for Chanukah */\n  CHANUKAH_CANDLES: 0x000040,\n  /** Rosh Chodesh, beginning of a new Hebrew month */\n  ROSH_CHODESH: 0x000080,\n  /** Minor fasts like Tzom Tammuz, Ta'anit Esther, ... */\n  MINOR_FAST: 0x000100,\n  /** Shabbat Shekalim, Zachor, ... */\n  SPECIAL_SHABBAT: 0x000200,\n  /** Weekly sedrot on Saturdays */\n  PARSHA_HASHAVUA: 0x000400,\n  /** Daily page of Talmud (Bavli) */\n  DAF_YOMI: 0x000800,\n  /** Days of the Omer */\n  OMER_COUNT: 0x001000,\n  /** Yom HaShoah, Yom HaAtzma'ut, ... */\n  MODERN_HOLIDAY: 0x002000,\n  /** Yom Kippur and Tish'a B'Av */\n  MAJOR_FAST: 0x004000,\n  /** On the Saturday before Rosh Chodesh */\n  SHABBAT_MEVARCHIM: 0x008000,\n  /** Molad */\n  MOLAD: 0x010000,\n  /** Yahrzeit or Hebrew Anniversary */\n  USER_EVENT: 0x020000,\n  /** Daily Hebrew date (\"11th of Sivan, 5780\") */\n  HEBREW_DATE: 0x040000,\n  /** A holiday that's not major, modern, rosh chodesh, or a fast day */\n  MINOR_HOLIDAY: 0x080000,\n  /** Evening before a major or minor holiday */\n  EREV: 0x100000,\n  /** Chol haMoed, intermediate days of Pesach or Sukkot */\n  CHOL_HAMOED: 0x200000,\n  /** Mishna Yomi */\n  MISHNA_YOMI: 0x400000,\n  /** Yom Kippur Katan, minor day of atonement on the day preceeding each Rosh Chodesh */\n  YOM_KIPPUR_KATAN: 0x800000,\n  /** Daily page of Jerusalem Talmud (Yerushalmi) */\n  YERUSHALMI_YOMI: 0x1000000,\n  /** Nach Yomi */\n  NACH_YOMI: 0x2000000,\n  /** Daily Learning */\n  DAILY_LEARNING: 0x4000000,\n  /** Yizkor */\n  YIZKOR: 0x8000000,\n  /** BeHaB fast days on Monday, Thursday and Monday after Pesach and Sukkot */\n  BEHAB: 0x10000000,\n} as const;\n\nconst flagToCategory = [\n  [flags.MAJOR_FAST, 'holiday', 'major', 'fast'],\n  [flags.CHANUKAH_CANDLES, 'holiday', 'minor'],\n  [flags.HEBREW_DATE, 'hebdate'],\n  [flags.MINOR_FAST, 'holiday', 'fast'],\n  [flags.MINOR_HOLIDAY, 'holiday', 'minor'],\n  [flags.MODERN_HOLIDAY, 'holiday', 'modern'],\n  [flags.MOLAD, 'molad'],\n  [flags.OMER_COUNT, 'omer'],\n  [flags.PARSHA_HASHAVUA, 'parashat'], // backwards-compat\n  [flags.ROSH_CHODESH, 'roshchodesh'],\n  [flags.SHABBAT_MEVARCHIM, 'mevarchim'],\n  [flags.SPECIAL_SHABBAT, 'holiday', 'shabbat'],\n  [flags.USER_EVENT, 'user'],\n  [flags.YIZKOR, 'yizkor'],\n] as const;\n\n/**\n * Represents an Event with a title, date, and flags.\n *\n * Events are used to represent holidays, candle-lighting times,\n * Torah readings, Omer days, Hebrew dates, and more. Most concrete event\n * types are subclasses (e.g. {@link HolidayEvent}, {@link TimedEvent},\n * {@link ParshaEvent}, {@link OmerEvent}) and are produced by\n * {@link HebrewCalendar.calendar}.\n *\n * To get the title of the event in a language other than English with\n * Sephardic transliterations, use the {@link Event.render} method.\n *\n * @example\n * import {Event, HDate, flags} from '@hebcal/core';\n * const ev = new Event(new HDate(6, 'Sivan', 5749), 'Shavuot', flags.CHAG);\n * ev.getDate().toString(); // '6 Sivan 5749'\n * ev.getDesc();             // 'Shavuot'\n * ev.render('he');          // 'שָׁבוּעוֹת'\n */\nexport class Event {\n  /** Hebrew date of this event */\n  readonly date: HDate;\n  /**\n   * Untranslated title of this event. Note that these description\n   * strings are always in English and will remain stable across releases.\n   * To get the title of the event in another language, use the\n   * `render()` method.\n   */\n  readonly desc: string;\n  /** Bitmask of optional event flags. See {@link flags} */\n  readonly mask: number;\n  /** Optional emoji character such as ✡️, 🕯️, 🕎, 🕍, 🌒 */\n  emoji?: string;\n  /** Optional longer description or memo text */\n  memo?: string;\n  /** Alarms are used by iCalendar feeds */\n  alarm?: Date | string | boolean;\n  /**\n   * Constructs Event\n   * @param date Hebrew date event occurs\n   * @param desc Description (not translated)\n   * @param [mask=0] optional bitmask of holiday flags (see {@link flags})\n   * @param [attrs={}] optional additional attributes (e.g. `eventTimeStr`, `cholHaMoedDay`)\n   */\n  constructor(date: HDate, desc: string, mask = 0, attrs?: object) {\n    if (!HDate.isHDate(date)) {\n      throw new TypeError(`Invalid Event date: ${date}`);\n    }\n    if (typeof desc !== 'string') {\n      throw new TypeError(`Invalid Event description: ${desc}`);\n    }\n    this.date = date;\n    this.desc = desc;\n    this.mask = +mask;\n    if (typeof attrs === 'object' && attrs !== null) {\n      Object.assign(this, attrs);\n    }\n  }\n  /**\n   * Hebrew date of this event\n   */\n  getDate(): HDate {\n    return this.date;\n  }\n  /**\n   * Gregorian date of this event\n   */\n  greg(): Date {\n    return this.date.greg();\n  }\n  /**\n   * Untranslated title of this event. Note that these description\n   * strings are always in English and will remain stable across releases.\n   * To get the title of the event in another language, use the\n   * `render()` method.\n   */\n  getDesc(): string {\n    return this.desc;\n  }\n  /**\n   * Bitmask of optional event flags. See {@link flags}\n   */\n  getFlags(): number {\n    return this.mask;\n  }\n  /**\n   * Returns (translated) description of this event\n   * @example\n   * const ev = new Event(new HDate(6, 'Sivan', 5749), 'Shavuot', flags.CHAG);\n   * ev.render('en'); // 'Shavuot'\n   * ev.render('he'); // 'שָׁבוּעוֹת'\n   * ev.render('ashkenazi'); // 'Shavuos'\n   * @param [locale] Optional locale name (defaults to empty locale)\n   */\n  render(locale?: string): string {\n    return Locale.gettext(this.desc, locale);\n  }\n  /**\n   * Returns a brief (translated) description of this event.\n   *\n   * For most events this is the same as {@link render}. Some subclasses\n   * (e.g. {@link CandleLightingEvent}, {@link HavdalahEvent},\n   * {@link OmerEvent}) produce shorter text without an attached time or\n   * extra qualifier — useful for compact UI display.\n   * @example\n   * import {CandleLightingEvent} from '@hebcal/core';\n   * // For a regular Event, renderBrief() == render():\n   * const ev = new Event(new HDate(6, 'Sivan', 5749), 'Shavuot', flags.CHAG);\n   * ev.renderBrief('en'); // 'Shavuot'\n   * @param [locale] Optional locale name (defaults to empty locale)\n   */\n  renderBrief(locale?: string): string {\n    return this.render(locale);\n  }\n  /**\n   * Returns the event's emoji character (e.g. `🕯️`, `🕎`, `🇮🇱`, `🍏🍯`),\n   * or `null` if no emoji is associated with this event.\n   * Subclasses override this to provide holiday-specific emoji.\n   */\n  getEmoji(): string | null {\n    return this.emoji || null;\n  }\n  /**\n   * Returns a simplified (untranslated) description for this event, suitable\n   * for grouping related events under a single name.\n   *\n   * For example, {@link HolidayEvent} strips qualifiers so that\n   * `\"Erev Pesach\"` → `\"Pesach\"` and `\"Sukkot III (CH''M)\"` → `\"Sukkot\"`.\n   * For many events the basename and the event description are identical.\n   * @example\n   * import {HolidayEvent, HDate, months, flags} from '@hebcal/core';\n   * const ev = new HolidayEvent(\n   *   new HDate(14, months.NISAN, 5784), 'Erev Pesach', flags.EREV);\n   * ev.getDesc();    // 'Erev Pesach'\n   * ev.basename();   // 'Pesach'\n   */\n  basename(): string {\n    return this.getDesc();\n  }\n  /**\n   * Returns a URL to hebcal.com or sefaria.org for more detail on the event,\n   * or `undefined` for events with no detail page.\n   *\n   * Subclasses such as {@link HolidayEvent}, {@link ChanukahEvent},\n   * {@link AsaraBTevetEvent}, {@link ParshaEvent}, and {@link OmerEvent}\n   * override this with their own URL patterns.\n   */\n  url(): string | undefined {\n    return undefined;\n  }\n  /**\n   * Is this event observed in Israel?\n   * @example\n   * const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);\n   * ev1.observedInIsrael(); // false\n   * const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);\n   * ev2.observedInIsrael(); // true\n   */\n  observedInIsrael(): boolean {\n    return !(this.mask & flags.CHUL_ONLY);\n  }\n  /**\n   * Is this event observed in the Diaspora?\n   * @example\n   * const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);\n   * ev1.observedInDiaspora(); // true\n   * const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);\n   * ev2.observedInDiaspora(); // true\n   */\n  observedInDiaspora(): boolean {\n    return !(this.mask & flags.IL_ONLY);\n  }\n  /**\n   * Is this event observed in Israel/Diaspora?\n   * @example\n   * const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);\n   * ev1.observedIn(false); // true\n   * ev1.observedIn(true); // false\n   * const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);\n   * ev2.observedIn(false); // true\n   * ev2.observedIn(true); // true\n   * @param il\n   */\n  observedIn(il: boolean): boolean {\n    return il ? this.observedInIsrael() : this.observedInDiaspora();\n  }\n  /**\n   * Returns an array of category strings classifying this event, derived\n   * from its {@link flags} bitmask. The first element is the broad category\n   * (e.g. `'holiday'`, `'roshchodesh'`, `'parashat'`, `'omer'`), followed\n   * by zero or more refinements (e.g. `'major'`, `'minor'`, `'fast'`).\n   *\n   * Returns `['unknown']` if no flag maps to a known category.\n   * @example\n   * import {Event, HDate, flags} from '@hebcal/core';\n   * new Event(new HDate(10, 'Tishrei', 5784), 'Yom Kippur', flags.MAJOR_FAST)\n   *   .getCategories(); // ['holiday', 'major', 'fast']\n   * new Event(new HDate(1, 'Shvat', 5784), 'Rosh Chodesh Sh\\'vat', flags.ROSH_CHODESH)\n   *   .getCategories(); // ['roshchodesh']\n   */\n  getCategories(): string[] {\n    const mask = this.getFlags();\n    for (const attrs of flagToCategory) {\n      const attr0 = attrs[0] as number;\n      if (mask & attr0) {\n        return attrs.slice(1) as string[];\n      }\n    }\n    return ['unknown'];\n  }\n}\n"],"names":[],"mappings":";;;;AAGA;;;;;AAKG;AACI,MAAM,KAAK,GAAG;;AAEnB,IAAA,IAAI,EAAE,QAAQ;;AAEd,IAAA,aAAa,EAAE,QAAQ;;AAEvB,IAAA,YAAY,EAAE,QAAQ;;AAEtB,IAAA,SAAS,EAAE,QAAQ;;AAEnB,IAAA,OAAO,EAAE,QAAQ;;AAEjB,IAAA,mBAAmB,EAAE,QAAQ;;AAE7B,IAAA,gBAAgB,EAAE,QAAQ;;AAE1B,IAAA,YAAY,EAAE,QAAQ;;AAEtB,IAAA,UAAU,EAAE,QAAQ;;AAEpB,IAAA,eAAe,EAAE,QAAQ;;AAEzB,IAAA,eAAe,EAAE,QAAQ;;AAEzB,IAAA,QAAQ,EAAE,QAAQ;;AAElB,IAAA,UAAU,EAAE,QAAQ;;AAEpB,IAAA,cAAc,EAAE,QAAQ;;AAExB,IAAA,UAAU,EAAE,QAAQ;;AAEpB,IAAA,iBAAiB,EAAE,QAAQ;;AAE3B,IAAA,KAAK,EAAE,QAAQ;;AAEf,IAAA,UAAU,EAAE,QAAQ;;AAEpB,IAAA,WAAW,EAAE,QAAQ;;AAErB,IAAA,aAAa,EAAE,QAAQ;;AAEvB,IAAA,IAAI,EAAE,QAAQ;;AAEd,IAAA,WAAW,EAAE,QAAQ;;AAErB,IAAA,WAAW,EAAE,QAAQ;;AAErB,IAAA,gBAAgB,EAAE,QAAQ;;AAE1B,IAAA,eAAe,EAAE,SAAS;;AAE1B,IAAA,SAAS,EAAE,SAAS;;AAEpB,IAAA,cAAc,EAAE,SAAS;;AAEzB,IAAA,MAAM,EAAE,SAAS;;AAEjB,IAAA,KAAK,EAAE,UAAU;;AAGnB,MAAM,cAAc,GAAG;IACrB,CAAC,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC;AAC9C,IAAA,CAAC,KAAK,CAAC,gBAAgB,EAAE,SAAS,EAAE,OAAO,CAAC;AAC5C,IAAA,CAAC,KAAK,CAAC,WAAW,EAAE,SAAS,CAAC;AAC9B,IAAA,CAAC,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC;AACrC,IAAA,CAAC,KAAK,CAAC,aAAa,EAAE,SAAS,EAAE,OAAO,CAAC;AACzC,IAAA,CAAC,KAAK,CAAC,cAAc,EAAE,SAAS,EAAE,QAAQ,CAAC;AAC3C,IAAA,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC;AACtB,IAAA,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC;AAC1B,IAAA,CAAC,KAAK,CAAC,eAAe,EAAE,UAAU,CAAC;AACnC,IAAA,CAAC,KAAK,CAAC,YAAY,EAAE,aAAa,CAAC;AACnC,IAAA,CAAC,KAAK,CAAC,iBAAiB,EAAE,WAAW,CAAC;AACtC,IAAA,CAAC,KAAK,CAAC,eAAe,EAAE,SAAS,EAAE,SAAS,CAAC;AAC7C,IAAA,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC;AAC1B,IAAA,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC;CAChB;AAEV;;;;;;;;;;;;;;;;;;AAkBG;MACU,KAAK,CAAA;;AAEP,IAAA,IAAI;AACb;;;;;AAKG;AACM,IAAA,IAAI;;AAEJ,IAAA,IAAI;;AAEb,IAAA,KAAK;;AAEL,IAAA,IAAI;;AAEJ,IAAA,KAAK;AACL;;;;;;AAMG;IACH,WAAA,CAAY,IAAW,EAAE,IAAY,EAAE,IAAI,GAAG,CAAC,EAAE,KAAc,EAAA;QAC7D,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;AACxB,YAAA,MAAM,IAAI,SAAS,CAAC,uBAAuB,IAAI,CAAA,CAAE,CAAC;QACpD;AACA,QAAA,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;AAC5B,YAAA,MAAM,IAAI,SAAS,CAAC,8BAA8B,IAAI,CAAA,CAAE,CAAC;QAC3D;AACA,QAAA,IAAI,CAAC,IAAI,GAAG,IAAI;AAChB,QAAA,IAAI,CAAC,IAAI,GAAG,IAAI;AAChB,QAAA,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI;QACjB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;AAC/C,YAAA,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC;QAC5B;IACF;AACA;;AAEG;IACH,OAAO,GAAA;QACL,OAAO,IAAI,CAAC,IAAI;IAClB;AACA;;AAEG;IACH,IAAI,GAAA;AACF,QAAA,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;IACzB;AACA;;;;;AAKG;IACH,OAAO,GAAA;QACL,OAAO,IAAI,CAAC,IAAI;IAClB;AACA;;AAEG;IACH,QAAQ,GAAA;QACN,OAAO,IAAI,CAAC,IAAI;IAClB;AACA;;;;;;;;AAQG;AACH,IAAA,MAAM,CAAC,MAAe,EAAA;QACpB,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC;IAC1C;AACA;;;;;;;;;;;;;AAaG;AACH,IAAA,WAAW,CAAC,MAAe,EAAA;AACzB,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC5B;AACA;;;;AAIG;IACH,QAAQ,GAAA;AACN,QAAA,OAAO,IAAI,CAAC,KAAK,IAAI,IAAI;IAC3B;AACA;;;;;;;;;;;;;AAaG;IACH,QAAQ,GAAA;AACN,QAAA,OAAO,IAAI,CAAC,OAAO,EAAE;IACvB;AACA;;;;;;;AAOG;IACH,GAAG,GAAA;AACD,QAAA,OAAO,SAAS;IAClB;AACA;;;;;;;AAOG;IACH,gBAAgB,GAAA;QACd,OAAO,EAAE,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC;IACvC;AACA;;;;;;;AAOG;IACH,kBAAkB,GAAA;QAChB,OAAO,EAAE,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC;IACrC;AACA;;;;;;;;;;AAUG;AACH,IAAA,UAAU,CAAC,EAAW,EAAA;AACpB,QAAA,OAAO,EAAE,GAAG,IAAI,CAAC,gBAAgB,EAAE,GAAG,IAAI,CAAC,kBAAkB,EAAE;IACjE;AACA;;;;;;;;;;;;;AAaG;IACH,aAAa,GAAA;AACX,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE;AAC5B,QAAA,KAAK,MAAM,KAAK,IAAI,cAAc,EAAE;AAClC,YAAA,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAW;AAChC,YAAA,IAAI,IAAI,GAAG,KAAK,EAAE;AAChB,gBAAA,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAa;YACnC;QACF;QACA,OAAO,CAAC,SAAS,CAAC;IACpB;AACD;;;;"}
+{"version":3,"file":"event.js","sources":["../../../src/event.ts"],"sourcesContent":["import {HDate, Locale} from '@hebcal/hdate';\nimport './locale'; // Adds Hebrew and Ashkenazic translations\n\n/**\n * Holiday flags for Event. These flags are typically\n * combined using bitwise arithmetic to form a mask.\n */\nexport const flags = {\n  /** Chag, yontiff, yom tov */\n  CHAG: 0x000001,\n  /** Light candles before sundown */\n  LIGHT_CANDLES: 0x000002,\n  /** End of holiday (end of Yom Tov)  */\n  YOM_TOV_ENDS: 0x000004,\n  /** Observed only in the Diaspora (chutz l'aretz)  */\n  CHUL_ONLY: 0x000008,\n  /** Observed only in Israel */\n  IL_ONLY: 0x000010,\n  /** Light candles in the evening at Tzeit time (3 small stars) */\n  LIGHT_CANDLES_TZEIS: 0x000020,\n  /** Candle-lighting for Chanukah */\n  CHANUKAH_CANDLES: 0x000040,\n  /** Rosh Chodesh, beginning of a new Hebrew month */\n  ROSH_CHODESH: 0x000080,\n  /** Minor fasts like Tzom Tammuz, Ta'anit Esther, ... */\n  MINOR_FAST: 0x000100,\n  /** Shabbat Shekalim, Zachor, ... */\n  SPECIAL_SHABBAT: 0x000200,\n  /** Weekly sedrot on Saturdays */\n  PARSHA_HASHAVUA: 0x000400,\n  /** Daily page of Talmud (Bavli) */\n  DAF_YOMI: 0x000800,\n  /** Days of the Omer */\n  OMER_COUNT: 0x001000,\n  /** Yom HaShoah, Yom HaAtzma'ut, ... */\n  MODERN_HOLIDAY: 0x002000,\n  /** Yom Kippur and Tish'a B'Av */\n  MAJOR_FAST: 0x004000,\n  /** On the Saturday before Rosh Chodesh */\n  SHABBAT_MEVARCHIM: 0x008000,\n  /** Molad */\n  MOLAD: 0x010000,\n  /** Yahrzeit or Hebrew Anniversary */\n  USER_EVENT: 0x020000,\n  /** Daily Hebrew date (\"11th of Sivan, 5780\") */\n  HEBREW_DATE: 0x040000,\n  /** A holiday that's not major, modern, rosh chodesh, or a fast day */\n  MINOR_HOLIDAY: 0x080000,\n  /** Evening before a major or minor holiday */\n  EREV: 0x100000,\n  /** Chol haMoed, intermediate days of Pesach or Sukkot */\n  CHOL_HAMOED: 0x200000,\n  /** Mishna Yomi */\n  MISHNA_YOMI: 0x400000,\n  /** Yom Kippur Katan, minor day of atonement on the day preceeding each Rosh Chodesh */\n  YOM_KIPPUR_KATAN: 0x800000,\n  /** Daily page of Jerusalem Talmud (Yerushalmi) */\n  YERUSHALMI_YOMI: 0x1000000,\n  /** Nach Yomi */\n  NACH_YOMI: 0x2000000,\n  /** Daily Learning */\n  DAILY_LEARNING: 0x4000000,\n  /** Yizkor */\n  YIZKOR: 0x8000000,\n  /** BeHaB fast days on Monday, Thursday and Monday after Pesach and Sukkot */\n  BEHAB: 0x10000000,\n} as const;\n\nconst flagToCategory = [\n  [flags.MAJOR_FAST, 'holiday', 'major', 'fast'],\n  [flags.CHANUKAH_CANDLES, 'holiday', 'minor'],\n  [flags.HEBREW_DATE, 'hebdate'],\n  [flags.MINOR_FAST, 'holiday', 'fast'],\n  [flags.MINOR_HOLIDAY, 'holiday', 'minor'],\n  [flags.MODERN_HOLIDAY, 'holiday', 'modern'],\n  [flags.MOLAD, 'molad'],\n  [flags.OMER_COUNT, 'omer'],\n  [flags.PARSHA_HASHAVUA, 'parashat'], // backwards-compat\n  [flags.ROSH_CHODESH, 'roshchodesh'],\n  [flags.SHABBAT_MEVARCHIM, 'mevarchim'],\n  [flags.SPECIAL_SHABBAT, 'holiday', 'shabbat'],\n  [flags.USER_EVENT, 'user'],\n  [flags.YIZKOR, 'yizkor'],\n] as const;\n\n/**\n * Represents an Event with a title, date, and flags.\n *\n * Events are used to represent holidays, candle-lighting times,\n * Torah readings, Omer days, Hebrew dates, and more. Most concrete event\n * types are subclasses (e.g. {@link HolidayEvent}, {@link TimedEvent},\n * {@link ParshaEvent}, {@link OmerEvent}) and are produced by\n * {@link calendar}.\n *\n * To get the title of the event in a language other than English with\n * Sephardic transliterations, use the {@link Event.render} method.\n *\n * @example\n * import {Event, HDate, flags} from '@hebcal/core';\n * const ev = new Event(new HDate(6, 'Sivan', 5749), 'Shavuot', flags.CHAG);\n * ev.getDate().toString(); // '6 Sivan 5749'\n * ev.getDesc();             // 'Shavuot'\n * ev.render('he');          // 'שָׁבוּעוֹת'\n */\nexport class Event {\n  /** Hebrew date of this event */\n  readonly date: HDate;\n  /**\n   * Untranslated title of this event. Note that these description\n   * strings are always in English and will remain stable across releases.\n   * To get the title of the event in another language, use the\n   * `render()` method.\n   */\n  readonly desc: string;\n  /** Bitmask of optional event flags. See {@link flags} */\n  readonly mask: number;\n  /** Optional emoji character such as ✡️, 🕯️, 🕎, 🕍, 🌒 */\n  emoji?: string;\n  /** Optional longer description or memo text */\n  memo?: string;\n  /** Alarms are used by iCalendar feeds */\n  alarm?: Date | string | boolean;\n  /**\n   * Constructs Event\n   * @param date Hebrew date event occurs\n   * @param desc Description (not translated)\n   * @param [mask=0] optional bitmask of holiday flags (see {@link flags})\n   * @param [attrs={}] optional additional attributes (e.g. `eventTimeStr`, `cholHaMoedDay`)\n   */\n  constructor(date: HDate, desc: string, mask = 0, attrs?: object) {\n    if (!HDate.isHDate(date)) {\n      throw new TypeError(`Invalid Event date: ${date}`);\n    }\n    if (typeof desc !== 'string') {\n      throw new TypeError(`Invalid Event description: ${desc}`);\n    }\n    this.date = date;\n    this.desc = desc;\n    this.mask = +mask;\n    if (typeof attrs === 'object' && attrs !== null) {\n      Object.assign(this, attrs);\n    }\n  }\n  /**\n   * Hebrew date of this event\n   */\n  getDate(): HDate {\n    return this.date;\n  }\n  /**\n   * Gregorian date of this event\n   */\n  greg(): Date {\n    return this.date.greg();\n  }\n  /**\n   * Untranslated title of this event. Note that these description\n   * strings are always in English and will remain stable across releases.\n   * To get the title of the event in another language, use the\n   * `render()` method.\n   */\n  getDesc(): string {\n    return this.desc;\n  }\n  /**\n   * Bitmask of optional event flags. See {@link flags}\n   */\n  getFlags(): number {\n    return this.mask;\n  }\n  /**\n   * Returns (translated) description of this event\n   * @example\n   * const ev = new Event(new HDate(6, 'Sivan', 5749), 'Shavuot', flags.CHAG);\n   * ev.render('en'); // 'Shavuot'\n   * ev.render('he'); // 'שָׁבוּעוֹת'\n   * ev.render('ashkenazi'); // 'Shavuos'\n   * @param [locale] Optional locale name (defaults to empty locale)\n   */\n  render(locale?: string): string {\n    return Locale.gettext(this.desc, locale);\n  }\n  /**\n   * Returns a brief (translated) description of this event.\n   *\n   * For most events this is the same as {@link render}. Some subclasses\n   * (e.g. {@link CandleLightingEvent}, {@link HavdalahEvent},\n   * {@link OmerEvent}) produce shorter text without an attached time or\n   * extra qualifier — useful for compact UI display.\n   * @example\n   * import {CandleLightingEvent} from '@hebcal/core';\n   * // For a regular Event, renderBrief() == render():\n   * const ev = new Event(new HDate(6, 'Sivan', 5749), 'Shavuot', flags.CHAG);\n   * ev.renderBrief('en'); // 'Shavuot'\n   * @param [locale] Optional locale name (defaults to empty locale)\n   */\n  renderBrief(locale?: string): string {\n    return this.render(locale);\n  }\n  /**\n   * Returns the event's emoji character (e.g. `🕯️`, `🕎`, `🇮🇱`, `🍏🍯`),\n   * or `null` if no emoji is associated with this event.\n   * Subclasses override this to provide holiday-specific emoji.\n   */\n  getEmoji(): string | null {\n    return this.emoji || null;\n  }\n  /**\n   * Returns a simplified (untranslated) description for this event, suitable\n   * for grouping related events under a single name.\n   *\n   * For example, {@link HolidayEvent} strips qualifiers so that\n   * `\"Erev Pesach\"` → `\"Pesach\"` and `\"Sukkot III (CH''M)\"` → `\"Sukkot\"`.\n   * For many events the basename and the event description are identical.\n   * @example\n   * import {HolidayEvent, HDate, months, flags} from '@hebcal/core';\n   * const ev = new HolidayEvent(\n   *   new HDate(14, months.NISAN, 5784), 'Erev Pesach', flags.EREV);\n   * ev.getDesc();    // 'Erev Pesach'\n   * ev.basename();   // 'Pesach'\n   */\n  basename(): string {\n    return this.getDesc();\n  }\n  /**\n   * Returns a URL to hebcal.com or sefaria.org for more detail on the event,\n   * or `undefined` for events with no detail page.\n   *\n   * Subclasses such as {@link HolidayEvent}, {@link ChanukahEvent},\n   * {@link AsaraBTevetEvent}, {@link ParshaEvent}, and {@link OmerEvent}\n   * override this with their own URL patterns.\n   */\n  url(): string | undefined {\n    return undefined;\n  }\n  /**\n   * Is this event observed in Israel?\n   * @example\n   * const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);\n   * ev1.observedInIsrael(); // false\n   * const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);\n   * ev2.observedInIsrael(); // true\n   */\n  observedInIsrael(): boolean {\n    return !(this.mask & flags.CHUL_ONLY);\n  }\n  /**\n   * Is this event observed in the Diaspora?\n   * @example\n   * const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);\n   * ev1.observedInDiaspora(); // true\n   * const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);\n   * ev2.observedInDiaspora(); // true\n   */\n  observedInDiaspora(): boolean {\n    return !(this.mask & flags.IL_ONLY);\n  }\n  /**\n   * Is this event observed in Israel/Diaspora?\n   * @example\n   * const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);\n   * ev1.observedIn(false); // true\n   * ev1.observedIn(true); // false\n   * const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);\n   * ev2.observedIn(false); // true\n   * ev2.observedIn(true); // true\n   * @param il\n   */\n  observedIn(il: boolean): boolean {\n    return il ? this.observedInIsrael() : this.observedInDiaspora();\n  }\n  /**\n   * Returns an array of category strings classifying this event, derived\n   * from its {@link flags} bitmask. The first element is the broad category\n   * (e.g. `'holiday'`, `'roshchodesh'`, `'parashat'`, `'omer'`), followed\n   * by zero or more refinements (e.g. `'major'`, `'minor'`, `'fast'`).\n   *\n   * Returns `['unknown']` if no flag maps to a known category.\n   * @example\n   * import {Event, HDate, flags} from '@hebcal/core';\n   * new Event(new HDate(10, 'Tishrei', 5784), 'Yom Kippur', flags.MAJOR_FAST)\n   *   .getCategories(); // ['holiday', 'major', 'fast']\n   * new Event(new HDate(1, 'Shvat', 5784), 'Rosh Chodesh Sh\\'vat', flags.ROSH_CHODESH)\n   *   .getCategories(); // ['roshchodesh']\n   */\n  getCategories(): string[] {\n    const mask = this.getFlags();\n    for (const attrs of flagToCategory) {\n      const attr0 = attrs[0] as number;\n      if (mask & attr0) {\n        return attrs.slice(1) as string[];\n      }\n    }\n    return ['unknown'];\n  }\n}\n"],"names":[],"mappings":";;;;AAGA;;;AAGG;AACI,MAAM,KAAK,GAAG;;AAEnB,IAAA,IAAI,EAAE,QAAQ;;AAEd,IAAA,aAAa,EAAE,QAAQ;;AAEvB,IAAA,YAAY,EAAE,QAAQ;;AAEtB,IAAA,SAAS,EAAE,QAAQ;;AAEnB,IAAA,OAAO,EAAE,QAAQ;;AAEjB,IAAA,mBAAmB,EAAE,QAAQ;;AAE7B,IAAA,gBAAgB,EAAE,QAAQ;;AAE1B,IAAA,YAAY,EAAE,QAAQ;;AAEtB,IAAA,UAAU,EAAE,QAAQ;;AAEpB,IAAA,eAAe,EAAE,QAAQ;;AAEzB,IAAA,eAAe,EAAE,QAAQ;;AAEzB,IAAA,QAAQ,EAAE,QAAQ;;AAElB,IAAA,UAAU,EAAE,QAAQ;;AAEpB,IAAA,cAAc,EAAE,QAAQ;;AAExB,IAAA,UAAU,EAAE,QAAQ;;AAEpB,IAAA,iBAAiB,EAAE,QAAQ;;AAE3B,IAAA,KAAK,EAAE,QAAQ;;AAEf,IAAA,UAAU,EAAE,QAAQ;;AAEpB,IAAA,WAAW,EAAE,QAAQ;;AAErB,IAAA,aAAa,EAAE,QAAQ;;AAEvB,IAAA,IAAI,EAAE,QAAQ;;AAEd,IAAA,WAAW,EAAE,QAAQ;;AAErB,IAAA,WAAW,EAAE,QAAQ;;AAErB,IAAA,gBAAgB,EAAE,QAAQ;;AAE1B,IAAA,eAAe,EAAE,SAAS;;AAE1B,IAAA,SAAS,EAAE,SAAS;;AAEpB,IAAA,cAAc,EAAE,SAAS;;AAEzB,IAAA,MAAM,EAAE,SAAS;;AAEjB,IAAA,KAAK,EAAE,UAAU;;AAGnB,MAAM,cAAc,GAAG;IACrB,CAAC,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC;AAC9C,IAAA,CAAC,KAAK,CAAC,gBAAgB,EAAE,SAAS,EAAE,OAAO,CAAC;AAC5C,IAAA,CAAC,KAAK,CAAC,WAAW,EAAE,SAAS,CAAC;AAC9B,IAAA,CAAC,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC;AACrC,IAAA,CAAC,KAAK,CAAC,aAAa,EAAE,SAAS,EAAE,OAAO,CAAC;AACzC,IAAA,CAAC,KAAK,CAAC,cAAc,EAAE,SAAS,EAAE,QAAQ,CAAC;AAC3C,IAAA,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC;AACtB,IAAA,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC;AAC1B,IAAA,CAAC,KAAK,CAAC,eAAe,EAAE,UAAU,CAAC;AACnC,IAAA,CAAC,KAAK,CAAC,YAAY,EAAE,aAAa,CAAC;AACnC,IAAA,CAAC,KAAK,CAAC,iBAAiB,EAAE,WAAW,CAAC;AACtC,IAAA,CAAC,KAAK,CAAC,eAAe,EAAE,SAAS,EAAE,SAAS,CAAC;AAC7C,IAAA,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC;AAC1B,IAAA,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC;CAChB;AAEV;;;;;;;;;;;;;;;;;;AAkBG;MACU,KAAK,CAAA;;AAEP,IAAA,IAAI;AACb;;;;;AAKG;AACM,IAAA,IAAI;;AAEJ,IAAA,IAAI;;AAEb,IAAA,KAAK;;AAEL,IAAA,IAAI;;AAEJ,IAAA,KAAK;AACL;;;;;;AAMG;IACH,WAAA,CAAY,IAAW,EAAE,IAAY,EAAE,IAAI,GAAG,CAAC,EAAE,KAAc,EAAA;QAC7D,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;AACxB,YAAA,MAAM,IAAI,SAAS,CAAC,uBAAuB,IAAI,CAAA,CAAE,CAAC;QACpD;AACA,QAAA,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;AAC5B,YAAA,MAAM,IAAI,SAAS,CAAC,8BAA8B,IAAI,CAAA,CAAE,CAAC;QAC3D;AACA,QAAA,IAAI,CAAC,IAAI,GAAG,IAAI;AAChB,QAAA,IAAI,CAAC,IAAI,GAAG,IAAI;AAChB,QAAA,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI;QACjB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;AAC/C,YAAA,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC;QAC5B;IACF;AACA;;AAEG;IACH,OAAO,GAAA;QACL,OAAO,IAAI,CAAC,IAAI;IAClB;AACA;;AAEG;IACH,IAAI,GAAA;AACF,QAAA,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;IACzB;AACA;;;;;AAKG;IACH,OAAO,GAAA;QACL,OAAO,IAAI,CAAC,IAAI;IAClB;AACA;;AAEG;IACH,QAAQ,GAAA;QACN,OAAO,IAAI,CAAC,IAAI;IAClB;AACA;;;;;;;;AAQG;AACH,IAAA,MAAM,CAAC,MAAe,EAAA;QACpB,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC;IAC1C;AACA;;;;;;;;;;;;;AAaG;AACH,IAAA,WAAW,CAAC,MAAe,EAAA;AACzB,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC5B;AACA;;;;AAIG;IACH,QAAQ,GAAA;AACN,QAAA,OAAO,IAAI,CAAC,KAAK,IAAI,IAAI;IAC3B;AACA;;;;;;;;;;;;;AAaG;IACH,QAAQ,GAAA;AACN,QAAA,OAAO,IAAI,CAAC,OAAO,EAAE;IACvB;AACA;;;;;;;AAOG;IACH,GAAG,GAAA;AACD,QAAA,OAAO,SAAS;IAClB;AACA;;;;;;;AAOG;IACH,gBAAgB,GAAA;QACd,OAAO,EAAE,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC;IACvC;AACA;;;;;;;AAOG;IACH,kBAAkB,GAAA;QAChB,OAAO,EAAE,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC;IACrC;AACA;;;;;;;;;;AAUG;AACH,IAAA,UAAU,CAAC,EAAW,EAAA;AACpB,QAAA,OAAO,EAAE,GAAG,IAAI,CAAC,gBAAgB,EAAE,GAAG,IAAI,CAAC,kBAAkB,EAAE;IACjE;AACA;;;;;;;;;;;;;AAaG;IACH,aAAa,GAAA;AACX,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE;AAC5B,QAAA,KAAK,MAAM,KAAK,IAAI,cAAc,EAAE;AAClC,YAAA,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAW;AAChC,YAAA,IAAI,IAAI,GAAG,KAAK,EAAE;AAChB,gBAAA,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAa;YACnC;QACF;QACA,OAAO,CAAC,SAAS,CAAC;IACpB;AACD;;;;"}

package/dist/esm/getStartAndEnd.js

@@ -1,4 +1,4 @@
-/*! @hebcal/core v6.8.2, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
+/*! @hebcal/core v6.9.0, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
 import { months, isDate, greg2abs, HDate, daysInGregMonth } from '@hebcal/hdate';
 
 const TISHREI = months.TISHREI;

package/dist/esm/hallel.js

@@ -1,4 +1,4 @@
-/*! @hebcal/core v6.8.2, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
+/*! @hebcal/core v6.9.0, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
 import { months } from '@hebcal/hdate';
 import { flags } from './event.js';
 import { holidayDesc } from './staticHolidays.js';

package/dist/esm/he-x-NoNikud.po.js

@@ -1,4 +1,4 @@
-/*! @hebcal/core v6.8.2, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
+/*! @hebcal/core v6.9.0, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
 var noNikudOverride = { "headers": { "plural-forms": "nplurals=2; plural=(n != 1);", "language": "he-x-NoNikud" }, "contexts": { "": { "Korach": ["קורח"], "Chukat": ["חוקת"], "Erev Yom Kippur": ["ערב יום כיפור"], "Yom Kippur": ["יום כיפור"], "Yom Kippur Katan": ["יום כיפור קטן"], "Pesach Shabbat Chol ha-Moed": ["שבת חול המועד פסח"], "Sukkot Shabbat Chol ha-Moed": ["שבת חול המועד סוכות"], "Erev Sukkot": ["ערב סוכות"], "Sukkot": ["סוכות"], "Sukkot I": ["סוכות א׳"], "Sukkot II": ["סוכות ב׳"], "Sukkot II (CH''M)": ["סוכות ב׳ (חוה״מ)"], "Sukkot III (CH''M)": ["סוכות ג׳ (חוה״מ)"], "Sukkot IV (CH''M)": ["סוכות ד׳ (חוה״מ)"], "Sukkot V (CH''M)": ["סוכות ה׳ (חוה״מ)"], "Sukkot VI (CH''M)": ["סוכות ו׳ (חוה״מ)"], "Sukkot VII (Hoshana Raba)": ["סוכות ז׳ (הושענא רבה)"] } } };
 
 export { noNikudOverride as default };

package/dist/esm/he.po.js

@@ -1,4 +1,4 @@
-/*! @hebcal/core v6.8.2, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
+/*! @hebcal/core v6.9.0, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
 var poHe = { "headers": { "plural-forms": "nplurals=2; plural=(n > 1);", "language": "he_IL" }, "contexts": { "": { "Shabbat": ["שַׁבָּת"], "Parashat": ["פָּרָשַׁת"], "Achrei Mot": ["אַחֲרֵי מוֹת"], "Balak": ["בָּלָק"], "Bamidbar": ["בְּמִדְבַּר"], "Bechukotai": ["בְּחֻקֹּתַי"], "Beha'alotcha": ["בְּהַעֲלֹתְךָ"], "Behar": ["בְּהַר"], "Bereshit": ["בְּרֵאשִׁית"], "Beshalach": ["בְּשַׁלַּח"], "Bo": ["בֹּא"], "Chayei Sara": ["חַיֵּי שָֹרָה"], "Chukat": ["חֻקַּת"], "Devarim": ["דְּבָרִים"], "Eikev": ["עֵקֶב"], "Emor": ["אֱמוֹר"], "Ha'azinu": ["הַאֲזִינוּ"], "Kedoshim": ["קְדֹשִׁים"], "Ki Tavo": ["כִּי־תָבוֹא"], "Ki Teitzei": ["כִּי־תֵצֵא"], "Ki Tisa": ["כִּי תִשָּׂא"], "Korach": ["קֹרַח"], "Lech-Lecha": ["לֶךְ־לְךָ"], "Masei": ["מַסְעֵי"], "Matot": ["מַטּוֹת"], "Metzora": ["מְצֹרָע"], "Miketz": ["מִקֵּץ"], "Mishpatim": ["מִשְׁפָּטִים"], "Nasso": ["נָשׂא"], "Nitzavim": ["נִצָּבִים"], "Noach": ["נֹחַ"], "Pekudei": ["פְקוּדֵי"], "Pinchas": ["פִּינְחָס"], "Re'eh": ["רְאֵה"], "Sh'lach": ["שְׁלַח־לְךָ"], "Shemot": ["שְׁמוֹת"], "Shmini": ["שְּׁמִינִי"], "Shoftim": ["שׁוֹפְטִים"], "Tazria": ["תַזְרִיעַ"], "Terumah": ["תְּרוּמָה"], "Tetzaveh": ["תְּצַוֶּה"], "Toldot": ["תּוֹלְדוֹת"], "Tzav": ["צַו"], "Vaera": ["וָאֵרָא"], "Vaetchanan": ["וָאֶתְחַנַּן"], "Vayakhel": ["וַיַּקְהֵל"], "Vayechi": ["וַיְחִי"], "Vayeilech": ["וַיֵּלֶךְ"], "Vayera": ["וַיֵּרָא"], "Vayeshev": ["וַיֵּשֶׁב"], "Vayetzei": ["וַיֵּצֵא"], "Vayigash": ["וַיִּגַּשׁ"], "Vayikra": ["וַיִּקְרָא"], "Vayishlach": ["וַיִּשְׁלַח"], "Vezot Haberakhah": ["וְזֹאת הַבְּרָכָה"], "Yitro": ["יִתְרוֹ"], "Asara B'Tevet": ["עֲשָׂרָה בְּטֵבֵת"], "Candle lighting": ["הַדְלָקַת נֵרוֹת"], "Chanukah": ["חֲנוּכָּה"], "Chanukah: 1 Candle": ["חֲנוּכָּה: א׳ נֵר"], "Chanukah: 2 Candles": ["חֲנוּכָּה: ב׳ נֵרוֹת"], "Chanukah: 3 Candles": ["חֲנוּכָּה: ג׳ נֵרוֹת"], "Chanukah: 4 Candles": ["חֲנוּכָּה: ד׳ נֵרוֹת"], "Chanukah: 5 Candles": ["חֲנוּכָּה: ה׳ נֵרוֹת"], "Chanukah: 6 Candles": ["חֲנוּכָּה: ו׳ נֵרוֹת"], "Chanukah: 7 Candles": ["חֲנוּכָּה: ז׳ נֵרוֹת"], "Chanukah: 8 Candles": ["חֲנוּכָּה: ח׳ נֵרוֹת"], "Chanukah: 8th Day": ["חֲנוּכָּה: יוֹם ח׳"], "Days of the Omer": ["סְפִירַת הָעוֹמֶר"], "Omer": ["עוֹמֶר"], "day of the Omer": ["בָּעוֹמֶר"], "Erev Pesach": ["עֶרֶב פֶּסַח"], "Erev Purim": ["עֶרֶב פּוּרִים"], "Erev Rosh Hashana": ["עֶרֶב רֹאשׁ הַשָּׁנָה"], "Erev Shavuot": ["עֶרֶב שָׁבוּעוֹת"], "Erev Simchat Torah": ["עֶרֶב שִׂמְחַת תּוֹרָה"], "Erev Sukkot": ["עֶרֶב סֻכּוֹת"], "Erev Tish'a B'Av": ["עֶרֶב תִּשְׁעָה בְּאָב"], "Erev Yom Kippur": ["עֶרֶב יוֹם כִּפּוּר"], "Havdalah": ["הַבְדָּלָה"], "Lag BaOmer": ["ל״ג בָּעוֹמֶר"], "Leil Selichot": ["סְלִיחוֹת"], "Pesach": ["פֶּסַח"], "Pesach I": ["פֶּסַח א׳"], "Pesach II": ["פֶּסַח ב׳"], "Pesach II (CH''M)": ["פֶּסַח ב׳ (חוה״מ)"], "Pesach III (CH''M)": ["פֶּסַח ג׳ (חוה״מ)"], "Pesach IV (CH''M)": ["פֶּסַח ד׳ (חוה״מ)"], "Pesach Sheni": ["פֶּסַח שֵׁנִי"], "Pesach V (CH''M)": ["פֶּסַח ה׳ (חוה״מ)"], "Pesach VI (CH''M)": ["פֶּסַח ו׳ (חוה״מ)"], "Pesach VII": ["פֶּסַח ז׳"], "Pesach VIII": ["פֶּסַח ח׳"], "Pesach Shabbat Chol ha-Moed": ["שַׁבַּת חֹל הַמּוֹעֵד פֶּסַח"], "Purim": ["פּוּרִים"], "Purim Katan": ["פּוּרִים קָטָן"], "Rosh Chodesh": ["רֹאשׁ חוֹדֶשׁ"], "Rosh Hashana": ["רֹאשׁ הַשָּׁנָה"], "Rosh Hashana I": ["רֹאשׁ הַשָּׁנָה א׳"], "Rosh Hashana II": ["רֹאשׁ הַשָּׁנָה ב׳"], "Shabbat Chazon": ["שַׁבַּת חֲזוֹן"], "Shabbat HaChodesh": ["שַׁבַּת הַחֹדֶשׁ"], "Shabbat HaGadol": ["שַׁבַּת הַגָּדוֹל"], "Shabbat Nachamu": ["שַׁבַּת נַחֲמוּ"], "Shabbat Parah": ["שַׁבַּת פָּרָה"], "Shabbat Shekalim": ["שַׁבַּת שְׁקָלִים"], "Shabbat Shuva": ["שַׁבַּת שׁוּבָה"], "Shabbat Zachor": ["שַׁבַּת זָכוֹר"], "Shavuot": ["שָׁבוּעוֹת"], "Shavuot I": ["שָׁבוּעוֹת א׳"], "Shavuot II": ["שָׁבוּעוֹת ב׳"], "Shmini Atzeret": ["שְׁמִינִי עֲצֶרֶת"], "Shushan Purim": ["שׁוּשָׁן פּוּרִים"], "Sigd": ["חַג הַסִּיגְד"], "Simchat Torah": ["שִׂמְחַת תּוֹרָה"], "Sukkot": ["סֻכּוֹת"], "Sukkot I": ["סֻכּוֹת א׳"], "Sukkot II": ["סֻכּוֹת ב׳"], "Sukkot II (CH''M)": ["סֻכּוֹת ב׳ (חוה״מ)"], "Sukkot III (CH''M)": ["סֻכּוֹת ג׳ (חוה״מ)"], "Sukkot IV (CH''M)": ["סֻכּוֹת ד׳ (חוה״מ)"], "Sukkot V (CH''M)": ["סֻכּוֹת ה׳ (חוה״מ)"], "Sukkot VI (CH''M)": ["סֻכּוֹת ו׳ (חוה״מ)"], "Sukkot VII (Hoshana Raba)": ["סֻכּוֹת ז׳ (הוֹשַׁעְנָא רַבָּה)"], "Sukkot Shabbat Chol ha-Moed": ["שַׁבַּת חֹל הַמּוֹעֵד סֻכּוֹת"], "Ta'anit Bechorot": ["תַּעֲנִית בְּכוֹרוֹת"], "Ta'anit BeHaB": ["תַּעֲנִית בה״ב"], "Ta'anit Esther": ["תַּעֲנִית אֶסְתֵּר"], "Tish'a B'Av": ["תִּשְׁעָה בְּאָב"], "Tu B'Av": ["ט״וּ בְּאָב"], "Tu BiShvat": ["ט״וּ בִּשְׁבָט"], "Tu B'Shvat": ["ט״וּ בִּשְׁבָט"], "Tzom Gedaliah": ["צוֹם גְּדַלְיָה"], "Tzom Tammuz": ["צוֹם י״ז בְּתַמּוּז"], "Yom HaAtzma'ut": ["יוֹם הָעַצְמָאוּת"], "Yom HaShoah": ["יוֹם הַשּׁוֹאָה"], "Yom HaZikaron": ["יוֹם הַזִּכָּרוֹן"], "Yom Kippur": ["יוֹם כִּפּוּר"], "Yom Yerushalayim": ["יוֹם יְרוּשָׁלַיִם"], "Yom HaAliyah": ["יוֹם הַעֲלִיָּה"], "Yom HaAliyah School Observance": ["שְׁמִירָת בֵּית הַסֵפֶר לְיוֹם הַעֲלִיָּה"], "Rosh Chodesh Adar": ["רֹאשׁ חוֹדֶשׁ אֲדָר"], "Rosh Chodesh Adar I": ["רֹאשׁ חוֹדֶשׁ אֲדָר א׳"], "Rosh Chodesh Adar II": ["רֹאשׁ חוֹדֶשׁ אֲדָר ב׳"], "Rosh Chodesh Av": ["רֹאשׁ חוֹדֶשׁ אָב"], "Rosh Chodesh Cheshvan": ["רֹאשׁ חוֹדֶשׁ חֶשְׁוָן"], "Rosh Chodesh Elul": ["רֹאשׁ חוֹדֶשׁ אֱלוּל"], "Rosh Chodesh Iyyar": ["רֹאשׁ חוֹדֶשׁ אִיָּיר"], "Rosh Chodesh Kislev": ["רֹאשׁ חוֹדֶשׁ כִּסְלֵו"], "Rosh Chodesh Nisan": ["רֹאשׁ חוֹדֶשׁ נִיסָן"], "Rosh Chodesh Sh'vat": ["רֹאשׁ חוֹדֶשׁ שְׁבָט"], "Rosh Chodesh Sivan": ["רֹאשׁ חוֹדֶשׁ סִיוָן"], "Rosh Chodesh Tamuz": ["רֹאשׁ חוֹדֶשׁ תַּמּוּז"], "Rosh Chodesh Tammuz": ["רֹאשׁ חוֹדֶשׁ תַּמּוּז"], "Rosh Chodesh Tevet": ["רֹאשׁ חוֹדֶשׁ טֵבֵת"], "min": ["דַּקּוֹת"], "Fast begins": ["תְּחִילַּת הַצוֹם"], "Fast ends": ["סִיּוּם הַצוֹם"], "Rosh Hashana LaBehemot": ["רֹאשׁ הַשָּׁנָה לְמַעְשַׂר בְּהֵמָה"], "Tish'a B'Av (observed)": ["(תִּשְׁעָה בְּאָב (נִדְחָה"], "Shabbat Mevarchim Chodesh": ["שַׁבַּת מְבָרְכִים חוֹדֶשׁ"], "Shabbat Shirah": ["שַׁבַּת שִׁירָה"], "Lovingkindness": ["חֶסֶד"], "Might": ["גְּבוּרָה"], "Beauty": ["תִּפְאֶרֶת"], "Eternity": ["נֶּצַח"], "Splendor": ["הוֹד"], "Foundation": ["יְּסוֹד"], "Majesty": ["מַּלְכוּת"], "day": ["יוֹם"], "Yom Kippur Katan": ["יוֹם כִּפּוּר קָטָן"], "Yizkor": ["יִזְכּוֹר"], "Family Day": ["יוֹם הַמִּשׁפָּחָה"], "Yitzhak Rabin Memorial Day": ["יוֹם הַזִּכָּרוֹן לְיִצְחָק רַבִּין"], "Jabotinsky Day": ["יוֹם זַ׳בּוֹטִינְסְקִי"], "Herzl Day": ["יוֹם הֶרְצְל"], "Ben-Gurion Day": ["יוֹם בֶּן־גּוּרִיּוֹן"], "Hebrew Language Day": ["יוֹם הַשָׂפָה הַעִברִית"], "Birkat Hachamah": ["בִּרְכַּת הַחַמָּה"], "Birkat HaChamah": ["בִּרְכַּת הַחַמָּה"], "Shushan Purim Katan": ["שׁוּשָׁן פּוּרִים קָטָן"], "Purim Meshulash": ["פּוּרִים מְשׁוּלָּשׁ"], "Chag HaBanot": ["חַג הַבָּנוֹת"], "Molad": ["מוֹלָד הָלְּבָנָה"], "chalakim": ["חֲלָקִים"], "Alot HaShachar": ["עֲלוֹת הַשַּׁחַר"], "Misheyakir": ["מִשֶּׁיַּכִּיר"], "Misheyakir Machmir": ["מִשֶּׁיַּכִּיר מַחְמִיר"], "Sunrise": ["נֵץ הַחַמָּה"], "Kriat Shema, sof zeman": ["סוֹף זְמַן קְרִיאַת שְׁמַע"], "Tefilah, sof zeman": ["סוֹף זְמַן תְּפִלָּה"], "Kriat Shema, sof zeman (MGA)": ["סוֹף זְמַן קְרִיאַת שְׁמַע (מג״א)"], "Kriat Shema, sof zeman (GRA)": ["סוֹף זְמַן קְרִיאַת שְׁמַע (גְּרָ״א)"], "Tefilah, sof zeman (MGA)": ["סוֹף זְמַן תְּפִלָּה (מג״א)"], "Tefilah, sof zeman (GRA)": ["סוֹף זְמַן תְּפִלָּה (גְּרָ״א)"], "Chatzot HaLailah": ["חֲצוֹת הַלַּיְלָה"], "Chatzot HaYom": ["חֲצוֹת הַיּוֹם"], "Chatzot hayom": ["חֲצוֹת הַיּוֹם"], "Mincha Gedolah": ["מִנְחָה גְּדוֹלָה"], "Mincha Ketanah": ["מִנְחָה קְטַנָּה"], "Plag HaMincha": ["פְּלַג הַמִּנְחָה"], "Sunset": ["שְׁקִיעַת הַחַמָּה"], "Bein HaShemashot": ["בֵּין הַשְּׁמָשׁוֹת"], "Tzeit HaKochavim": ["צֵאת הַכּוֹכָבִים"], "Biur Chametz": ["בִּעוּר חָמֵץ"], "Finish eating chametz": ["סוֹף זְמַן אֲכִילַת חָמֵץ"] } } };
 
 export { poHe as default };

package/dist/esm/hebcal.d.ts

@@ -21,92 +21,12 @@ export declare class HebrewCalendar {
      * a description, flags and optional attributes.
      * If given no options, returns holidays for the Diaspora for the current Gregorian year.
      *
-     * The date range returned by this function can be controlled by:
-     * * `options.year` - Gregorian (e.g. 1993) or Hebrew year (e.g. 5749)
-     * * `options.isHebrewYear` - to interpret `year` as Hebrew year
-     * * `options.numYears` - generate calendar for multiple years (default 1, maximum 2000)
-     * * `options.month` - Gregorian or Hebrew month (to filter results to a single month)
-     *
-     * Alternatively, specify start and end days with `Date` or {@link HDate} instances:
-     * * `options.start` - use specific start date (requires `end` date)
-     * * `options.end` - use specific end date (requires `start` date)
-     *
-     * Unless `options.noHolidays == true`, default holidays include:
-     * * Major holidays - Rosh Hashana, Yom Kippur, Pesach, Sukkot, etc.
-     * * Minor holidays - Purim, Chanukah, Tu BiShvat, Lag BaOmer, etc.
-     * * Minor fasts - Ta'anit Esther, Tzom Gedaliah, etc. (unless `options.noMinorFast`)
-     * * Special Shabbatot - Shabbat Shekalim, Zachor, etc. (unless `options.noSpecialShabbat`)
-     * * Modern Holidays - Yom HaShoah, Yom HaAtzma'ut, etc. (unless `options.noModern`)
-     * * Rosh Chodesh (unless `options.noRoshChodesh`)
-     *
-     * Holiday and Torah reading schedules differ between Israel and the Disapora.
-     * Set `options.il=true` to use the Israeli schedule.
-     *
-     * Additional non-default event types can be specified:
-     * * Parashat HaShavua - weekly Torah Reading on Saturdays (`options.sedrot`)
-     * * Counting of the Omer (`options.omer`)
-     * * Shabbat Mevarchim HaChodesh on Saturday before Rosh Chodesh (`options.shabbatMevarchim`)
-     * * Molad announcement on Saturday before Rosh Chodesh (`options.molad`)
-     * * Yom Kippur Katan (`options.yomKippurKatan`)
-     * * Yizkor (`options.yizkor`)
-     *
-     * Daily Study of texts are supported by the
-     * {@link https://github.com/hebcal/hebcal-learning @hebcal/learning} package,
-     * for example:
-     * * Babylonian Talmud Daf Yomi (`options.dailyLearning.dafYomi`)
-     * * Jerusalem Talmud (Yerushalmi) Yomi (`options.dailyLearning.yerushalmi`)
-     * * Mishna Yomi (`options.dailyLearning.mishnaYomi`)
-     * * Nach Yomi (`options.dailyLearning.nachYomi`)
-     *
-     * Candle-lighting and Havdalah times are approximated using latitude and longitude
-     * specified by the {@link Location} class. The `Location` class contains a small
-     * database of cities with their associated geographic information and time-zone information.
-     * If you ever have any doubts about Hebcal's times, consult your local halachic authority.
-     * If you enter geographic coordinates above the arctic circle or antarctic circle,
-     * the times are guaranteed to be wrong.
-     *
-     * To add candle-lighting options, set `options.candlelighting=true` and set
-     * `options.location` to an instance of `Location`. By default, candle lighting
-     * time is 18 minutes before sundown (40 minutes for Jerusalem,
-     * 30 minutes for Haifa and Zikhron Ya'akov) and Havdalah is
-     * calculated according to Tzeit Hakochavim - Nightfall (the point when 3 small stars
-     * are observable in the night time sky with the naked eye). The default Havdalah
-     * option (Tzeit Hakochavim) is calculated when the sun is 8.5° below the horizon.
-     * These defaults can be changed using these options:
-     * * `options.candleLightingMins` - minutes before sundown to light candles
-     * * `options.havdalahMins` - minutes after sundown for Havdalah (typical values are 42, 50, or 72).
-     *    Havdalah times are suppressed when `options.havdalahMins=0`.
-     * * `options.havdalahDeg` - degrees for solar depression for Havdalah.
-     *    Default is 8.5 degrees for 3 small stars. Use 7.083 degrees for 3 medium-sized stars.
-     *    Havdalah times are suppressed when `options.havdalahDeg=0`.
-     *
-     * If both `options.candlelighting=true` and `options.location` is specified,
-     * Chanukah candle-lighting times and minor fast start/end times will also be generated.
-     * Chanukah candle-lighting is at Bein HaShmashos (13.5 minutes before
-     * the sun is 7.083° below the horizon in the evening)
-     * on weekdays, at regular candle-lighting time on Fridays, and at regular Havdalah time on
-     * Saturday night (see above).
-     *
-     * Minor fasts begin at Alot HaShachar (sun is 16.1° below the horizon in the morning) and
-     * end when 3 medium-sized stars are observable in the night sky (sun is 7.083° below the horizon
-     * in the evening).
-     *
-     * Two options also exist for generating an Event with the Hebrew date:
-     * * `options.addHebrewDates` - print the Hebrew date for the entire date range
-     * * `options.addHebrewDatesForEvents` - print the Hebrew date for dates with some events
-     *
-     * Lastly, translation and transliteration of event titles is controlled by
-     * `options.locale` and the {@link Locale} API.
-     * `@hebcal/core` supports three locales by default:
-     * * `en` - default, Sephardic transliterations (e.g. "Shabbat")
-     * * `ashkenazi` - Ashkenazi transliterations (e.g. "Shabbos")
-     * * `he` - Hebrew (e.g. "שַׁבָּת")
-     *
-     * Additional locales (such as `ru` or `fr`) are supported by the
-     * {@link https://github.com/hebcal/hebcal-locales @hebcal/locales} package
+     * This is a convenience wrapper around the standalone {@link calendar} function.
+     * See {@link calendar} for the complete list of supported options, the
+     * candle-lighting and Havdalah defaults, and notes on locales.
      *
      * @example
-     * import {HebrewCalendar, HDate, Location, Event} from '@hebcal/core';
+     * import {HebrewCalendar, Location} from '@hebcal/core';
      * const options: CalOptions = {
      *   year: 1981,
      *   isHebrewYear: false,
@@ -125,8 +45,12 @@ export declare class HebrewCalendar {
     static calendar(options?: CalOptions): Event[];
     /**
      * Calculates a birthday or anniversary (non-yahrzeit).
-     * `hyear` must be after original `gdate` of anniversary.
-     * Returns `undefined` when requested year preceeds or is same as original year.
+     * Returns `undefined` when `hyear` precedes the original year of `gdate`.
+     *
+     * When `hyear` is the original year, the original date is returned unchanged —
+     * a "0th birthday" is a meaningful thing to ask for. This differs from
+     * {@link getYahrzeit}, which returns `undefined` for the original year,
+     * because a yahrzeit only has meaning from the first anniversary onward.
      *
      * Hebcal uses the algorithm defined in "Calendrical Calculations"
      * by Edward M. Reingold and Nachum Dershowitz.
@@ -244,9 +168,12 @@ export declare class HebrewCalendar {
      * (Shabbat) to also be a sacred day.
      * @example
      * import {HebrewCalendar} from '@hebcal/core';
-     * // Thursday April 25, 2024 — first day of Pesach 5784, with Shabbat
-     * // chol ha-moed the next day, so Eruv Tavshilin is required:
-     * HebrewCalendar.eruvTavshilin(new Date(2024, 3, 25), false); // true
+     * // Wednesday October 16, 2024 is Erev Sukkot 5785. In the Diaspora,
+     * // Sukkot I falls on Thursday and Sukkot II on Friday, so Eruv
+     * // Tavshilin is prepared on Wednesday:
+     * HebrewCalendar.eruvTavshilin(new Date(2024, 9, 16), false); // true
+     * // In Israel there is only one day of Yom Tov, so Friday is a weekday:
+     * HebrewCalendar.eruvTavshilin(new Date(2024, 9, 16), true); // false
      * @param date Gregorian or Hebrew date to test
      * @param il use the Israeli holiday schedule
      */
@@ -267,12 +194,12 @@ export declare class HebrewCalendar {
      * HebrewCalendar.reformatTimeStr('20:30', 'pm', {hour12: false}); // '20:30'
      * @param timeStr - original time like "20:30"
      * @param suffix - "p" or "pm" or " P.M.". Add leading space if you want it
-     * @param options
+     * @param options optional; `location`, `locale` and `hour12` are consulted
      */
-    static reformatTimeStr(timeStr: string, suffix: string, options: CalOptions): string;
+    static reformatTimeStr(timeStr: string, suffix: string, options?: CalOptions): string;
     /**
      * Returns the semantic version string of the `@hebcal/core` package
-     * (e.g. `"5.10.0"`). Useful for logging or feature detection.
+     * (e.g. `"6.8.2"`). Useful for logging or feature detection.
      */
     static version(): string;
     /**
@@ -283,10 +210,10 @@ export declare class HebrewCalendar {
      * since an internal LRU cache (~120 entries) avoids recomputing the
      * keviyah-specific reading pattern.
      * @example
-     * import {HebrewCalendar} from '@hebcal/core';
+     * import {HebrewCalendar, HDate} from '@hebcal/core';
      * const sedra = HebrewCalendar.getSedra(5784, false);
      * const result = sedra.lookup(new HDate(15, 'Cheshvan', 5784));
-     * console.log(result.parsha); // ['Lech-Lecha']
+     * console.log(result.parsha); // ['Vayera']
      * @param hyear Hebrew year
      * @param il Use Israel sedra schedule (`false` for Diaspora)
      */
@@ -301,12 +228,14 @@ export declare class HebrewCalendar {
      * Yom Ha'atzmaut, and Yom Yerushalayim.
      *
      * Half Hallel is said on Rosh Chodesh (not Rosh Hashanah), and the last 6 days of Pesach.
-     * @returns 0 for no Hallel, 1 for half Hallel, 2 for whole Hallel
      * @example
      * import {HebrewCalendar, HDate, months} from '@hebcal/core';
      * HebrewCalendar.hallel(new HDate(25, months.KISLEV, 5784), false); // 2 (Chanukah)
      * HebrewCalendar.hallel(new HDate(1, months.SHVAT, 5784), false);   // 1 (Rosh Chodesh)
      * HebrewCalendar.hallel(new HDate(2, months.SHVAT, 5784), false);   // 0
+     * @param hdate Hebrew date to test
+     * @param il use the Israeli holiday schedule
+     * @returns 0 for no Hallel, 1 for half Hallel, 2 for whole Hallel
      */
     static hallel(hdate: HDate, il: boolean): number;
     /**
@@ -327,12 +256,18 @@ export declare class HebrewCalendar {
      * @example
      * import {HebrewCalendar, HDate, months} from '@hebcal/core';
      * // Regular weekday — Tachanun is said at both services
-     * HebrewCalendar.tachanun(new HDate(2, months.SHVAT, 5784), false);
+     * HebrewCalendar.tachanun(new HDate(4, months.SHVAT, 5784), false);
      * // => { shacharit: true, mincha: true, allCongs: true }
      *
+     * // Friday 2 Sh'vat — said at Shacharit, but not at Mincha (erev Shabbat)
+     * HebrewCalendar.tachanun(new HDate(2, months.SHVAT, 5784), false);
+     * // => { shacharit: true, mincha: false, allCongs: true }
+     *
      * // Rosh Chodesh — no Tachanun
      * HebrewCalendar.tachanun(new HDate(1, months.SHVAT, 5784), false);
      * // => { shacharit: false, mincha: false, allCongs: false }
+     * @param hdate Hebrew date to test
+     * @param il use the Israeli holiday schedule
      */
     static tachanun(hdate: HDate, il: boolean): TachanunResult;
 }

package/dist/esm/hebcal.js

@@ -1,5 +1,5 @@
-/*! @hebcal/core v6.8.2, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
-import { getBirthdayHD, HDate, getYahrzeitHD } from '@hebcal/hdate';
+/*! @hebcal/core v6.9.0, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
+import { birthdayOrAnniversary, yahrzeit, HDate } from '@hebcal/hdate';
 import './locale.js';
 import { version } from './pkgVersion.js';
 import { flags } from './event.js';
@@ -45,92 +45,12 @@ class HebrewCalendar {
      * a description, flags and optional attributes.
      * If given no options, returns holidays for the Diaspora for the current Gregorian year.
      *
-     * The date range returned by this function can be controlled by:
-     * * `options.year` - Gregorian (e.g. 1993) or Hebrew year (e.g. 5749)
-     * * `options.isHebrewYear` - to interpret `year` as Hebrew year
-     * * `options.numYears` - generate calendar for multiple years (default 1, maximum 2000)
-     * * `options.month` - Gregorian or Hebrew month (to filter results to a single month)
-     *
-     * Alternatively, specify start and end days with `Date` or {@link HDate} instances:
-     * * `options.start` - use specific start date (requires `end` date)
-     * * `options.end` - use specific end date (requires `start` date)
-     *
-     * Unless `options.noHolidays == true`, default holidays include:
-     * * Major holidays - Rosh Hashana, Yom Kippur, Pesach, Sukkot, etc.
-     * * Minor holidays - Purim, Chanukah, Tu BiShvat, Lag BaOmer, etc.
-     * * Minor fasts - Ta'anit Esther, Tzom Gedaliah, etc. (unless `options.noMinorFast`)
-     * * Special Shabbatot - Shabbat Shekalim, Zachor, etc. (unless `options.noSpecialShabbat`)
-     * * Modern Holidays - Yom HaShoah, Yom HaAtzma'ut, etc. (unless `options.noModern`)
-     * * Rosh Chodesh (unless `options.noRoshChodesh`)
-     *
-     * Holiday and Torah reading schedules differ between Israel and the Disapora.
-     * Set `options.il=true` to use the Israeli schedule.
-     *
-     * Additional non-default event types can be specified:
-     * * Parashat HaShavua - weekly Torah Reading on Saturdays (`options.sedrot`)
-     * * Counting of the Omer (`options.omer`)
-     * * Shabbat Mevarchim HaChodesh on Saturday before Rosh Chodesh (`options.shabbatMevarchim`)
-     * * Molad announcement on Saturday before Rosh Chodesh (`options.molad`)
-     * * Yom Kippur Katan (`options.yomKippurKatan`)
-     * * Yizkor (`options.yizkor`)
-     *
-     * Daily Study of texts are supported by the
-     * {@link https://github.com/hebcal/hebcal-learning @hebcal/learning} package,
-     * for example:
-     * * Babylonian Talmud Daf Yomi (`options.dailyLearning.dafYomi`)
-     * * Jerusalem Talmud (Yerushalmi) Yomi (`options.dailyLearning.yerushalmi`)
-     * * Mishna Yomi (`options.dailyLearning.mishnaYomi`)
-     * * Nach Yomi (`options.dailyLearning.nachYomi`)
-     *
-     * Candle-lighting and Havdalah times are approximated using latitude and longitude
-     * specified by the {@link Location} class. The `Location` class contains a small
-     * database of cities with their associated geographic information and time-zone information.
-     * If you ever have any doubts about Hebcal's times, consult your local halachic authority.
-     * If you enter geographic coordinates above the arctic circle or antarctic circle,
-     * the times are guaranteed to be wrong.
-     *
-     * To add candle-lighting options, set `options.candlelighting=true` and set
-     * `options.location` to an instance of `Location`. By default, candle lighting
-     * time is 18 minutes before sundown (40 minutes for Jerusalem,
-     * 30 minutes for Haifa and Zikhron Ya'akov) and Havdalah is
-     * calculated according to Tzeit Hakochavim - Nightfall (the point when 3 small stars
-     * are observable in the night time sky with the naked eye). The default Havdalah
-     * option (Tzeit Hakochavim) is calculated when the sun is 8.5° below the horizon.
-     * These defaults can be changed using these options:
-     * * `options.candleLightingMins` - minutes before sundown to light candles
-     * * `options.havdalahMins` - minutes after sundown for Havdalah (typical values are 42, 50, or 72).
-     *    Havdalah times are suppressed when `options.havdalahMins=0`.
-     * * `options.havdalahDeg` - degrees for solar depression for Havdalah.
-     *    Default is 8.5 degrees for 3 small stars. Use 7.083 degrees for 3 medium-sized stars.
-     *    Havdalah times are suppressed when `options.havdalahDeg=0`.
-     *
-     * If both `options.candlelighting=true` and `options.location` is specified,
-     * Chanukah candle-lighting times and minor fast start/end times will also be generated.
-     * Chanukah candle-lighting is at Bein HaShmashos (13.5 minutes before
-     * the sun is 7.083° below the horizon in the evening)
-     * on weekdays, at regular candle-lighting time on Fridays, and at regular Havdalah time on
-     * Saturday night (see above).
-     *
-     * Minor fasts begin at Alot HaShachar (sun is 16.1° below the horizon in the morning) and
-     * end when 3 medium-sized stars are observable in the night sky (sun is 7.083° below the horizon
-     * in the evening).
-     *
-     * Two options also exist for generating an Event with the Hebrew date:
-     * * `options.addHebrewDates` - print the Hebrew date for the entire date range
-     * * `options.addHebrewDatesForEvents` - print the Hebrew date for dates with some events
-     *
-     * Lastly, translation and transliteration of event titles is controlled by
-     * `options.locale` and the {@link Locale} API.
-     * `@hebcal/core` supports three locales by default:
-     * * `en` - default, Sephardic transliterations (e.g. "Shabbat")
-     * * `ashkenazi` - Ashkenazi transliterations (e.g. "Shabbos")
-     * * `he` - Hebrew (e.g. "שַׁבָּת")
-     *
-     * Additional locales (such as `ru` or `fr`) are supported by the
-     * {@link https://github.com/hebcal/hebcal-locales @hebcal/locales} package
+     * This is a convenience wrapper around the standalone {@link calendar} function.
+     * See {@link calendar} for the complete list of supported options, the
+     * candle-lighting and Havdalah defaults, and notes on locales.
      *
      * @example
-     * import {HebrewCalendar, HDate, Location, Event} from '@hebcal/core';
+     * import {HebrewCalendar, Location} from '@hebcal/core';
      * const options: CalOptions = {
      *   year: 1981,
      *   isHebrewYear: false,
@@ -151,8 +71,12 @@ class HebrewCalendar {
     }
     /**
      * Calculates a birthday or anniversary (non-yahrzeit).
-     * `hyear` must be after original `gdate` of anniversary.
-     * Returns `undefined` when requested year preceeds or is same as original year.
+     * Returns `undefined` when `hyear` precedes the original year of `gdate`.
+     *
+     * When `hyear` is the original year, the original date is returned unchanged —
+     * a "0th birthday" is a meaningful thing to ask for. This differs from
+     * {@link getYahrzeit}, which returns `undefined` for the original year,
+     * because a yahrzeit only has meaning from the first anniversary onward.
      *
      * Hebcal uses the algorithm defined in "Calendrical Calculations"
      * by Edward M. Reingold and Nachum Dershowitz.
@@ -176,11 +100,7 @@ class HebrewCalendar {
      * @returns anniversary occurring in `hyear`
      */
     static getBirthdayOrAnniversary(hyear, gdate) {
-        const dt = getBirthdayHD(hyear, gdate);
-        if (dt === undefined) {
-            return dt;
-        }
-        return new HDate(dt);
+        return birthdayOrAnniversary(hyear, gdate);
     }
     /**
      * Calculates yahrzeit.
@@ -217,11 +137,7 @@ class HebrewCalendar {
      * @returns anniversary occurring in hyear
      */
     static getYahrzeit(hyear, gdate) {
-        const dt = getYahrzeitHD(hyear, gdate);
-        if (dt === undefined) {
-            return dt;
-        }
-        return new HDate(dt);
+        return yahrzeit(hyear, gdate);
     }
     /**
      * Lower-level holidays interface, which returns a `Map` of `Event`s indexed by
@@ -288,9 +204,12 @@ class HebrewCalendar {
      * (Shabbat) to also be a sacred day.
      * @example
      * import {HebrewCalendar} from '@hebcal/core';
-     * // Thursday April 25, 2024 — first day of Pesach 5784, with Shabbat
-     * // chol ha-moed the next day, so Eruv Tavshilin is required:
-     * HebrewCalendar.eruvTavshilin(new Date(2024, 3, 25), false); // true
+     * // Wednesday October 16, 2024 is Erev Sukkot 5785. In the Diaspora,
+     * // Sukkot I falls on Thursday and Sukkot II on Friday, so Eruv
+     * // Tavshilin is prepared on Wednesday:
+     * HebrewCalendar.eruvTavshilin(new Date(2024, 9, 16), false); // true
+     * // In Israel there is only one day of Yom Tov, so Friday is a weekday:
+     * HebrewCalendar.eruvTavshilin(new Date(2024, 9, 16), true); // false
      * @param date Gregorian or Hebrew date to test
      * @param il use the Israeli holiday schedule
      */
@@ -322,14 +241,14 @@ class HebrewCalendar {
      * HebrewCalendar.reformatTimeStr('20:30', 'pm', {hour12: false}); // '20:30'
      * @param timeStr - original time like "20:30"
      * @param suffix - "p" or "pm" or " P.M.". Add leading space if you want it
-     * @param options
+     * @param options optional; `location`, `locale` and `hour12` are consulted
      */
     static reformatTimeStr(timeStr, suffix, options) {
         return reformatTimeStr(timeStr, suffix, options);
     }
     /**
      * Returns the semantic version string of the `@hebcal/core` package
-     * (e.g. `"5.10.0"`). Useful for logging or feature detection.
+     * (e.g. `"6.8.2"`). Useful for logging or feature detection.
      */
     static version() {
         return version;
@@ -342,10 +261,10 @@ class HebrewCalendar {
      * since an internal LRU cache (~120 entries) avoids recomputing the
      * keviyah-specific reading pattern.
      * @example
-     * import {HebrewCalendar} from '@hebcal/core';
+     * import {HebrewCalendar, HDate} from '@hebcal/core';
      * const sedra = HebrewCalendar.getSedra(5784, false);
      * const result = sedra.lookup(new HDate(15, 'Cheshvan', 5784));
-     * console.log(result.parsha); // ['Lech-Lecha']
+     * console.log(result.parsha); // ['Vayera']
      * @param hyear Hebrew year
      * @param il Use Israel sedra schedule (`false` for Diaspora)
      */
@@ -362,12 +281,14 @@ class HebrewCalendar {
      * Yom Ha'atzmaut, and Yom Yerushalayim.
      *
      * Half Hallel is said on Rosh Chodesh (not Rosh Hashanah), and the last 6 days of Pesach.
-     * @returns 0 for no Hallel, 1 for half Hallel, 2 for whole Hallel
      * @example
      * import {HebrewCalendar, HDate, months} from '@hebcal/core';
      * HebrewCalendar.hallel(new HDate(25, months.KISLEV, 5784), false); // 2 (Chanukah)
      * HebrewCalendar.hallel(new HDate(1, months.SHVAT, 5784), false);   // 1 (Rosh Chodesh)
      * HebrewCalendar.hallel(new HDate(2, months.SHVAT, 5784), false);   // 0
+     * @param hdate Hebrew date to test
+     * @param il use the Israeli holiday schedule
+     * @returns 0 for no Hallel, 1 for half Hallel, 2 for whole Hallel
      */
     static hallel(hdate, il) {
         const events = getHolidaysOnDate(hdate, il);
@@ -394,12 +315,18 @@ class HebrewCalendar {
      * @example
      * import {HebrewCalendar, HDate, months} from '@hebcal/core';
      * // Regular weekday — Tachanun is said at both services
-     * HebrewCalendar.tachanun(new HDate(2, months.SHVAT, 5784), false);
+     * HebrewCalendar.tachanun(new HDate(4, months.SHVAT, 5784), false);
      * // => { shacharit: true, mincha: true, allCongs: true }
      *
+     * // Friday 2 Sh'vat — said at Shacharit, but not at Mincha (erev Shabbat)
+     * HebrewCalendar.tachanun(new HDate(2, months.SHVAT, 5784), false);
+     * // => { shacharit: true, mincha: false, allCongs: true }
+     *
      * // Rosh Chodesh — no Tachanun
      * HebrewCalendar.tachanun(new HDate(1, months.SHVAT, 5784), false);
      * // => { shacharit: false, mincha: false, allCongs: false }
+     * @param hdate Hebrew date to test
+     * @param il use the Israeli holiday schedule
      */
     static tachanun(hdate, il) {
         return tachanun(hdate, il);