@hebcal/core 6.5.0 → 6.5.2

package/dist/src/DailyLearning.d.ts

@@ -1,32 +1,69 @@
 import { HDate } from '@hebcal/hdate';
 import { Event } from './event';
 /**
- * Plug-ins for daily learning calendars such as Daf Yomi, Mishna Yomi, Nach Yomi, etc.
+ * Plug-in registry for daily learning calendars such as Daf Yomi (Bavli),
+ * Yerushalmi Yomi, Mishna Yomi, Nach Yomi, etc.
  *
- * Learning schedules are provided by the `@hebcal/learning` package.
+ * `@hebcal/core` itself contains no learning schedules — they are provided
+ * by the {@link https://github.com/hebcal/hebcal-learning @hebcal/learning}
+ * package, which calls {@link DailyLearning.addCalendar} on import. After
+ * `@hebcal/learning` is loaded, `HebrewCalendar.calendar()` will emit
+ * learning events when the corresponding `options.dailyLearning` flag is set.
+ *
+ * @example
+ * import '@hebcal/learning';
+ * import {DailyLearning, HDate} from '@hebcal/core';
+ *
+ * const ev = DailyLearning.lookup('dafYomi', new HDate(), false);
+ * console.log(ev?.render('en')); // e.g. 'Berakhot 2'
  */
 export declare class DailyLearning {
     /**
-     * Register a new learning calendar.
+     * Registers a new learning calendar.
+     *
+     * The provided function is called whenever a caller asks for an event
+     * from this calendar; if no learning occurs that day (e.g. the date is
+     * before the cycle's start) it should return `null`.
+     * @example
+     * DailyLearning.addCalendar(
+     *   'myCalendar',
+     *   (hd, il) => new Event(hd, 'Today\'s learning', 0),
+     *   new HDate(1, 'Tishrei', 5780),
+     * );
      * @param name case insensitive
      * @param calendar a function that returns an `Event` or `null`
      * @param startDate the first date for which this calendar is valid
      */
     static addCalendar(name: string, calendar: (hd: HDate, il: boolean) => Event | null, startDate?: HDate): void;
     /**
-     * Returns an event from daily calendar for a given date. Returns `null` if there
-     * is no learning from this calendar on this date.
+     * Returns the learning event for the given date from the named calendar,
+     * or `null` if there is no learning that day (or the named calendar is
+     * not registered).
+     * @example
+     * import '@hebcal/learning';
+     * import {DailyLearning, HDate} from '@hebcal/core';
+     * DailyLearning.lookup('dafYomi', new HDate(2024, 1, 15), false);
      * @param name case insensitive
      * @param hd Hebrew Date
      * @param il true for Israel, false for Diaspora
      */
     static lookup(name: string, hd: HDate, il: boolean): Event | null;
+    /**
+     * Returns the first Hebrew date for which the named learning calendar
+     * is valid (as registered by {@link addCalendar}), or `undefined` if the
+     * calendar was not registered with a start date or is not registered at all.
+     * @param name case insensitive
+     */
     static getStartDate(name: string): HDate | undefined;
     /**
-     * Tests to see if learning calendar has been registered
+     * Returns `true` if a learning calendar with the given name has been
+     * registered via {@link addCalendar}.
      * @param name case insensitive
      */
     static has(name: string): boolean;
-    /** Returns the names of all calendars registered */
+    /**
+     * Returns the (lower-cased) names of all currently-registered learning
+     * calendars.
+     */
     static getCalendars(): string[];
 }

package/dist/src/DailyLearning.js

@@ -1,12 +1,34 @@
 const cals = new Map();
 /**
- * Plug-ins for daily learning calendars such as Daf Yomi, Mishna Yomi, Nach Yomi, etc.
+ * Plug-in registry for daily learning calendars such as Daf Yomi (Bavli),
+ * Yerushalmi Yomi, Mishna Yomi, Nach Yomi, etc.
  *
- * Learning schedules are provided by the `@hebcal/learning` package.
+ * `@hebcal/core` itself contains no learning schedules — they are provided
+ * by the {@link https://github.com/hebcal/hebcal-learning @hebcal/learning}
+ * package, which calls {@link DailyLearning.addCalendar} on import. After
+ * `@hebcal/learning` is loaded, `HebrewCalendar.calendar()` will emit
+ * learning events when the corresponding `options.dailyLearning` flag is set.
+ *
+ * @example
+ * import '@hebcal/learning';
+ * import {DailyLearning, HDate} from '@hebcal/core';
+ *
+ * const ev = DailyLearning.lookup('dafYomi', new HDate(), false);
+ * console.log(ev?.render('en')); // e.g. 'Berakhot 2'
  */
 export class DailyLearning {
     /**
-     * Register a new learning calendar.
+     * Registers a new learning calendar.
+     *
+     * The provided function is called whenever a caller asks for an event
+     * from this calendar; if no learning occurs that day (e.g. the date is
+     * before the cycle's start) it should return `null`.
+     * @example
+     * DailyLearning.addCalendar(
+     *   'myCalendar',
+     *   (hd, il) => new Event(hd, 'Today\'s learning', 0),
+     *   new HDate(1, 'Tishrei', 5780),
+     * );
      * @param name case insensitive
      * @param calendar a function that returns an `Event` or `null`
      * @param startDate the first date for which this calendar is valid
@@ -21,8 +43,13 @@ export class DailyLearning {
         });
     }
     /**
-     * Returns an event from daily calendar for a given date. Returns `null` if there
-     * is no learning from this calendar on this date.
+     * Returns the learning event for the given date from the named calendar,
+     * or `null` if there is no learning that day (or the named calendar is
+     * not registered).
+     * @example
+     * import '@hebcal/learning';
+     * import {DailyLearning, HDate} from '@hebcal/core';
+     * DailyLearning.lookup('dafYomi', new HDate(2024, 1, 15), false);
      * @param name case insensitive
      * @param hd Hebrew Date
      * @param il true for Israel, false for Diaspora
@@ -34,6 +61,12 @@ export class DailyLearning {
         }
         return null;
     }
+    /**
+     * Returns the first Hebrew date for which the named learning calendar
+     * is valid (as registered by {@link addCalendar}), or `undefined` if the
+     * calendar was not registered with a start date or is not registered at all.
+     * @param name case insensitive
+     */
     static getStartDate(name) {
         const cal = cals.get(name.toLowerCase());
         if (typeof cal === 'object') {
@@ -42,13 +75,17 @@ export class DailyLearning {
         return undefined;
     }
     /**
-     * Tests to see if learning calendar has been registered
+     * Returns `true` if a learning calendar with the given name has been
+     * registered via {@link addCalendar}.
      * @param name case insensitive
      */
     static has(name) {
         return cals.has(name.toLowerCase());
     }
-    /** Returns the names of all calendars registered */
+    /**
+     * Returns the (lower-cased) names of all currently-registered learning
+     * calendars.
+     */
     static getCalendars() {
         return Array.from(cals.keys());
     }

package/dist/src/HolidayEvent.d.ts

@@ -1,7 +1,22 @@
 import { HDate } from '@hebcal/hdate';
 import { Event } from './event';
 import './locale';
-/** Represents a built-in holiday like Pesach, Purim or Tu BiShvat */
+/**
+ * Represents a built-in holiday like Pesach, Purim or Tu BiShvat.
+ *
+ * Most holiday-related events emitted by {@link HebrewCalendar.calendar}
+ * are instances of `HolidayEvent` or one of its subclasses
+ * ({@link ChanukahEvent}, {@link AsaraBTevetEvent},
+ * {@link RoshHashanaEvent}, {@link RoshChodeshEvent}).
+ *
+ * Adds two notable behaviors over the base {@link Event}:
+ *
+ * - {@link HolidayEvent.basename} strips qualifiers like `Erev `, ` I`/`II`,
+ *   `(CH''M)`, `(observed)`, candle counts, etc. (e.g. `"Erev Pesach"` →
+ *   `"Pesach"`).
+ * - {@link HolidayEvent.url} returns a `https://www.hebcal.com/holidays/...`
+ *   link for the holiday.
+ */
 export declare class HolidayEvent extends Event {
     /** During Sukkot or Pesach */
     cholHaMoedDay?: number;
@@ -12,7 +27,25 @@ export declare class HolidayEvent extends Event {
      */
     observed?: boolean;
     constructor(date: HDate, desc: string, mask?: number, attrs?: object);
+    /**
+     * 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 "`.
+     * @example
+     * // 'Erev Pesach'           => 'Pesach'
+     * // 'Sukkot III (CH''M)'    => 'Sukkot'
+     * // 'Chanukah: 5 Candles'   => 'Chanukah'
+     * // 'Rosh Hashana 5784'     => 'Rosh Hashana'
+     */
     basename(): string;
+    /**
+     * 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]`.
+     */
     url(): string | undefined;
     urlDateSuffix(): string;
     getEmoji(): string;

package/dist/src/HolidayEvent.js

@@ -2,7 +2,22 @@ import { Locale, isoDateString } from '@hebcal/hdate';
 import { Event, flags } from './event';
 import { holidayDesc as hdesc } from './staticHolidays';
 import './locale'; // Adds Hebrew and Ashkenazic translations
-/** Represents a built-in holiday like Pesach, Purim or Tu BiShvat */
+/**
+ * Represents a built-in holiday like Pesach, Purim or Tu BiShvat.
+ *
+ * Most holiday-related events emitted by {@link HebrewCalendar.calendar}
+ * are instances of `HolidayEvent` or one of its subclasses
+ * ({@link ChanukahEvent}, {@link AsaraBTevetEvent},
+ * {@link RoshHashanaEvent}, {@link RoshChodeshEvent}).
+ *
+ * Adds two notable behaviors over the base {@link Event}:
+ *
+ * - {@link HolidayEvent.basename} strips qualifiers like `Erev `, ` I`/`II`,
+ *   `(CH''M)`, `(observed)`, candle counts, etc. (e.g. `"Erev Pesach"` →
+ *   `"Pesach"`).
+ * - {@link HolidayEvent.url} returns a `https://www.hebcal.com/holidays/...`
+ *   link for the holiday.
+ */
 export class HolidayEvent extends Event {
     /** During Sukkot or Pesach */
     cholHaMoedDay;
@@ -18,6 +33,19 @@ export class HolidayEvent extends Event {
             Object.assign(this, attrs);
         }
     }
+    /**
+     * 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 "`.
+     * @example
+     * // 'Erev Pesach'           => 'Pesach'
+     * // 'Sukkot III (CH''M)'    => 'Sukkot'
+     * // 'Chanukah: 5 Candles'   => 'Chanukah'
+     * // 'Rosh Hashana 5784'     => 'Rosh Hashana'
+     */
     basename() {
         return this.getDesc()
             .replace(/ \d{4}$/, '')
@@ -29,6 +57,11 @@ export class HolidayEvent extends Event {
             .replace(/: 8th Day$/, '')
             .replace(/^Erev /, '');
     }
+    /**
+     * 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]`.
+     */
     url() {
         const year = this.greg().getFullYear();
         if (year < 100 || year > 2999) {

package/dist/src/TimedEvent.d.ts

@@ -3,12 +3,26 @@ import { CalOptions } from './CalOptions';
 import { Location } from './location';
 import { Event } from './event';
 import './locale';
-/** An event that has an `eventTime` and `eventTimeStr` */
+/**
+ * Base class for events that have an associated wall-clock time and
+ * geographic location — for example, candle lighting, havdalah, and
+ * fast begin/end times.
+ *
+ * Stores both a `Date` (`eventTime`) and pre-formatted 24-hour
+ * (`eventTimeStr`) and locale-aware (`fmtTime`) strings. May reference a
+ * "linked" event such as the holiday whose candle-lighting time this
+ * represents.
+ */
 export declare class TimedEvent extends Event {
+    /** The exact moment of the event, rounded to the nearest minute */
     readonly eventTime: Date;
+    /** Geographic location used to compute `eventTime` */
     readonly location: Location;
+    /** 24-hour formatted time string in the location's timezone (e.g. `"19:42"`) */
     readonly eventTimeStr: string;
+    /** Locale-aware formatted time string (e.g. `"7:42pm"` in US locale) */
     readonly fmtTime: string;
+    /** Optional event this time is associated with (e.g. the Yom Tov being lit for) */
     readonly linkedEvent?: Event;
     /**
      * @param desc Description (not translated)
@@ -25,12 +39,27 @@ export declare class TimedEvent extends Event {
     renderBrief(locale?: string): string;
     getCategories(): string[];
 }
-/** Candle lighting before Shabbat or holiday */
+/**
+ * Candle-lighting event for the eve of Shabbat or a Yom Tov.
+ *
+ * Generated by {@link HebrewCalendar.calendar} when `options.candlelighting`
+ * is `true` and `options.location` is provided. By default candle lighting
+ * occurs 18 minutes before sundown (40 minutes in Jerusalem; 30 minutes in
+ * Haifa and Zikhron Ya'akov), configurable via `options.candleLightingMins`.
+ */
 export declare class CandleLightingEvent extends TimedEvent {
     constructor(date: HDate, mask: number, eventTime: Date, location: Location, linkedEvent?: Event, options?: CalOptions);
     getEmoji(): string;
 }
-/** Havdalah after Shabbat or holiday */
+/**
+ * Havdalah event marking the end of Shabbat or a Yom Tov.
+ *
+ * Generated by {@link HebrewCalendar.calendar} when `options.candlelighting`
+ * is `true` and `options.location` is provided. By default Havdalah is
+ * calculated by *tzeit hakochavim* (8.5° solar depression); pass
+ * `options.havdalahMins` to use a fixed minute offset instead, or
+ * `options.havdalahDeg` to use a different degree.
+ */
 export declare class HavdalahEvent extends TimedEvent {
     private readonly havdalahMins?;
     constructor(date: HDate, mask: number, eventTime: Date, location: Location, havdalahMins?: number, linkedEvent?: Event, options?: CalOptions);

package/dist/src/TimedEvent.js

@@ -6,12 +6,26 @@ import { holidayDesc as hdesc } from './staticHolidays';
 import './locale'; // Adds Hebrew and Ashkenazic translations
 const HAVDALAH = hdesc.HAVDALAH;
 const CANDLE_LIGHTING = hdesc.CANDLE_LIGHTING;
-/** An event that has an `eventTime` and `eventTimeStr` */
+/**
+ * Base class for events that have an associated wall-clock time and
+ * geographic location — for example, candle lighting, havdalah, and
+ * fast begin/end times.
+ *
+ * Stores both a `Date` (`eventTime`) and pre-formatted 24-hour
+ * (`eventTimeStr`) and locale-aware (`fmtTime`) strings. May reference a
+ * "linked" event such as the holiday whose candle-lighting time this
+ * represents.
+ */
 export class TimedEvent extends Event {
+    /** The exact moment of the event, rounded to the nearest minute */
     eventTime;
+    /** Geographic location used to compute `eventTime` */
     location;
+    /** 24-hour formatted time string in the location's timezone (e.g. `"19:42"`) */
     eventTimeStr;
+    /** Locale-aware formatted time string (e.g. `"7:42pm"` in US locale) */
     fmtTime;
+    /** Optional event this time is associated with (e.g. the Yom Tov being lit for) */
     linkedEvent;
     /**
      * @param desc Description (not translated)
@@ -63,7 +77,14 @@ export class TimedEvent extends Event {
         return ['unknown'];
     }
 }
-/** Candle lighting before Shabbat or holiday */
+/**
+ * Candle-lighting event for the eve of Shabbat or a Yom Tov.
+ *
+ * Generated by {@link HebrewCalendar.calendar} when `options.candlelighting`
+ * is `true` and `options.location` is provided. By default candle lighting
+ * occurs 18 minutes before sundown (40 minutes in Jerusalem; 30 minutes in
+ * Haifa and Zikhron Ya'akov), configurable via `options.candleLightingMins`.
+ */
 export class CandleLightingEvent extends TimedEvent {
     constructor(date, mask, eventTime, location, linkedEvent, options) {
         super(date, CANDLE_LIGHTING, mask, eventTime, location, linkedEvent, options);
@@ -72,7 +93,15 @@ export class CandleLightingEvent extends TimedEvent {
         return '🕯️';
     }
 }
-/** Havdalah after Shabbat or holiday */
+/**
+ * Havdalah event marking the end of Shabbat or a Yom Tov.
+ *
+ * Generated by {@link HebrewCalendar.calendar} when `options.candlelighting`
+ * is `true` and `options.location` is provided. By default Havdalah is
+ * calculated by *tzeit hakochavim* (8.5° solar depression); pass
+ * `options.havdalahMins` to use a fixed minute offset instead, or
+ * `options.havdalahDeg` to use a different degree.
+ */
 export class HavdalahEvent extends TimedEvent {
     havdalahMins;
     constructor(date, mask, eventTime, location, havdalahMins, linkedEvent, options) {

package/dist/src/ashkenazi.po.d.ts

@@ -44,6 +44,7 @@ declare const _default: {
             "Sukkot VII (Hoshana Raba)": string[];
             "Sukkot Shabbat Chol ha-Moed": string[];
             "Ta'anit Bechorot": string[];
+            "Ta'anit BeHaB": string[];
             "Ta'anit Esther": string[];
             Toldot: string[];
             Vaetchanan: string[];

package/dist/src/ashkenazi.po.js

@@ -1 +1 @@
-export default { "headers": { "plural-forms": "nplurals=2; plural=(n > 1);", "language": "en_CA@ashkenazi" }, "contexts": { "": { "Shabbat": ["Shabbos"], "Achrei Mot": ["Achrei Mos"], "Bechukotai": ["Bechukosai"], "Beha'alotcha": ["Beha’aloscha"], "Bereshit": ["Bereshis"], "Chukat": ["Chukas"], "Erev Shavuot": ["Erev Shavuos"], "Erev Sukkot": ["Erev Sukkos"], "Ki Tavo": ["Ki Savo"], "Ki Teitzei": ["Ki Seitzei"], "Ki Tisa": ["Ki Sisa"], "Matot": ["Matos"], "Pesach Shabbat Chol ha-Moed": ["Pesach Shabbos Chol ha-Moed"], "Purim Katan": ["Purim Koton"], "Shabbat Chazon": ["Shabbos Chazon"], "Shabbat HaChodesh": ["Shabbos HaChodesh"], "Shabbat HaGadol": ["Shabbos HaGadol"], "Shabbat Nachamu": ["Shabbos Nachamu"], "Shabbat Parah": ["Shabbos Parah"], "Shabbat Shekalim": ["Shabbos Shekalim"], "Shabbat Shuva": ["Shabbos Shuvah"], "Shabbat Zachor": ["Shabbos Zachor"], "Shavuot": ["Shavuos"], "Shavuot I": ["Shavuos I"], "Shavuot II": ["Shavuos II"], "Shemot": ["Shemos"], "Shmini Atzeret": ["Shmini Atzeres"], "Simchat Torah": ["Simchas Torah"], "Sukkot": ["Sukkos"], "Sukkot I": ["Sukkos I"], "Sukkot II": ["Sukkos II"], "Sukkot II (CH''M)": ["Sukkos II (CH’’M)"], "Sukkot III (CH''M)": ["Sukkos III (CH’’M)"], "Sukkot IV (CH''M)": ["Sukkos IV (CH’’M)"], "Sukkot V (CH''M)": ["Sukkos V (CH’’M)"], "Sukkot VI (CH''M)": ["Sukkos VI (CH’’M)"], "Sukkot VII (Hoshana Raba)": ["Sukkos VII (Hoshana Raba)"], "Sukkot Shabbat Chol ha-Moed": ["Sukkos Shabbos Chol ha-Moed"], "Ta'anit Bechorot": ["Ta’anis Bechoros"], "Ta'anit Esther": ["Ta’anis Esther"], "Toldot": ["Toldos"], "Vaetchanan": ["Vaeschanan"], "Yitro": ["Yisro"], "Vezot Haberakhah": ["Vezos Haberakhah"], "Parashat": ["Parshas"], "Leil Selichot": ["Leil Selichos"], "Shabbat Mevarchim Chodesh": ["Shabbos Mevorchim Chodesh"], "Shabbat Shirah": ["Shabbos Shirah"], "Asara B'Tevet": ["Asara B’Teves"], "Birkat Hachamah": ["Birkas HaChamah"], "Birkat HaChamah": ["Birkas HaChamah"], "Shushan Purim Katan": ["Shushan Purim Koton"], "Alot HaShachar": ["Alos HaShachar"], "Misheyakir": ["Misheyakir"], "Misheyakir Machmir": ["Misheyakir Machmir"], "Sunrise": ["Sunrise"], "Kriat Shema, sof zeman": ["Krias Shema, sof zman"], "Tefilah, sof zeman": ["Tefilah, sof zman"], "Kriat Shema, sof zeman (MGA)": ["Krias Shema, sof zman (MGA)"], "Kriat Shema, sof zeman (GRA)": ["Krias Shema, sof zman (GRA)"], "Tefilah, sof zeman (MGA)": ["Tefilah, sof zman (MGA)"], "Tefilah, sof zeman (GRA)": ["Tefilah, sof zman (GRA)"], "Chatzot HaLailah": ["Chatzos HaLailah"], "Chatzot HaYom": ["Chatzos"], "Chatzot hayom": ["Chatzos"], "Mincha Gedolah": ["Mincha Gedolah"], "Mincha Ketanah": ["Mincha Ketanah"], "Plag HaMincha": ["Plag HaMincha"], "Sunset": ["Sunset"], "Bein HaShemashot": ["Bein HaShemashos"], "Tzeit HaKochavim": ["Tzeis HaKochavim"] } } };
+export default { "headers": { "plural-forms": "nplurals=2; plural=(n > 1);", "language": "en_CA@ashkenazi" }, "contexts": { "": { "Shabbat": ["Shabbos"], "Achrei Mot": ["Achrei Mos"], "Bechukotai": ["Bechukosai"], "Beha'alotcha": ["Beha’aloscha"], "Bereshit": ["Bereshis"], "Chukat": ["Chukas"], "Erev Shavuot": ["Erev Shavuos"], "Erev Sukkot": ["Erev Sukkos"], "Ki Tavo": ["Ki Savo"], "Ki Teitzei": ["Ki Seitzei"], "Ki Tisa": ["Ki Sisa"], "Matot": ["Matos"], "Pesach Shabbat Chol ha-Moed": ["Pesach Shabbos Chol ha-Moed"], "Purim Katan": ["Purim Koton"], "Shabbat Chazon": ["Shabbos Chazon"], "Shabbat HaChodesh": ["Shabbos HaChodesh"], "Shabbat HaGadol": ["Shabbos HaGadol"], "Shabbat Nachamu": ["Shabbos Nachamu"], "Shabbat Parah": ["Shabbos Parah"], "Shabbat Shekalim": ["Shabbos Shekalim"], "Shabbat Shuva": ["Shabbos Shuvah"], "Shabbat Zachor": ["Shabbos Zachor"], "Shavuot": ["Shavuos"], "Shavuot I": ["Shavuos I"], "Shavuot II": ["Shavuos II"], "Shemot": ["Shemos"], "Shmini Atzeret": ["Shmini Atzeres"], "Simchat Torah": ["Simchas Torah"], "Sukkot": ["Sukkos"], "Sukkot I": ["Sukkos I"], "Sukkot II": ["Sukkos II"], "Sukkot II (CH''M)": ["Sukkos II (CH’’M)"], "Sukkot III (CH''M)": ["Sukkos III (CH’’M)"], "Sukkot IV (CH''M)": ["Sukkos IV (CH’’M)"], "Sukkot V (CH''M)": ["Sukkos V (CH’’M)"], "Sukkot VI (CH''M)": ["Sukkos VI (CH’’M)"], "Sukkot VII (Hoshana Raba)": ["Sukkos VII (Hoshana Raba)"], "Sukkot Shabbat Chol ha-Moed": ["Sukkos Shabbos Chol ha-Moed"], "Ta'anit Bechorot": ["Ta’anis Bechoros"], "Ta'anit BeHaB": ["Ta’anis BeHaB"], "Ta'anit Esther": ["Ta’anis Esther"], "Toldot": ["Toldos"], "Vaetchanan": ["Vaeschanan"], "Yitro": ["Yisro"], "Vezot Haberakhah": ["Vezos Haberakhah"], "Parashat": ["Parshas"], "Leil Selichot": ["Leil Selichos"], "Shabbat Mevarchim Chodesh": ["Shabbos Mevorchim Chodesh"], "Shabbat Shirah": ["Shabbos Shirah"], "Asara B'Tevet": ["Asara B’Teves"], "Birkat Hachamah": ["Birkas HaChamah"], "Birkat HaChamah": ["Birkas HaChamah"], "Shushan Purim Katan": ["Shushan Purim Koton"], "Alot HaShachar": ["Alos HaShachar"], "Misheyakir": ["Misheyakir"], "Misheyakir Machmir": ["Misheyakir Machmir"], "Sunrise": ["Sunrise"], "Kriat Shema, sof zeman": ["Krias Shema, sof zman"], "Tefilah, sof zeman": ["Tefilah, sof zman"], "Kriat Shema, sof zeman (MGA)": ["Krias Shema, sof zman (MGA)"], "Kriat Shema, sof zeman (GRA)": ["Krias Shema, sof zman (GRA)"], "Tefilah, sof zeman (MGA)": ["Tefilah, sof zman (MGA)"], "Tefilah, sof zeman (GRA)": ["Tefilah, sof zman (GRA)"], "Chatzot HaLailah": ["Chatzos HaLailah"], "Chatzot HaYom": ["Chatzos"], "Chatzot hayom": ["Chatzos"], "Mincha Gedolah": ["Mincha Gedolah"], "Mincha Ketanah": ["Mincha Ketanah"], "Plag HaMincha": ["Plag HaMincha"], "Sunset": ["Sunset"], "Bein HaShemashot": ["Bein HaShemashos"], "Tzeit HaKochavim": ["Tzeis HaKochavim"] } } };

package/dist/src/calendar.d.ts

@@ -34,6 +34,7 @@ import { Event } from './event';
  * * Shabbat Mevarchim HaChodesh on Saturday before Rosh Chodesh (`options.shabbatMevarchim`)
  * * Molad announcement on Saturday before Rosh Chodesh (`options.molad`)
  * * Yom Kippur Katan (`options.yomKippurKatan`)
+ * * BeHaB fast days after Pesach and Sukkot (`options.behab`)
  * * Yizkor (`options.yizkor`)
  *
  * Daily Study of texts are supported by the

package/dist/src/calendar.js

@@ -49,6 +49,7 @@ import { holidayDesc as hdesc } from './staticHolidays';
  * * Shabbat Mevarchim HaChodesh on Saturday before Rosh Chodesh (`options.shabbatMevarchim`)
  * * Molad announcement on Saturday before Rosh Chodesh (`options.molad`)
  * * Yom Kippur Katan (`options.yomKippurKatan`)
+ * * BeHaB fast days after Pesach and Sukkot (`options.behab`)
  * * Yizkor (`options.yizkor`)
  *
  * Daily Study of texts are supported by the
@@ -297,6 +298,7 @@ const EREV = flags.EREV;
 const CHOL_HAMOED = flags.CHOL_HAMOED;
 const YOM_KIPPUR_KATAN = flags.YOM_KIPPUR_KATAN;
 const YIZKOR = flags.YIZKOR;
+const BEHAB = flags.BEHAB;
 const unrecognizedAlreadyWarned = new Set();
 const RECOGNIZED_OPTIONS = {
     location: 1,
@@ -327,6 +329,7 @@ const RECOGNIZED_OPTIONS = {
     addHebrewDatesForEvents: 1,
     mask: 1,
     yomKippurKatan: 1,
+    behab: 1,
     hour12: 1,
     dailyLearning: 1,
     useElevation: 1,
@@ -499,6 +502,9 @@ function getMaskFromOptions(options) {
     if (options.yomKippurKatan) {
         mask |= YOM_KIPPUR_KATAN;
     }
+    if (options.behab) {
+        mask |= BEHAB;
+    }
     if (options.yizkor) {
         mask |= YIZKOR;
     }
@@ -557,6 +563,8 @@ function setOptionsFromMask(options) {
         options.shabbatMevarchim = true;
     if (m & YOM_KIPPUR_KATAN)
         options.yomKippurKatan = true;
+    if (m & BEHAB)
+        options.behab = true;
     if (m & YIZKOR)
         options.yizkor = true;
     return m;
@@ -573,6 +581,7 @@ function appendHolidayAndRelated(candlesEv, events, ev, options, isFriday, isSat
     }
     const eFlags = ev.getFlags();
     if ((!options.yomKippurKatan && eFlags & YOM_KIPPUR_KATAN) ||
+        (!options.behab && eFlags & BEHAB) ||
         (options.noModern && eFlags & MODERN_HOLIDAY)) {
         return candlesEv; // bail out early
     }
@@ -613,7 +622,8 @@ function appendHolidayAndRelated(candlesEv, events, ev, options, isFriday, isSat
             }
         }
         if (!options.noHolidays ||
-            (options.yomKippurKatan && eFlags & YOM_KIPPUR_KATAN)) {
+            (options.yomKippurKatan && eFlags & YOM_KIPPUR_KATAN) ||
+            (options.behab && eFlags & BEHAB)) {
             events.push(ev); // the original event itself
         }
     }

package/dist/src/candles.d.ts

@@ -8,7 +8,20 @@ import { TimedEvent } from './TimedEvent';
  * @private
  */
 export declare function makeCandleEvent(ev: Event | undefined, hd: HDate, options: CalOptions, isFriday: boolean, isSaturday: boolean): TimedEvent | undefined;
-/** A fast day also contains a start and end time */
+/**
+ * A fast day holiday with attached start and end time events.
+ *
+ * Wraps an underlying fast-day {@link HolidayEvent} and (when computable
+ * for the given location) exposes a "Fast begins" and "Fast ends"
+ * {@link TimedEvent}. Generated by {@link HebrewCalendar.calendar} when
+ * `options.candlelighting` is `true` and `options.location` is provided.
+ *
+ * - Minor fasts begin at *Alot HaShachar* (16.1° below horizon in the morning)
+ *   and end at tzeit (7.083° by default — overridable via `options.fastEndDeg`).
+ * - Tish'a B'Av begins at sunset on the previous day and ends at tzeit.
+ * - When a minor fast falls on a Friday, the end time is suppressed
+ *   (Shabbat begins before nightfall).
+ */
 export declare class FastDayEvent extends HolidayEvent {
     /** original event */
     readonly linkedEvent: HolidayEvent;

package/dist/src/candles.js

@@ -52,7 +52,20 @@ export function makeCandleEvent(ev, hd, options, isFriday, isSaturday) {
 }
 const FAST_BEGINS = hdesc.FAST_BEGINS;
 const FAST_ENDS = hdesc.FAST_ENDS;
-/** A fast day also contains a start and end time */
+/**
+ * A fast day holiday with attached start and end time events.
+ *
+ * Wraps an underlying fast-day {@link HolidayEvent} and (when computable
+ * for the given location) exposes a "Fast begins" and "Fast ends"
+ * {@link TimedEvent}. Generated by {@link HebrewCalendar.calendar} when
+ * `options.candlelighting` is `true` and `options.location` is provided.
+ *
+ * - Minor fasts begin at *Alot HaShachar* (16.1° below horizon in the morning)
+ *   and end at tzeit (7.083° by default — overridable via `options.fastEndDeg`).
+ * - Tish'a B'Av begins at sunset on the previous day and ends at tzeit.
+ * - When a minor fast falls on a Friday, the end time is suppressed
+ *   (Shabbat begins before nightfall).
+ */
 export class FastDayEvent extends HolidayEvent {
     /** original event */
     linkedEvent;

package/dist/src/cities.json

@@ -0,0 +1,67 @@
+[
+    "Ashdod|IL|31.79213|34.64966|Asia/Jerusalem|27",
+    "Atlanta|US|33.749|-84.38798|America/New_York|336",
+    "Austin|US|30.26715|-97.74306|America/Chicago|165",
+    "Baghdad|IQ|33.34058|44.40088|Asia/Baghdad|41",
+    "Beer Sheva|IL|31.25181|34.7913|Asia/Jerusalem|285",
+    "Berlin|DE|52.52437|13.41053|Europe/Berlin|43",
+    "Baltimore|US|39.29038|-76.61219|America/New_York|35",
+    "Bogota|CO|4.60971|-74.08175|America/Bogota|2582",
+    "Boston|US|42.35843|-71.05977|America/New_York|38",
+    "Budapest|HU|47.49801|19.03991|Europe/Budapest|104",
+    "Buenos Aires|AR|-34.61315|-58.37723|America/Argentina/Buenos_Aires|31",
+    "Buffalo|US|42.88645|-78.87837|America/New_York|191",
+    "Chicago|US|41.85003|-87.65005|America/Chicago|180",
+    "Cincinnati|US|39.162|-84.45689|America/New_York|267",
+    "Cleveland|US|41.4995|-81.69541|America/New_York|204",
+    "Dallas|US|32.78306|-96.80667|America/Chicago|139",
+    "Denver|US|39.73915|-104.9847|America/Denver|1636",
+    "Detroit|US|42.33143|-83.04575|America/Detroit|192",
+    "Eilat|IL|29.55805|34.94821|Asia/Jerusalem|63",
+    "Gibraltar|GI|36.14474|-5.35257|Europe/Gibraltar|11",
+    "Haifa|IL|32.81841|34.9885|Asia/Jerusalem|40",
+    "Hawaii|US|21.30694|-157.85833|Pacific/Honolulu|18",
+    "Helsinki|FI|60.16952|24.93545|Europe/Helsinki|26",
+    "Houston|US|29.76328|-95.36327|America/Chicago|30",
+    "Jerusalem|IL|31.76904|35.21633|Asia/Jerusalem|786",
+    "Johannesburg|ZA|-26.20227|28.04363|Africa/Johannesburg|1767",
+    "Kiev|UA|50.45466|30.5238|Europe/Kiev|187",
+    "La Paz|BO|-16.5|-68.15|America/La_Paz|3782",
+    "Livingston|US|40.79593|-74.31487|America/New_York|98",
+    "Las Vegas|US|36.17497|-115.13722|America/Los_Angeles|613",
+    "London|GB|51.50853|-0.12574|Europe/London|25",
+    "Los Angeles|US|34.05223|-118.24368|America/Los_Angeles|96",
+    "Marseilles|FR|43.29695|5.38107|Europe/Paris|28",
+    "Miami|US|25.77427|-80.19366|America/New_York|25",
+    "Minneapolis|US|44.97997|-93.26384|America/Chicago|262",
+    "Melbourne|AU|-37.814|144.96332|Australia/Melbourne|25",
+    "Mexico City|MX|19.42847|-99.12766|America/Mexico_City|2240",
+    "Montreal|CA|45.50884|-73.58781|America/Toronto|216",
+    "Moscow|RU|55.75222|37.61556|Europe/Moscow|144",
+    "New York|US|40.71427|-74.00597|America/New_York|57",
+    "Omaha|US|41.25861|-95.93779|America/Chicago|315",
+    "Ottawa|CA|45.41117|-75.69812|America/Toronto|71",
+    "Panama City|PA|8.9936|-79.51973|America/Panama|17",
+    "Paris|FR|48.85341|2.3488|Europe/Paris|42",
+    "Pawtucket|US|41.87871|-71.38256|America/New_York|0",
+    "Petach Tikvah|IL|32.08707|34.88747|Asia/Jerusalem|54",
+    "Philadelphia|US|39.95233|-75.16379|America/New_York|8",
+    "Phoenix|US|33.44838|-112.07404|America/Phoenix|366",
+    "Pittsburgh|US|40.44062|-79.99589|America/New_York|239",
+    "Providence|US|41.82399|-71.41283|America/New_York|0",
+    "Portland|US|45.52345|-122.67621|America/Los_Angeles|15",
+    "Saint Louis|US|38.62727|-90.19789|America/Chicago|149",
+    "Saint Petersburg|RU|59.93863|30.31413|Europe/Moscow|11",
+    "San Diego|US|32.71533|-117.15726|America/Los_Angeles|20",
+    "San Francisco|US|37.77493|-122.41942|America/Los_Angeles|28",
+    "Sao Paulo|BR|-23.5475|-46.63611|America/Sao_Paulo|769",
+    "Seattle|US|47.60621|-122.33207|America/Los_Angeles|56",
+    "Sydney|AU|-33.86785|151.20732|Australia/Sydney|58",
+    "Tel Aviv|IL|32.08088|34.78057|Asia/Jerusalem|15",
+    "Tiberias|IL|32.79221|35.53124|Asia/Jerusalem|0",
+    "Toronto|CA|43.70011|-79.4163|America/Toronto|175",
+    "Vancouver|CA|49.24966|-123.11934|America/Vancouver|70",
+    "White Plains|US|41.03399|-73.76291|America/New_York|82",
+    "Washington DC|US|38.89511|-77.03637|America/New_York|6",
+    "Worcester|US|42.26259|-71.80229|America/New_York|164"
+]