@hebcal/core 6.5.0 → 6.5.2

package/dist/src/location.js

@@ -19,80 +19,8 @@
     along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 import { GeoLocation } from '@hebcal/noaa';
-const classicCities0 = [
-    ['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], // -11
-    ['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], // -15
-    ['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], // -140
-    ['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],
-];
+import citiesJson from './cities.json';
+import QuickLRU from 'quick-lru';
 const classicCities = new Map();
 // Zip-Codes.com TimeZone IDs
 const ZIPCODES_TZ_MAP = {
@@ -111,7 +39,9 @@ const ZIPCODES_TZ_MAP = {
     '16': 'Pacific/Chuuk', //      Micronesia (GMT +11:00)
 };
 /** @private */
-const timeFormatCache = new Map();
+const timeFormatCache = new QuickLRU({
+    maxSize: 120,
+});
 /**
  * Gets a 24-hour time formatter (e.g. 07:41 or 20:03) from cache
  * or makes a new one if needed
@@ -130,7 +60,38 @@ function getFormatter(tzid) {
     timeFormatCache.set(tzid, f);
     return f;
 }
-/** Class representing Location */
+function initClassicCities() {
+    for (const entry of citiesJson) {
+        const [cityName, cc, lat, lng, tzid, elev] = entry.split('|');
+        const location = new Location(+lat, +lng, cc === 'IL', tzid, cityName, cc, undefined, +elev);
+        Location.addLocation(cityName, location);
+    }
+}
+/**
+ * Class representing a geographic location for use with candle-lighting,
+ * havdalah, and zmanim calculations.
+ *
+ * Extends {@link GeoLocation} from `@hebcal/noaa` with Jewish-calendar
+ * specific data: an Israel/Diaspora flag, ISO country code, and an optional
+ * geographic identifier. Also provides {@link Location.lookup} for ~60
+ * built-in "classic" Hebcal cities.
+ *
+ * @example
+ * import {Location} from '@hebcal/core';
+ *
+ * // Create a location for a custom address
+ * const loc = new Location(
+ *   41.85003,    // latitude
+ *   -87.65005,   // longitude
+ *   false,       // not in Israel
+ *   'America/Chicago',
+ *   'Chicago, Illinois, USA',
+ *   'US'
+ * );
+ *
+ * // Or look up a built-in classic city
+ * const tlv = Location.lookup('Tel Aviv');
+ */
 export class Location extends GeoLocation {
     il;
     cc;
@@ -173,14 +134,31 @@ export class Location extends GeoLocation {
         this.cc = countryCode;
         this.geoid = geoid;
     }
+    /**
+     * Returns `true` if this location is in Israel (uses the Israeli holiday
+     * and Torah-reading schedule), `false` for the Diaspora.
+     */
     getIsrael() {
         return this.il;
     }
+    /**
+     * Returns the full descriptive location name passed to the constructor,
+     * or `null` if no name was provided.
+     * @example
+     * Location.lookup('San Francisco')?.getName(); // 'San Francisco, California, USA'
+     */
     getName() {
         return this.getLocationName();
     }
     /**
-     * Returns the location name, up to the first comma
+     * Returns the location name truncated at the first comma. Useful for
+     * compact display where only the city name is desired.
+     *
+     * Special-cased so that US locations of the form `"Washington, DC"` or
+     * `"Washington, D.C., ..."` keep the `DC` / `D.C.` suffix attached.
+     * @example
+     * Location.lookup('San Francisco')?.getShortName(); // 'San Francisco'
+     * Location.lookup('Washington DC')?.getShortName(); // 'Washington, DC'
      */
     getShortName() {
         const name = this.getLocationName();
@@ -199,18 +177,37 @@ export class Location extends GeoLocation {
         }
         return name.substring(0, comma);
     }
+    /**
+     * Returns the ISO 3166 alpha-2 country code (e.g. `"US"`, `"IL"`, `"FR"`)
+     * passed to the constructor, or `undefined` if none was provided.
+     */
     getCountryCode() {
         return this.cc;
     }
+    /**
+     * Returns the Olson timezone identifier (e.g. `"America/Chicago"`).
+     * Alias for `getTimeZone()` from the parent `GeoLocation` class.
+     */
     getTzid() {
         return this.getTimeZone();
     }
     /**
-     * Gets a 24-hour time formatter (e.g. 07:41 or 20:03) for this location
+     * Returns a cached 24-hour `Intl.DateTimeFormat` (e.g. `07:41` or `20:03`)
+     * configured for this location's timezone. Formatters are memoized by
+     * timezone so repeated calls do not allocate.
+     * @example
+     * const loc = Location.lookup('Tel Aviv')!;
+     * const fmt = loc.getTimeFormatter();
+     * fmt.format(new Date()); // e.g. '18:42'
      */
     getTimeFormatter() {
         return getFormatter(this.getTimeZone());
     }
+    /**
+     * Returns the optional geographic identifier passed to the constructor
+     * (typically a GeoNames numeric ID or a US Zip Code string), or
+     * `undefined` if none was provided.
+     */
     getGeoId() {
         return this.geoid;
     }
@@ -230,16 +227,38 @@ export class Location extends GeoLocation {
      * 'San Diego', 'San Francisco', 'Sao Paulo', 'Seattle', 'Sydney',
      * 'Tel Aviv', 'Tiberias', 'Toronto', 'Vancouver', 'White Plains',
      * 'Washington DC', 'Worcester'
-     * @param name
+     *
+     * Lookups are case-insensitive. Returns `undefined` if the name is not
+     * recognized. The list can be extended with {@link Location.addLocation}.
+     * @example
+     * const loc = Location.lookup('San Francisco');
+     * console.log(loc?.getTzid()); // 'America/Los_Angeles'
+     * @param name case-insensitive classic city name
      */
     static lookup(name) {
+        if (classicCities.size === 0) {
+            initClassicCities();
+        }
         return classicCities.get(name.toLowerCase());
     }
+    /**
+     * Returns a JSON-serialized representation of this Location.
+     * Useful for debugging and structured logging.
+     */
     toString() {
         return JSON.stringify(this);
     }
     /**
-     * Converts legacy Hebcal timezone to a standard Olson tzid.
+     * Converts a legacy Hebcal-style timezone (a numeric GMT offset plus a
+     * coarse DST region) to a standard IANA/Olson timezone ID.
+     *
+     * This exists to migrate data from older Hebcal versions that stored
+     * timezones as GMT offset + DST scheme rather than as a full tzid.
+     * @example
+     * Location.legacyTzToTzid(2, 'israel'); // 'Asia/Jerusalem'
+     * Location.legacyTzToTzid(0, 'eu');     // 'Europe/London'
+     * Location.legacyTzToTzid(0, 'none');   // 'UTC'
+     * Location.legacyTzToTzid(-5, 'none');  // 'Etc/GMT-5'
      * @param tz integer, GMT offset in hours
      * @param dst 'none', 'eu', 'usa', or 'israel'
      */
@@ -299,9 +318,18 @@ export class Location extends GeoLocation {
         }
     }
     /**
-     * Adds a location name for `Location.lookup()` only if the name isn't
-     * already being used. Returns `false` if the name is already taken
-     * and `true` if successfully added.
+     * Registers a new named location with the built-in `Location.lookup()`
+     * registry. Names are stored case-insensitively. Returns `false` if a
+     * location with the same (lower-cased) name is already registered, and
+     * `true` if successfully added.
+     *
+     * Use this to extend the built-in set of ~60 classic Hebcal cities with
+     * your own custom locations.
+     * @example
+     * const tlv = new Location(32.0853, 34.7818, true,
+     *   'Asia/Tel_Aviv', 'My Office, Tel Aviv', 'IL');
+     * Location.addLocation('My Office', tlv);   // true
+     * Location.lookup('my office')?.getTzid();  // 'Asia/Tel_Aviv'
      */
     static addLocation(cityName, location) {
         const name = cityName.toLowerCase();
@@ -312,7 +340,3 @@ export class Location extends GeoLocation {
         return true;
     }
 }
-for (const city of classicCities0) {
-    const location = new Location(city[2], city[3], city[1] === 'IL', city[4], city[0], city[1], undefined, city[5]);
-    Location.addLocation(city[0], location);
-}

package/dist/src/molad.d.ts

@@ -4,7 +4,20 @@ import { CalOptions } from './CalOptions';
 import { HDate } from '@hebcal/hdate';
 import './locale';
 /**
- * Represents a molad, the moment when the new moon is "born"
+ * Represents a *molad* — the calculated moment when the new moon is "born"
+ * for a given Hebrew month.
+ *
+ * The molad is announced in synagogue on Shabbat Mevarchim (the Shabbat
+ * before Rosh Chodesh) and is the anchor point for Kiddush Levana zmanim.
+ * Calculations use the traditional chalakim arithmetic
+ * (1 hour = 1080 chalakim) anchored to *Molad Tohu BaHaRaD*.
+ *
+ * @example
+ * import {Molad, months} from '@hebcal/core';
+ * const m = new Molad(5784, months.NISAN);
+ * console.log(m.getMonthName()); // 'Nisan'
+ * console.log(m.getHour(), m.getMinutes(), m.getChalakim()); // e.g. 1 31 12
+ * console.log(m.render('en')); // 'Molad Nisan: Mon, 1:31am and 12 chalakim'
  */
 export declare class Molad {
     private readonly m;
@@ -12,9 +25,9 @@ export declare class Molad {
     private readonly month;
     private instant?;
     /**
-     * Calculates the molad for a Hebrew month
-     * @param year
-     * @param month 1=NISSAN, 7=TISHREI
+     * Calculates the molad for a given Hebrew year and month.
+     * @param year Hebrew year
+     * @param month 1=NISAN, 7=TISHREI (uses Nisan-based numbering)
      */
     constructor(year: number, month: number);
     /**
@@ -56,12 +69,18 @@ export declare class Molad {
      */
     getChalakim(): number;
     /**
-     * Returns the molad in Standard Time in Yerushalayim as a Temporal.ZonedDateTime.
+     * Returns the molad in Standard Time in Yerushalayim as a `Temporal.ZonedDateTime`.
      * This method subtracts 20.94 minutes (20 minutes and 56.496 seconds) from the computed time (Har Habayis with a longitude
      * of 35.2354° is 5.2354° away from the %15 timezone longitude) to get to standard time. This method
      * intentionally uses standard time and not daylight savings time.
      *
-     * @return the Temporal.ZonedDateTime representing the moment of the molad in Yerushalayim standard time (GMT + 2)
+     * The returned value is cached after the first call.
+     * @example
+     * import {Molad, months} from '@hebcal/core';
+     * const m = new Molad(5784, months.NISAN);
+     * const zdt = m.getInstant();
+     * console.log(zdt.toString()); // e.g. '2024-04-08T17:21:13.333+00:00[UTC]'
+     * @return the `Temporal.ZonedDateTime` representing the moment of the molad
      */
     getInstant(): Temporal.ZonedDateTime;
     /**
@@ -109,8 +128,21 @@ export declare class Molad {
      */
     getSofZmanKidushLevana15Days(): Temporal.ZonedDateTime;
     /**
+     * Returns a human-readable, localized string announcing the molad —
+     * suitable for use on Shabbat Mevarchim. The format includes the Hebrew
+     * month name, day of week, hour : minute, and chalakim if non-zero.
+     *
+     * Time format honors `options.hour12` and `options.location` (12-hour vs.
+     * 24-hour); see {@link HebrewCalendar.reformatTimeStr}.
+     * @example
+     * import {Molad, months} from '@hebcal/core';
+     * const m = new Molad(5784, months.NISAN);
+     * m.render('en', {hour12: true});
+     * // => 'Molad Nisan: Mon, 7:21pm and 6 chalakim'
+     * m.render('he');
+     * // => 'מוֹלָד נִיסָן יִהְיֶה בַּיּוֹם שֵׁנִי בשָׁבוּעַ, …'
      * @param [locale] Optional locale name (defaults to empty locale)
-     * @param options
+     * @param options used for time formatting (12-hour vs 24-hour)
      */
     render(locale?: string, options?: CalOptions): string;
 }

package/dist/src/molad.js

@@ -54,7 +54,20 @@ function getHebrewTimeOfDay(hour) {
     return night;
 }
 /**
- * Represents a molad, the moment when the new moon is "born"
+ * Represents a *molad* — the calculated moment when the new moon is "born"
+ * for a given Hebrew month.
+ *
+ * The molad is announced in synagogue on Shabbat Mevarchim (the Shabbat
+ * before Rosh Chodesh) and is the anchor point for Kiddush Levana zmanim.
+ * Calculations use the traditional chalakim arithmetic
+ * (1 hour = 1080 chalakim) anchored to *Molad Tohu BaHaRaD*.
+ *
+ * @example
+ * import {Molad, months} from '@hebcal/core';
+ * const m = new Molad(5784, months.NISAN);
+ * console.log(m.getMonthName()); // 'Nisan'
+ * console.log(m.getHour(), m.getMinutes(), m.getChalakim()); // e.g. 1 31 12
+ * console.log(m.render('en')); // 'Molad Nisan: Mon, 1:31am and 12 chalakim'
  */
 export class Molad {
     m;
@@ -62,9 +75,9 @@ export class Molad {
     month;
     instant;
     /**
-     * Calculates the molad for a Hebrew month
-     * @param year
-     * @param month 1=NISSAN, 7=TISHREI
+     * Calculates the molad for a given Hebrew year and month.
+     * @param year Hebrew year
+     * @param month 1=NISAN, 7=TISHREI (uses Nisan-based numbering)
      */
     constructor(year, month) {
         this.m = calculateMolad(year, month);
@@ -126,12 +139,18 @@ export class Molad {
         return this.m.chalakim;
     }
     /**
-     * Returns the molad in Standard Time in Yerushalayim as a Temporal.ZonedDateTime.
+     * Returns the molad in Standard Time in Yerushalayim as a `Temporal.ZonedDateTime`.
      * This method subtracts 20.94 minutes (20 minutes and 56.496 seconds) from the computed time (Har Habayis with a longitude
      * of 35.2354° is 5.2354° away from the %15 timezone longitude) to get to standard time. This method
      * intentionally uses standard time and not daylight savings time.
      *
-     * @return the Temporal.ZonedDateTime representing the moment of the molad in Yerushalayim standard time (GMT + 2)
+     * The returned value is cached after the first call.
+     * @example
+     * import {Molad, months} from '@hebcal/core';
+     * const m = new Molad(5784, months.NISAN);
+     * const zdt = m.getInstant();
+     * console.log(zdt.toString()); // e.g. '2024-04-08T17:21:13.333+00:00[UTC]'
+     * @return the `Temporal.ZonedDateTime` representing the moment of the molad
      */
     getInstant() {
         this.instant ??= getMoladAsDate(this.m);
@@ -203,8 +222,21 @@ export class Molad {
         return zdt.add({ hours: 24 * 15 });
     }
     /**
+     * Returns a human-readable, localized string announcing the molad —
+     * suitable for use on Shabbat Mevarchim. The format includes the Hebrew
+     * month name, day of week, hour : minute, and chalakim if non-zero.
+     *
+     * Time format honors `options.hour12` and `options.location` (12-hour vs.
+     * 24-hour); see {@link HebrewCalendar.reformatTimeStr}.
+     * @example
+     * import {Molad, months} from '@hebcal/core';
+     * const m = new Molad(5784, months.NISAN);
+     * m.render('en', {hour12: true});
+     * // => 'Molad Nisan: Mon, 7:21pm and 6 chalakim'
+     * m.render('he');
+     * // => 'מוֹלָד נִיסָן יִהְיֶה בַּיּוֹם שֵׁנִי בשָׁבוּעַ, …'
      * @param [locale] Optional locale name (defaults to empty locale)
-     * @param options
+     * @param options used for time formatting (12-hour vs 24-hour)
      */
     render(locale, options) {
         const monthName = Locale.gettext(this.getMonthName(), locale);

package/dist/src/omer.d.ts

@@ -6,21 +6,49 @@ import './locale';
  * Lang for the Sefira can be English, Hebrew, or Hebrew in Sephardic transliteration.
  */
 export type OmerLang = 'en' | 'he' | 'translit';
-/** Represents a day 1-49 of counting the Omer from Pesach to Shavuot */
+/**
+ * Represents one of the 49 days of counting the Omer between Pesach and
+ * Shavuot (16 Nisan through 5 Sivan).
+ *
+ * Each day has an associated Sefirah pairing (e.g. *Chesed shebiGevurah*),
+ * a word from Psalm 67 (Lamnatzeach), a letter from verse 5 of Psalm 67,
+ * and a word/acrostic from the Ana BeKoach prayer — all accessible via
+ * the methods on this class.
+ *
+ * @example
+ * import {OmerEvent, HDate, months} from '@hebcal/core';
+ * const ev = new OmerEvent(new HDate(16, months.NISAN, 5784), 1);
+ * ev.render('en');        // '1st day of the Omer'
+ * ev.render('he');        // 'א׳ בָּעוֹמֶר'
+ * ev.sefira('translit');  // 'Chesed shebChesed'
+ * ev.getTodayIs('en');    // 'Today is 1 day of the Omer'
+ */
 export declare class OmerEvent extends Event {
     private readonly weekNumber;
     private readonly daysWithinWeeks;
     readonly omer: number;
     /**
-     * @param date
-     * @param omerDay
+     * Constructs an Omer event for a given day (1–49).
+     *
+     * Throws `RangeError` if `omerDay` is outside 1–49.
+     * @param date Hebrew date this Omer day is counted on (the evening of)
+     * @param omerDay day of the Omer, 1 through 49
      */
     constructor(date: HDate, omerDay: number);
     /**
-     * Returns the sefira. For example, on day 8:
+     * Returns the Sefirah pairing associated with this Omer day —
+     * one of the seven lower Sefirot within another, calculated as
+     * `day-within-week` of `week-within-cycle`. For example, on day 8
+     * (week 2, day 1):
      *  * חֶֽסֶד שֶׁבִּגְבוּרָה
      *  * Chesed shebiGevurah
      *  * Lovingkindness within Might
+     * @example
+     * import {OmerEvent, HDate, months} from '@hebcal/core';
+     * const day8 = new OmerEvent(new HDate(23, months.NISAN, 5784), 8);
+     * day8.sefira('en');        // 'Lovingkindness within Might'
+     * day8.sefira('he');        // 'חֶֽסֶד שֶׁבִּגְבוּרָה'
+     * day8.sefira('translit');  // 'Chesed shebiGevurah'
      * @param lang `en` (English), `he` (Hebrew with nikud), or `translit` (Hebrew in Sephardic transliteration)
      * @returns a string such as `Lovingkindness within Might` or `חֶֽסֶד שֶׁבִּגְבוּרָה`
      */

package/dist/src/omer.js

@@ -188,14 +188,33 @@ const anaBekoach = sefira.anaBekoach;
 const ps67lines = sefira.ps67lines;
 const lamnatzeach = ps67lines.flatMap((x) => x.split(/[ ־]/));
 const lamnatzeachLetters = sefira.lamnatzeachLetters.split('');
-/** Represents a day 1-49 of counting the Omer from Pesach to Shavuot */
+/**
+ * Represents one of the 49 days of counting the Omer between Pesach and
+ * Shavuot (16 Nisan through 5 Sivan).
+ *
+ * Each day has an associated Sefirah pairing (e.g. *Chesed shebiGevurah*),
+ * a word from Psalm 67 (Lamnatzeach), a letter from verse 5 of Psalm 67,
+ * and a word/acrostic from the Ana BeKoach prayer — all accessible via
+ * the methods on this class.
+ *
+ * @example
+ * import {OmerEvent, HDate, months} from '@hebcal/core';
+ * const ev = new OmerEvent(new HDate(16, months.NISAN, 5784), 1);
+ * ev.render('en');        // '1st day of the Omer'
+ * ev.render('he');        // 'א׳ בָּעוֹמֶר'
+ * ev.sefira('translit');  // 'Chesed shebChesed'
+ * ev.getTodayIs('en');    // 'Today is 1 day of the Omer'
+ */
 export class OmerEvent extends Event {
     weekNumber;
     daysWithinWeeks;
     omer;
     /**
-     * @param date
-     * @param omerDay
+     * Constructs an Omer event for a given day (1–49).
+     *
+     * Throws `RangeError` if `omerDay` is outside 1–49.
+     * @param date Hebrew date this Omer day is counted on (the evening of)
+     * @param omerDay day of the Omer, 1 through 49
      */
     constructor(date, omerDay) {
         super(date, `Omer ${omerDay}`, flags.OMER_COUNT);
@@ -205,10 +224,19 @@ export class OmerEvent extends Event {
         this.omer = omerDay;
     }
     /**
-     * Returns the sefira. For example, on day 8:
+     * Returns the Sefirah pairing associated with this Omer day —
+     * one of the seven lower Sefirot within another, calculated as
+     * `day-within-week` of `week-within-cycle`. For example, on day 8
+     * (week 2, day 1):
      *  * חֶֽסֶד שֶׁבִּגְבוּרָה
      *  * Chesed shebiGevurah
      *  * Lovingkindness within Might
+     * @example
+     * import {OmerEvent, HDate, months} from '@hebcal/core';
+     * const day8 = new OmerEvent(new HDate(23, months.NISAN, 5784), 8);
+     * day8.sefira('en');        // 'Lovingkindness within Might'
+     * day8.sefira('he');        // 'חֶֽסֶד שֶׁבִּגְבוּרָה'
+     * day8.sefira('translit');  // 'Chesed shebiGevurah'
      * @param lang `en` (English), `he` (Hebrew with nikud), or `translit` (Hebrew in Sephardic transliteration)
      * @returns a string such as `Lovingkindness within Might` or `חֶֽסֶד שֶׁבִּגְבוּרָה`
      */

package/dist/src/parshaYear.d.ts

@@ -1,6 +1,17 @@
 import { ParshaEvent } from './ParshaEvent';
 /**
- * Calculates weekly Torah Reading on Saturdays for entire year
+ * Calculates the weekly Torah Reading (Parashat HaShavua) on Saturdays for
+ * an entire Hebrew year.
+ *
+ * Saturdays on which a Yom Tov reading displaces the regular parsha
+ * (e.g. Shabbat Chol ha-Moed Pesach/Sukkot, Yom Kippur on Shabbat) are
+ * skipped — for those use {@link getHolidaysOnDate} or
+ * {@link Sedra.lookup}.
+ * @example
+ * import {parshaYear} from '@hebcal/core';
+ * const events = parshaYear(5784, false);
+ * events[0].render('en'); // 'Parashat Vayeilech'
+ * events[0].getDate().toString(); // '4 Tishrei 5784'
  * @param year Hebrew year
  * @param il Israel (false for Diaspora)
  * @returns an array of `ParshaEvent` occurring on Saturdays that contain a regular

package/dist/src/parshaYear.js

@@ -2,7 +2,18 @@ import { HDate, months } from '@hebcal/hdate';
 import { ParshaEvent } from './ParshaEvent';
 import { getSedra } from './sedra';
 /**
- * Calculates weekly Torah Reading on Saturdays for entire year
+ * Calculates the weekly Torah Reading (Parashat HaShavua) on Saturdays for
+ * an entire Hebrew year.
+ *
+ * Saturdays on which a Yom Tov reading displaces the regular parsha
+ * (e.g. Shabbat Chol ha-Moed Pesach/Sukkot, Yom Kippur on Shabbat) are
+ * skipped — for those use {@link getHolidaysOnDate} or
+ * {@link Sedra.lookup}.
+ * @example
+ * import {parshaYear} from '@hebcal/core';
+ * const events = parshaYear(5784, false);
+ * events[0].render('en'); // 'Parashat Vayeilech'
+ * events[0].getDate().toString(); // '4 Tishrei 5784'
  * @param year Hebrew year
  * @param il Israel (false for Diaspora)
  * @returns an array of `ParshaEvent` occurring on Saturdays that contain a regular

package/dist/src/pkgVersion.d.ts

@@ -1,2 +1,2 @@
 /** DO NOT EDIT THIS AUTO-GENERATED FILE! */
-export declare const version = "6.5.0";
+export declare const version = "6.5.2";

package/dist/src/pkgVersion.js

@@ -1,2 +1,2 @@
 /** DO NOT EDIT THIS AUTO-GENERATED FILE! */
-export const version = '6.5.0';
+export const version = '6.5.2';