@hebcal/core 6.5.1 → 6.5.2

package/dist/esm/location.js

@@ -1,6 +1,7 @@
-/*! @hebcal/core v6.5.1, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
+/*! @hebcal/core v6.5.2, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
 import { GeoLocation } from '@hebcal/noaa';
 import citiesJson from './cities.json.js';
+import QuickLRU from 'quick-lru';
 
 /*
     Hebcal - A Jewish Calendar Generator
@@ -40,7 +41,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
@@ -66,7 +69,31 @@ function initClassicCities() {
         Location.addLocation(cityName, location);
     }
 }
-/** Class representing 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');
+ */
 class Location extends GeoLocation {
     il;
     cc;
@@ -109,14 +136,31 @@ 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();
@@ -135,18 +179,37 @@ 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;
     }
@@ -166,7 +229,13 @@ 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) {
@@ -174,11 +243,24 @@ class Location extends GeoLocation {
         }
         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'
      */
@@ -236,9 +318,18 @@ 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();

package/dist/esm/location.js.map

@@ -1 +1 @@
-{"version":3,"file":"location.js","sources":["../../../src/location.ts"],"sourcesContent":["/*\n    Hebcal - A Jewish Calendar Generator\n    Copyright (c) 1994-2020 Danny Sadinoff\n    Portions copyright Eyal Schachter and Michael J. Radwin\n\n    https://github.com/hebcal/hebcal-es6\n\n    This program is free software; you can redistribute it and/or\n    modify it under the terms of the GNU General Public License\n    as published by the Free Software Foundation; either version 2\n    of the License, or (at your option) any later version.\n\n    This program is distributed in the hope that it will be useful,\n    but WITHOUT ANY WARRANTY; without even the implied warranty of\n    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n    GNU General Public License for more details.\n\n    You should have received a copy of the GNU General Public License\n    along with this program. If not, see <http://www.gnu.org/licenses/>.\n */\nimport {GeoLocation} from '@hebcal/noaa';\nimport citiesJson from './cities.json';\n\nconst classicCities = new Map<string, Location>();\n\n// Zip-Codes.com TimeZone IDs\nconst ZIPCODES_TZ_MAP: Record<string, string> = {\n  '0': 'UTC',\n  '4': 'America/Puerto_Rico', // Atlantic (GMT -04:00)\n  '5': 'America/New_York', //    Eastern  (GMT -05:00)\n  '6': 'America/Chicago', //     Central  (GMT -06:00)\n  '7': 'America/Denver', //      Mountain (GMT -07:00)\n  '8': 'America/Los_Angeles', // Pacific  (GMT -08:00)\n  '9': 'America/Anchorage', //   Alaska   (GMT -09:00)\n  '10': 'Pacific/Honolulu', //   Hawaii-Aleutian Islands (GMT -10:00)\n  '11': 'Pacific/Pago_Pago', //  American Samoa (GMT -11:00)\n  '13': 'Pacific/Funafuti', //   Marshall Islands (GMT +12:00)\n  '14': 'Pacific/Guam', //       Guam     (GMT +10:00)\n  '15': 'Pacific/Palau', //      Palau    (GMT +9:00)\n  '16': 'Pacific/Chuuk', //      Micronesia (GMT +11:00)\n} as const;\n\n/** @private */\nconst timeFormatCache = new Map<string, Intl.DateTimeFormat>();\n\n/**\n * Gets a 24-hour time formatter (e.g. 07:41 or 20:03) from cache\n * or makes a new one if needed\n * @private\n */\nfunction getFormatter(tzid: string): Intl.DateTimeFormat {\n  const fmt = timeFormatCache.get(tzid);\n  if (fmt) return fmt;\n  const f = new Intl.DateTimeFormat('en-US', {\n    timeZone: tzid,\n    hour: 'numeric',\n    minute: 'numeric',\n    hour12: false,\n  });\n  timeFormatCache.set(tzid, f);\n  return f;\n}\n\nfunction initClassicCities() {\n  for (const entry of citiesJson) {\n    const [cityName, cc, lat, lng, tzid, elev] = entry.split('|');\n    const location = new Location(\n      +lat,\n      +lng,\n      cc === 'IL',\n      tzid,\n      cityName,\n      cc,\n      undefined,\n      +elev\n    );\n    Location.addLocation(cityName, location);\n  }\n}\n\n/** Class representing Location */\nexport class Location extends GeoLocation {\n  private readonly il: boolean;\n  private readonly cc?: string;\n  private readonly geoid?: string | number;\n  admin1?: string;\n  stateName?: string;\n  geo?: 'zip' | 'geoname';\n  zip?: string;\n  population?: number;\n  asciiname?: string;\n\n  /**\n   * Initialize a Location instance\n   * @param latitude - Latitude as a decimal, valid range -90 thru +90 (e.g. 41.85003)\n   * @param longitude - Longitude as a decimal, valid range -180 thru +180 (e.g. -87.65005)\n   * @param il - in Israel (true) or Diaspora (false)\n   * @param tzid - Olson timezone ID, e.g. \"America/Chicago\"\n   * @param [cityName] - optional descriptive city name\n   * @param [countryCode] - ISO 3166 alpha-2 country code (e.g. \"FR\")\n   * @param [geoid] - optional string or numeric geographic ID\n   * @param [elevation] - in meters (default `0`)\n   */\n  constructor(\n    latitude: number,\n    longitude: number,\n    il: boolean,\n    tzid: string,\n    cityName?: string,\n    countryCode?: string,\n    geoid?: string | number,\n    elevation?: number\n  ) {\n    const lat = typeof latitude === 'number' ? latitude : parseFloat(latitude);\n    if (isNaN(lat) || lat < -90 || lat > 90) {\n      throw new RangeError(`Latitude ${latitude} out of range [-90,90]`);\n    }\n    const long =\n      typeof longitude === 'number' ? longitude : parseFloat(longitude);\n    if (isNaN(long) || long < -180 || long > 180) {\n      throw new RangeError(`Longitude ${longitude} out of range [-180,180]`);\n    }\n    if (!tzid) {\n      throw new RangeError('Invalid timezone');\n    }\n    const elev = typeof elevation === 'number' && elevation > 0 ? elevation : 0;\n    if (cityName && typeof cityName !== 'string') {\n      cityName = String(cityName);\n    }\n    super(cityName || null, lat, long, elev, tzid);\n    this.il = Boolean(il);\n    this.cc = countryCode;\n    this.geoid = geoid;\n  }\n\n  getIsrael(): boolean {\n    return this.il;\n  }\n\n  getName(): string | null {\n    return this.getLocationName();\n  }\n\n  /**\n   * Returns the location name, up to the first comma\n   */\n  getShortName(): string | null {\n    const name = this.getLocationName();\n    if (!name) return name;\n    const comma = name.indexOf(', ');\n    if (comma === -1) return name;\n    if (this.cc === 'US' && name[comma + 2] === 'D') {\n      if (name[comma + 3] === 'C') {\n        return name.substring(0, comma + 4);\n      } else if (name[comma + 3] === '.' && name[comma + 4] === 'C') {\n        return name.substring(0, comma + 6);\n      }\n    }\n    return name.substring(0, comma);\n  }\n\n  getCountryCode(): string | undefined {\n    return this.cc;\n  }\n\n  getTzid(): string {\n    return this.getTimeZone();\n  }\n\n  /**\n   * Gets a 24-hour time formatter (e.g. 07:41 or 20:03) for this location\n   */\n  getTimeFormatter(): Intl.DateTimeFormat {\n    return getFormatter(this.getTimeZone());\n  }\n\n  getGeoId(): string | number | undefined {\n    return this.geoid;\n  }\n\n  /**\n   * Creates a location object from one of 60 \"classic\" Hebcal city names.\n   * The following city names are supported:\n   * 'Ashdod', 'Atlanta', 'Austin', 'Baghdad', 'Beer Sheva',\n   * 'Berlin', 'Baltimore', 'Bogota', 'Boston', 'Budapest',\n   * 'Buenos Aires', 'Buffalo', 'Chicago', 'Cincinnati', 'Cleveland',\n   * 'Dallas', 'Denver', 'Detroit', 'Eilat', 'Gibraltar', 'Haifa',\n   * 'Hawaii', 'Helsinki', 'Houston', 'Jerusalem', 'Johannesburg',\n   * 'Kiev', 'La Paz', 'Livingston', 'Las Vegas', 'London', 'Los Angeles',\n   * 'Marseilles', 'Miami', 'Minneapolis', 'Melbourne', 'Mexico City',\n   * 'Montreal', 'Moscow', 'New York', 'Omaha', 'Ottawa', 'Panama City',\n   * 'Paris', 'Pawtucket', 'Petach Tikvah', 'Philadelphia', 'Phoenix',\n   * 'Pittsburgh', 'Providence', 'Portland', 'Saint Louis', 'Saint Petersburg',\n   * 'San Diego', 'San Francisco', 'Sao Paulo', 'Seattle', 'Sydney',\n   * 'Tel Aviv', 'Tiberias', 'Toronto', 'Vancouver', 'White Plains',\n   * 'Washington DC', 'Worcester'\n   * @param name\n   */\n  static lookup(name: string): Location | undefined {\n    if (classicCities.size === 0) {\n      initClassicCities();\n    }\n    return classicCities.get(name.toLowerCase());\n  }\n\n  toString(): string {\n    return JSON.stringify(this);\n  }\n\n  /**\n   * Converts legacy Hebcal timezone to a standard Olson tzid.\n   * @param tz integer, GMT offset in hours\n   * @param dst 'none', 'eu', 'usa', or 'israel'\n   */\n  static legacyTzToTzid(tz: number, dst: string): string | undefined {\n    tz = +tz;\n    if (dst === 'none') {\n      if (tz === 0) {\n        return 'UTC';\n      } else {\n        const plus = tz > 0 ? '+' : '';\n        return `Etc/GMT${plus}${tz}`;\n      }\n    } else if (tz === 2 && dst === 'israel') {\n      return 'Asia/Jerusalem';\n    } else if (dst === 'eu') {\n      switch (tz) {\n        case -2:\n          return 'Atlantic/Cape_Verde';\n        case -1:\n          return 'Atlantic/Azores';\n        case 0:\n          return 'Europe/London';\n        case 1:\n          return 'Europe/Paris';\n        case 2:\n          return 'Europe/Athens';\n        default:\n          break;\n      }\n    } else if (dst === 'usa') {\n      return ZIPCODES_TZ_MAP[String(tz * -1)];\n    }\n    return undefined;\n  }\n\n  /**\n   * Converts timezone info from Zip-Codes.com to a standard Olson tzid.\n   * @example\n   * Location.getUsaTzid('AZ', 7, 'Y') // 'America/Denver'\n   * @param state two-letter all-caps US state abbreviation like 'CA'\n   * @param tz positive number, 5=America/New_York, 8=America/Los_Angeles\n   * @param dst single char 'Y' or 'N'\n   */\n  static getUsaTzid(state: string, tz: number, dst: string): string {\n    tz = +tz;\n    if (tz === 10 && state === 'AK') {\n      return 'America/Adak';\n    } else if (tz === 7 && state === 'AZ') {\n      return dst === 'Y' ? 'America/Denver' : 'America/Phoenix';\n    } else {\n      return ZIPCODES_TZ_MAP[tz];\n    }\n  }\n\n  /**\n   * Adds a location name for `Location.lookup()` only if the name isn't\n   * already being used. Returns `false` if the name is already taken\n   * and `true` if successfully added.\n   */\n  static addLocation(cityName: string, location: Location): boolean {\n    const name = cityName.toLowerCase();\n    if (classicCities.has(name)) {\n      return false;\n    }\n    classicCities.set(name, location);\n    return true;\n  }\n}\n"],"names":[],"mappings":";;;;AAAA;;;;;;;;;;;;;;;;;;;AAmBG;AAIH,MAAM,aAAa,GAAG,IAAI,GAAG,EAAoB;AAEjD;AACA,MAAM,eAAe,GAA2B;AAC9C,IAAA,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,qBAAqB;IAC1B,GAAG,EAAE,kBAAkB;IACvB,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,gBAAgB;IACrB,GAAG,EAAE,qBAAqB;IAC1B,GAAG,EAAE,mBAAmB;IACxB,IAAI,EAAE,kBAAkB;IACxB,IAAI,EAAE,mBAAmB;IACzB,IAAI,EAAE,kBAAkB;IACxB,IAAI,EAAE,cAAc;IACpB,IAAI,EAAE,eAAe;IACrB,IAAI,EAAE,eAAe;CACb;AAEV;AACA,MAAM,eAAe,GAAG,IAAI,GAAG,EAA+B;AAE9D;;;;AAIG;AACH,SAAS,YAAY,CAAC,IAAY,EAAA;IAChC,MAAM,GAAG,GAAG,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC;AACrC,IAAA,IAAI,GAAG;AAAE,QAAA,OAAO,GAAG;IACnB,MAAM,CAAC,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE;AACzC,QAAA,QAAQ,EAAE,IAAI;AACd,QAAA,IAAI,EAAE,SAAS;AACf,QAAA,MAAM,EAAE,SAAS;AACjB,QAAA,MAAM,EAAE,KAAK;AACd,KAAA,CAAC;AACF,IAAA,eAAe,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;AAC5B,IAAA,OAAO,CAAC;AACV;AAEA,SAAS,iBAAiB,GAAA;AACxB,IAAA,KAAK,MAAM,KAAK,IAAI,UAAU,EAAE;QAC9B,MAAM,CAAC,QAAQ,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC;QAC7D,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAC3B,CAAC,GAAG,EACJ,CAAC,GAAG,EACJ,EAAE,KAAK,IAAI,EACX,IAAI,EACJ,QAAQ,EACR,EAAE,EACF,SAAS,EACT,CAAC,IAAI,CACN;AACD,QAAA,QAAQ,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC1C;AACF;AAEA;AACM,MAAO,QAAS,SAAQ,WAAW,CAAA;AACtB,IAAA,EAAE;AACF,IAAA,EAAE;AACF,IAAA,KAAK;AACtB,IAAA,MAAM;AACN,IAAA,SAAS;AACT,IAAA,GAAG;AACH,IAAA,GAAG;AACH,IAAA,UAAU;AACV,IAAA,SAAS;AAET;;;;;;;;;;AAUG;AACH,IAAA,WAAA,CACE,QAAgB,EAChB,SAAiB,EACjB,EAAW,EACX,IAAY,EACZ,QAAiB,EACjB,WAAoB,EACpB,KAAuB,EACvB,SAAkB,EAAA;AAElB,QAAA,MAAM,GAAG,GAAG,OAAO,QAAQ,KAAK,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;AAC1E,QAAA,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,EAAE,EAAE;AACvC,YAAA,MAAM,IAAI,UAAU,CAAC,YAAY,QAAQ,CAAA,sBAAA,CAAwB,CAAC;QACpE;AACA,QAAA,MAAM,IAAI,GACR,OAAO,SAAS,KAAK,QAAQ,GAAG,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;AACnE,QAAA,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,IAAI,IAAI,IAAI,GAAG,GAAG,EAAE;AAC5C,YAAA,MAAM,IAAI,UAAU,CAAC,aAAa,SAAS,CAAA,wBAAA,CAA0B,CAAC;QACxE;QACA,IAAI,CAAC,IAAI,EAAE;AACT,YAAA,MAAM,IAAI,UAAU,CAAC,kBAAkB,CAAC;QAC1C;AACA,QAAA,MAAM,IAAI,GAAG,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,GAAG,CAAC,GAAG,SAAS,GAAG,CAAC;AAC3E,QAAA,IAAI,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;AAC5C,YAAA,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAC7B;AACA,QAAA,KAAK,CAAC,QAAQ,IAAI,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC;AAC9C,QAAA,IAAI,CAAC,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC;AACrB,QAAA,IAAI,CAAC,EAAE,GAAG,WAAW;AACrB,QAAA,IAAI,CAAC,KAAK,GAAG,KAAK;IACpB;IAEA,SAAS,GAAA;QACP,OAAO,IAAI,CAAC,EAAE;IAChB;IAEA,OAAO,GAAA;AACL,QAAA,OAAO,IAAI,CAAC,eAAe,EAAE;IAC/B;AAEA;;AAEG;IACH,YAAY,GAAA;AACV,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,EAAE;AACnC,QAAA,IAAI,CAAC,IAAI;AAAE,YAAA,OAAO,IAAI;QACtB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QAChC,IAAI,KAAK,KAAK,EAAE;AAAE,YAAA,OAAO,IAAI;AAC7B,QAAA,IAAI,IAAI,CAAC,EAAE,KAAK,IAAI,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;YAC/C,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;gBAC3B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC;YACrC;AAAO,iBAAA,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;gBAC7D,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC;YACrC;QACF;QACA,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC;IACjC;IAEA,cAAc,GAAA;QACZ,OAAO,IAAI,CAAC,EAAE;IAChB;IAEA,OAAO,GAAA;AACL,QAAA,OAAO,IAAI,CAAC,WAAW,EAAE;IAC3B;AAEA;;AAEG;IACH,gBAAgB,GAAA;AACd,QAAA,OAAO,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;IACzC;IAEA,QAAQ,GAAA;QACN,OAAO,IAAI,CAAC,KAAK;IACnB;AAEA;;;;;;;;;;;;;;;;;AAiBG;IACH,OAAO,MAAM,CAAC,IAAY,EAAA;AACxB,QAAA,IAAI,aAAa,CAAC,IAAI,KAAK,CAAC,EAAE;AAC5B,YAAA,iBAAiB,EAAE;QACrB;QACA,OAAO,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;IAC9C;IAEA,QAAQ,GAAA;AACN,QAAA,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;IAC7B;AAEA;;;;AAIG;AACH,IAAA,OAAO,cAAc,CAAC,EAAU,EAAE,GAAW,EAAA;QAC3C,EAAE,GAAG,CAAC,EAAE;AACR,QAAA,IAAI,GAAG,KAAK,MAAM,EAAE;AAClB,YAAA,IAAI,EAAE,KAAK,CAAC,EAAE;AACZ,gBAAA,OAAO,KAAK;YACd;iBAAO;AACL,gBAAA,MAAM,IAAI,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE;AAC9B,gBAAA,OAAO,CAAA,OAAA,EAAU,IAAI,CAAA,EAAG,EAAE,EAAE;YAC9B;QACF;aAAO,IAAI,EAAE,KAAK,CAAC,IAAI,GAAG,KAAK,QAAQ,EAAE;AACvC,YAAA,OAAO,gBAAgB;QACzB;AAAO,aAAA,IAAI,GAAG,KAAK,IAAI,EAAE;YACvB,QAAQ,EAAE;AACR,gBAAA,KAAK,EAAE;AACL,oBAAA,OAAO,qBAAqB;AAC9B,gBAAA,KAAK,EAAE;AACL,oBAAA,OAAO,iBAAiB;AAC1B,gBAAA,KAAK,CAAC;AACJ,oBAAA,OAAO,eAAe;AACxB,gBAAA,KAAK,CAAC;AACJ,oBAAA,OAAO,cAAc;AACvB,gBAAA,KAAK,CAAC;AACJ,oBAAA,OAAO,eAAe;;QAI5B;AAAO,aAAA,IAAI,GAAG,KAAK,KAAK,EAAE;YACxB,OAAO,eAAe,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;QACzC;AACA,QAAA,OAAO,SAAS;IAClB;AAEA;;;;;;;AAOG;AACH,IAAA,OAAO,UAAU,CAAC,KAAa,EAAE,EAAU,EAAE,GAAW,EAAA;QACtD,EAAE,GAAG,CAAC,EAAE;QACR,IAAI,EAAE,KAAK,EAAE,IAAI,KAAK,KAAK,IAAI,EAAE;AAC/B,YAAA,OAAO,cAAc;QACvB;aAAO,IAAI,EAAE,KAAK,CAAC,IAAI,KAAK,KAAK,IAAI,EAAE;YACrC,OAAO,GAAG,KAAK,GAAG,GAAG,gBAAgB,GAAG,iBAAiB;QAC3D;aAAO;AACL,YAAA,OAAO,eAAe,CAAC,EAAE,CAAC;QAC5B;IACF;AAEA;;;;AAIG;AACH,IAAA,OAAO,WAAW,CAAC,QAAgB,EAAE,QAAkB,EAAA;AACrD,QAAA,MAAM,IAAI,GAAG,QAAQ,CAAC,WAAW,EAAE;AACnC,QAAA,IAAI,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;AAC3B,YAAA,OAAO,KAAK;QACd;AACA,QAAA,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC;AACjC,QAAA,OAAO,IAAI;IACb;AACD;;;;"}
+{"version":3,"file":"location.js","sources":["../../../src/location.ts"],"sourcesContent":["/*\n    Hebcal - A Jewish Calendar Generator\n    Copyright (c) 1994-2020 Danny Sadinoff\n    Portions copyright Eyal Schachter and Michael J. Radwin\n\n    https://github.com/hebcal/hebcal-es6\n\n    This program is free software; you can redistribute it and/or\n    modify it under the terms of the GNU General Public License\n    as published by the Free Software Foundation; either version 2\n    of the License, or (at your option) any later version.\n\n    This program is distributed in the hope that it will be useful,\n    but WITHOUT ANY WARRANTY; without even the implied warranty of\n    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n    GNU General Public License for more details.\n\n    You should have received a copy of the GNU General Public License\n    along with this program. If not, see <http://www.gnu.org/licenses/>.\n */\nimport {GeoLocation} from '@hebcal/noaa';\nimport citiesJson from './cities.json';\nimport QuickLRU from 'quick-lru';\n\nconst classicCities = new Map<string, Location>();\n\n// Zip-Codes.com TimeZone IDs\nconst ZIPCODES_TZ_MAP: Record<string, string> = {\n  '0': 'UTC',\n  '4': 'America/Puerto_Rico', // Atlantic (GMT -04:00)\n  '5': 'America/New_York', //    Eastern  (GMT -05:00)\n  '6': 'America/Chicago', //     Central  (GMT -06:00)\n  '7': 'America/Denver', //      Mountain (GMT -07:00)\n  '8': 'America/Los_Angeles', // Pacific  (GMT -08:00)\n  '9': 'America/Anchorage', //   Alaska   (GMT -09:00)\n  '10': 'Pacific/Honolulu', //   Hawaii-Aleutian Islands (GMT -10:00)\n  '11': 'Pacific/Pago_Pago', //  American Samoa (GMT -11:00)\n  '13': 'Pacific/Funafuti', //   Marshall Islands (GMT +12:00)\n  '14': 'Pacific/Guam', //       Guam     (GMT +10:00)\n  '15': 'Pacific/Palau', //      Palau    (GMT +9:00)\n  '16': 'Pacific/Chuuk', //      Micronesia (GMT +11:00)\n} as const;\n\n/** @private */\nconst timeFormatCache = new QuickLRU<string, Intl.DateTimeFormat>({\n  maxSize: 120,\n});\n\n/**\n * Gets a 24-hour time formatter (e.g. 07:41 or 20:03) from cache\n * or makes a new one if needed\n * @private\n */\nfunction getFormatter(tzid: string): Intl.DateTimeFormat {\n  const fmt = timeFormatCache.get(tzid);\n  if (fmt) return fmt;\n  const f = new Intl.DateTimeFormat('en-US', {\n    timeZone: tzid,\n    hour: 'numeric',\n    minute: 'numeric',\n    hour12: false,\n  });\n  timeFormatCache.set(tzid, f);\n  return f;\n}\n\nfunction initClassicCities() {\n  for (const entry of citiesJson) {\n    const [cityName, cc, lat, lng, tzid, elev] = entry.split('|');\n    const location = new Location(\n      +lat,\n      +lng,\n      cc === 'IL',\n      tzid,\n      cityName,\n      cc,\n      undefined,\n      +elev\n    );\n    Location.addLocation(cityName, location);\n  }\n}\n\n/**\n * Class representing a geographic location for use with candle-lighting,\n * havdalah, and zmanim calculations.\n *\n * Extends {@link GeoLocation} from `@hebcal/noaa` with Jewish-calendar\n * specific data: an Israel/Diaspora flag, ISO country code, and an optional\n * geographic identifier. Also provides {@link Location.lookup} for ~60\n * built-in \"classic\" Hebcal cities.\n *\n * @example\n * import {Location} from '@hebcal/core';\n *\n * // Create a location for a custom address\n * const loc = new Location(\n *   41.85003,    // latitude\n *   -87.65005,   // longitude\n *   false,       // not in Israel\n *   'America/Chicago',\n *   'Chicago, Illinois, USA',\n *   'US'\n * );\n *\n * // Or look up a built-in classic city\n * const tlv = Location.lookup('Tel Aviv');\n */\nexport class Location extends GeoLocation {\n  private readonly il: boolean;\n  private readonly cc?: string;\n  private readonly geoid?: string | number;\n  admin1?: string;\n  stateName?: string;\n  geo?: 'zip' | 'geoname';\n  zip?: string;\n  population?: number;\n  asciiname?: string;\n\n  /**\n   * Initialize a Location instance\n   * @param latitude - Latitude as a decimal, valid range -90 thru +90 (e.g. 41.85003)\n   * @param longitude - Longitude as a decimal, valid range -180 thru +180 (e.g. -87.65005)\n   * @param il - in Israel (true) or Diaspora (false)\n   * @param tzid - Olson timezone ID, e.g. \"America/Chicago\"\n   * @param [cityName] - optional descriptive city name\n   * @param [countryCode] - ISO 3166 alpha-2 country code (e.g. \"FR\")\n   * @param [geoid] - optional string or numeric geographic ID\n   * @param [elevation] - in meters (default `0`)\n   */\n  constructor(\n    latitude: number,\n    longitude: number,\n    il: boolean,\n    tzid: string,\n    cityName?: string,\n    countryCode?: string,\n    geoid?: string | number,\n    elevation?: number\n  ) {\n    const lat = typeof latitude === 'number' ? latitude : parseFloat(latitude);\n    if (isNaN(lat) || lat < -90 || lat > 90) {\n      throw new RangeError(`Latitude ${latitude} out of range [-90,90]`);\n    }\n    const long =\n      typeof longitude === 'number' ? longitude : parseFloat(longitude);\n    if (isNaN(long) || long < -180 || long > 180) {\n      throw new RangeError(`Longitude ${longitude} out of range [-180,180]`);\n    }\n    if (!tzid) {\n      throw new RangeError('Invalid timezone');\n    }\n    const elev = typeof elevation === 'number' && elevation > 0 ? elevation : 0;\n    if (cityName && typeof cityName !== 'string') {\n      cityName = String(cityName);\n    }\n    super(cityName || null, lat, long, elev, tzid);\n    this.il = Boolean(il);\n    this.cc = countryCode;\n    this.geoid = geoid;\n  }\n\n  /**\n   * Returns `true` if this location is in Israel (uses the Israeli holiday\n   * and Torah-reading schedule), `false` for the Diaspora.\n   */\n  getIsrael(): boolean {\n    return this.il;\n  }\n\n  /**\n   * Returns the full descriptive location name passed to the constructor,\n   * or `null` if no name was provided.\n   * @example\n   * Location.lookup('San Francisco')?.getName(); // 'San Francisco, California, USA'\n   */\n  getName(): string | null {\n    return this.getLocationName();\n  }\n\n  /**\n   * Returns the location name truncated at the first comma. Useful for\n   * compact display where only the city name is desired.\n   *\n   * Special-cased so that US locations of the form `\"Washington, DC\"` or\n   * `\"Washington, D.C., ...\"` keep the `DC` / `D.C.` suffix attached.\n   * @example\n   * Location.lookup('San Francisco')?.getShortName(); // 'San Francisco'\n   * Location.lookup('Washington DC')?.getShortName(); // 'Washington, DC'\n   */\n  getShortName(): string | null {\n    const name = this.getLocationName();\n    if (!name) return name;\n    const comma = name.indexOf(', ');\n    if (comma === -1) return name;\n    if (this.cc === 'US' && name[comma + 2] === 'D') {\n      if (name[comma + 3] === 'C') {\n        return name.substring(0, comma + 4);\n      } else if (name[comma + 3] === '.' && name[comma + 4] === 'C') {\n        return name.substring(0, comma + 6);\n      }\n    }\n    return name.substring(0, comma);\n  }\n\n  /**\n   * Returns the ISO 3166 alpha-2 country code (e.g. `\"US\"`, `\"IL\"`, `\"FR\"`)\n   * passed to the constructor, or `undefined` if none was provided.\n   */\n  getCountryCode(): string | undefined {\n    return this.cc;\n  }\n\n  /**\n   * Returns the Olson timezone identifier (e.g. `\"America/Chicago\"`).\n   * Alias for `getTimeZone()` from the parent `GeoLocation` class.\n   */\n  getTzid(): string {\n    return this.getTimeZone();\n  }\n\n  /**\n   * Returns a cached 24-hour `Intl.DateTimeFormat` (e.g. `07:41` or `20:03`)\n   * configured for this location's timezone. Formatters are memoized by\n   * timezone so repeated calls do not allocate.\n   * @example\n   * const loc = Location.lookup('Tel Aviv')!;\n   * const fmt = loc.getTimeFormatter();\n   * fmt.format(new Date()); // e.g. '18:42'\n   */\n  getTimeFormatter(): Intl.DateTimeFormat {\n    return getFormatter(this.getTimeZone());\n  }\n\n  /**\n   * Returns the optional geographic identifier passed to the constructor\n   * (typically a GeoNames numeric ID or a US Zip Code string), or\n   * `undefined` if none was provided.\n   */\n  getGeoId(): string | number | undefined {\n    return this.geoid;\n  }\n\n  /**\n   * Creates a location object from one of 60 \"classic\" Hebcal city names.\n   * The following city names are supported:\n   * 'Ashdod', 'Atlanta', 'Austin', 'Baghdad', 'Beer Sheva',\n   * 'Berlin', 'Baltimore', 'Bogota', 'Boston', 'Budapest',\n   * 'Buenos Aires', 'Buffalo', 'Chicago', 'Cincinnati', 'Cleveland',\n   * 'Dallas', 'Denver', 'Detroit', 'Eilat', 'Gibraltar', 'Haifa',\n   * 'Hawaii', 'Helsinki', 'Houston', 'Jerusalem', 'Johannesburg',\n   * 'Kiev', 'La Paz', 'Livingston', 'Las Vegas', 'London', 'Los Angeles',\n   * 'Marseilles', 'Miami', 'Minneapolis', 'Melbourne', 'Mexico City',\n   * 'Montreal', 'Moscow', 'New York', 'Omaha', 'Ottawa', 'Panama City',\n   * 'Paris', 'Pawtucket', 'Petach Tikvah', 'Philadelphia', 'Phoenix',\n   * 'Pittsburgh', 'Providence', 'Portland', 'Saint Louis', 'Saint Petersburg',\n   * 'San Diego', 'San Francisco', 'Sao Paulo', 'Seattle', 'Sydney',\n   * 'Tel Aviv', 'Tiberias', 'Toronto', 'Vancouver', 'White Plains',\n   * 'Washington DC', 'Worcester'\n   *\n   * Lookups are case-insensitive. Returns `undefined` if the name is not\n   * recognized. The list can be extended with {@link Location.addLocation}.\n   * @example\n   * const loc = Location.lookup('San Francisco');\n   * console.log(loc?.getTzid()); // 'America/Los_Angeles'\n   * @param name case-insensitive classic city name\n   */\n  static lookup(name: string): Location | undefined {\n    if (classicCities.size === 0) {\n      initClassicCities();\n    }\n    return classicCities.get(name.toLowerCase());\n  }\n\n  /**\n   * Returns a JSON-serialized representation of this Location.\n   * Useful for debugging and structured logging.\n   */\n  toString(): string {\n    return JSON.stringify(this);\n  }\n\n  /**\n   * Converts a legacy Hebcal-style timezone (a numeric GMT offset plus a\n   * coarse DST region) to a standard IANA/Olson timezone ID.\n   *\n   * This exists to migrate data from older Hebcal versions that stored\n   * timezones as GMT offset + DST scheme rather than as a full tzid.\n   * @example\n   * Location.legacyTzToTzid(2, 'israel'); // 'Asia/Jerusalem'\n   * Location.legacyTzToTzid(0, 'eu');     // 'Europe/London'\n   * Location.legacyTzToTzid(0, 'none');   // 'UTC'\n   * Location.legacyTzToTzid(-5, 'none');  // 'Etc/GMT-5'\n   * @param tz integer, GMT offset in hours\n   * @param dst 'none', 'eu', 'usa', or 'israel'\n   */\n  static legacyTzToTzid(tz: number, dst: string): string | undefined {\n    tz = +tz;\n    if (dst === 'none') {\n      if (tz === 0) {\n        return 'UTC';\n      } else {\n        const plus = tz > 0 ? '+' : '';\n        return `Etc/GMT${plus}${tz}`;\n      }\n    } else if (tz === 2 && dst === 'israel') {\n      return 'Asia/Jerusalem';\n    } else if (dst === 'eu') {\n      switch (tz) {\n        case -2:\n          return 'Atlantic/Cape_Verde';\n        case -1:\n          return 'Atlantic/Azores';\n        case 0:\n          return 'Europe/London';\n        case 1:\n          return 'Europe/Paris';\n        case 2:\n          return 'Europe/Athens';\n        default:\n          break;\n      }\n    } else if (dst === 'usa') {\n      return ZIPCODES_TZ_MAP[String(tz * -1)];\n    }\n    return undefined;\n  }\n\n  /**\n   * Converts timezone info from Zip-Codes.com to a standard Olson tzid.\n   * @example\n   * Location.getUsaTzid('AZ', 7, 'Y') // 'America/Denver'\n   * @param state two-letter all-caps US state abbreviation like 'CA'\n   * @param tz positive number, 5=America/New_York, 8=America/Los_Angeles\n   * @param dst single char 'Y' or 'N'\n   */\n  static getUsaTzid(state: string, tz: number, dst: string): string {\n    tz = +tz;\n    if (tz === 10 && state === 'AK') {\n      return 'America/Adak';\n    } else if (tz === 7 && state === 'AZ') {\n      return dst === 'Y' ? 'America/Denver' : 'America/Phoenix';\n    } else {\n      return ZIPCODES_TZ_MAP[tz];\n    }\n  }\n\n  /**\n   * Registers a new named location with the built-in `Location.lookup()`\n   * registry. Names are stored case-insensitively. Returns `false` if a\n   * location with the same (lower-cased) name is already registered, and\n   * `true` if successfully added.\n   *\n   * Use this to extend the built-in set of ~60 classic Hebcal cities with\n   * your own custom locations.\n   * @example\n   * const tlv = new Location(32.0853, 34.7818, true,\n   *   'Asia/Tel_Aviv', 'My Office, Tel Aviv', 'IL');\n   * Location.addLocation('My Office', tlv);   // true\n   * Location.lookup('my office')?.getTzid();  // 'Asia/Tel_Aviv'\n   */\n  static addLocation(cityName: string, location: Location): boolean {\n    const name = cityName.toLowerCase();\n    if (classicCities.has(name)) {\n      return false;\n    }\n    classicCities.set(name, location);\n    return true;\n  }\n}\n"],"names":[],"mappings":";;;;;AAAA;;;;;;;;;;;;;;;;;;;AAmBG;AAKH,MAAM,aAAa,GAAG,IAAI,GAAG,EAAoB;AAEjD;AACA,MAAM,eAAe,GAA2B;AAC9C,IAAA,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,qBAAqB;IAC1B,GAAG,EAAE,kBAAkB;IACvB,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,gBAAgB;IACrB,GAAG,EAAE,qBAAqB;IAC1B,GAAG,EAAE,mBAAmB;IACxB,IAAI,EAAE,kBAAkB;IACxB,IAAI,EAAE,mBAAmB;IACzB,IAAI,EAAE,kBAAkB;IACxB,IAAI,EAAE,cAAc;IACpB,IAAI,EAAE,eAAe;IACrB,IAAI,EAAE,eAAe;CACb;AAEV;AACA,MAAM,eAAe,GAAG,IAAI,QAAQ,CAA8B;AAChE,IAAA,OAAO,EAAE,GAAG;AACb,CAAA,CAAC;AAEF;;;;AAIG;AACH,SAAS,YAAY,CAAC,IAAY,EAAA;IAChC,MAAM,GAAG,GAAG,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC;AACrC,IAAA,IAAI,GAAG;AAAE,QAAA,OAAO,GAAG;IACnB,MAAM,CAAC,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE;AACzC,QAAA,QAAQ,EAAE,IAAI;AACd,QAAA,IAAI,EAAE,SAAS;AACf,QAAA,MAAM,EAAE,SAAS;AACjB,QAAA,MAAM,EAAE,KAAK;AACd,KAAA,CAAC;AACF,IAAA,eAAe,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;AAC5B,IAAA,OAAO,CAAC;AACV;AAEA,SAAS,iBAAiB,GAAA;AACxB,IAAA,KAAK,MAAM,KAAK,IAAI,UAAU,EAAE;QAC9B,MAAM,CAAC,QAAQ,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC;QAC7D,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAC3B,CAAC,GAAG,EACJ,CAAC,GAAG,EACJ,EAAE,KAAK,IAAI,EACX,IAAI,EACJ,QAAQ,EACR,EAAE,EACF,SAAS,EACT,CAAC,IAAI,CACN;AACD,QAAA,QAAQ,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC1C;AACF;AAEA;;;;;;;;;;;;;;;;;;;;;;;;AAwBG;AACG,MAAO,QAAS,SAAQ,WAAW,CAAA;AACtB,IAAA,EAAE;AACF,IAAA,EAAE;AACF,IAAA,KAAK;AACtB,IAAA,MAAM;AACN,IAAA,SAAS;AACT,IAAA,GAAG;AACH,IAAA,GAAG;AACH,IAAA,UAAU;AACV,IAAA,SAAS;AAET;;;;;;;;;;AAUG;AACH,IAAA,WAAA,CACE,QAAgB,EAChB,SAAiB,EACjB,EAAW,EACX,IAAY,EACZ,QAAiB,EACjB,WAAoB,EACpB,KAAuB,EACvB,SAAkB,EAAA;AAElB,QAAA,MAAM,GAAG,GAAG,OAAO,QAAQ,KAAK,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;AAC1E,QAAA,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,EAAE,EAAE;AACvC,YAAA,MAAM,IAAI,UAAU,CAAC,YAAY,QAAQ,CAAA,sBAAA,CAAwB,CAAC;QACpE;AACA,QAAA,MAAM,IAAI,GACR,OAAO,SAAS,KAAK,QAAQ,GAAG,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;AACnE,QAAA,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,IAAI,IAAI,IAAI,GAAG,GAAG,EAAE;AAC5C,YAAA,MAAM,IAAI,UAAU,CAAC,aAAa,SAAS,CAAA,wBAAA,CAA0B,CAAC;QACxE;QACA,IAAI,CAAC,IAAI,EAAE;AACT,YAAA,MAAM,IAAI,UAAU,CAAC,kBAAkB,CAAC;QAC1C;AACA,QAAA,MAAM,IAAI,GAAG,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,GAAG,CAAC,GAAG,SAAS,GAAG,CAAC;AAC3E,QAAA,IAAI,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;AAC5C,YAAA,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAC7B;AACA,QAAA,KAAK,CAAC,QAAQ,IAAI,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC;AAC9C,QAAA,IAAI,CAAC,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC;AACrB,QAAA,IAAI,CAAC,EAAE,GAAG,WAAW;AACrB,QAAA,IAAI,CAAC,KAAK,GAAG,KAAK;IACpB;AAEA;;;AAGG;IACH,SAAS,GAAA;QACP,OAAO,IAAI,CAAC,EAAE;IAChB;AAEA;;;;;AAKG;IACH,OAAO,GAAA;AACL,QAAA,OAAO,IAAI,CAAC,eAAe,EAAE;IAC/B;AAEA;;;;;;;;;AASG;IACH,YAAY,GAAA;AACV,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,EAAE;AACnC,QAAA,IAAI,CAAC,IAAI;AAAE,YAAA,OAAO,IAAI;QACtB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QAChC,IAAI,KAAK,KAAK,EAAE;AAAE,YAAA,OAAO,IAAI;AAC7B,QAAA,IAAI,IAAI,CAAC,EAAE,KAAK,IAAI,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;YAC/C,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;gBAC3B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC;YACrC;AAAO,iBAAA,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;gBAC7D,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC;YACrC;QACF;QACA,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC;IACjC;AAEA;;;AAGG;IACH,cAAc,GAAA;QACZ,OAAO,IAAI,CAAC,EAAE;IAChB;AAEA;;;AAGG;IACH,OAAO,GAAA;AACL,QAAA,OAAO,IAAI,CAAC,WAAW,EAAE;IAC3B;AAEA;;;;;;;;AAQG;IACH,gBAAgB,GAAA;AACd,QAAA,OAAO,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;IACzC;AAEA;;;;AAIG;IACH,QAAQ,GAAA;QACN,OAAO,IAAI,CAAC,KAAK;IACnB;AAEA;;;;;;;;;;;;;;;;;;;;;;;AAuBG;IACH,OAAO,MAAM,CAAC,IAAY,EAAA;AACxB,QAAA,IAAI,aAAa,CAAC,IAAI,KAAK,CAAC,EAAE;AAC5B,YAAA,iBAAiB,EAAE;QACrB;QACA,OAAO,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;IAC9C;AAEA;;;AAGG;IACH,QAAQ,GAAA;AACN,QAAA,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;IAC7B;AAEA;;;;;;;;;;;;;AAaG;AACH,IAAA,OAAO,cAAc,CAAC,EAAU,EAAE,GAAW,EAAA;QAC3C,EAAE,GAAG,CAAC,EAAE;AACR,QAAA,IAAI,GAAG,KAAK,MAAM,EAAE;AAClB,YAAA,IAAI,EAAE,KAAK,CAAC,EAAE;AACZ,gBAAA,OAAO,KAAK;YACd;iBAAO;AACL,gBAAA,MAAM,IAAI,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE;AAC9B,gBAAA,OAAO,CAAA,OAAA,EAAU,IAAI,CAAA,EAAG,EAAE,EAAE;YAC9B;QACF;aAAO,IAAI,EAAE,KAAK,CAAC,IAAI,GAAG,KAAK,QAAQ,EAAE;AACvC,YAAA,OAAO,gBAAgB;QACzB;AAAO,aAAA,IAAI,GAAG,KAAK,IAAI,EAAE;YACvB,QAAQ,EAAE;AACR,gBAAA,KAAK,EAAE;AACL,oBAAA,OAAO,qBAAqB;AAC9B,gBAAA,KAAK,EAAE;AACL,oBAAA,OAAO,iBAAiB;AAC1B,gBAAA,KAAK,CAAC;AACJ,oBAAA,OAAO,eAAe;AACxB,gBAAA,KAAK,CAAC;AACJ,oBAAA,OAAO,cAAc;AACvB,gBAAA,KAAK,CAAC;AACJ,oBAAA,OAAO,eAAe;;QAI5B;AAAO,aAAA,IAAI,GAAG,KAAK,KAAK,EAAE;YACxB,OAAO,eAAe,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;QACzC;AACA,QAAA,OAAO,SAAS;IAClB;AAEA;;;;;;;AAOG;AACH,IAAA,OAAO,UAAU,CAAC,KAAa,EAAE,EAAU,EAAE,GAAW,EAAA;QACtD,EAAE,GAAG,CAAC,EAAE;QACR,IAAI,EAAE,KAAK,EAAE,IAAI,KAAK,KAAK,IAAI,EAAE;AAC/B,YAAA,OAAO,cAAc;QACvB;aAAO,IAAI,EAAE,KAAK,CAAC,IAAI,KAAK,KAAK,IAAI,EAAE;YACrC,OAAO,GAAG,KAAK,GAAG,GAAG,gBAAgB,GAAG,iBAAiB;QAC3D;aAAO;AACL,YAAA,OAAO,eAAe,CAAC,EAAE,CAAC;QAC5B;IACF;AAEA;;;;;;;;;;;;;AAaG;AACH,IAAA,OAAO,WAAW,CAAC,QAAgB,EAAE,QAAkB,EAAA;AACrD,QAAA,MAAM,IAAI,GAAG,QAAQ,CAAC,WAAW,EAAE;AACnC,QAAA,IAAI,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;AAC3B,YAAA,OAAO,KAAK;QACd;AACA,QAAA,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC;AACjC,QAAA,OAAO,IAAI;IACb;AACD;;;;"}

package/dist/esm/modern.js

@@ -1,4 +1,4 @@
-/*! @hebcal/core v6.5.1, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
+/*! @hebcal/core v6.5.2, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
 import { months, HDate } from '@hebcal/hdate';
 
 const SUN = 0;

package/dist/esm/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/esm/molad.js

@@ -1,4 +1,4 @@
-/*! @hebcal/core v6.5.1, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
+/*! @hebcal/core v6.5.2, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
 import './temporal-shim.js';
 import { Event, flags } from './event.js';
 import { HDate, Locale, pad2 } from '@hebcal/hdate';
@@ -56,7 +56,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'
  */
 class Molad {
     m;
@@ -64,9 +77,9 @@ 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);
@@ -128,12 +141,18 @@ 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);
@@ -205,8 +224,21 @@ 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/esm/molad.js.map

@@ -1 +1 @@
-{"version":3,"file":"molad.js","sources":["../../../src/molad.ts"],"sourcesContent":["import './temporal-shim';\nimport {Event, flags} from './event';\nimport {CalOptions} from './CalOptions';\nimport {HDate, Locale, pad2} from '@hebcal/hdate';\nimport {reformatTimeStr} from './reformatTimeStr';\nimport {MoladBase, calculateMolad} from './moladBase';\nimport {getMoladAsDate} from './moladDate';\nimport './locale'; // Adds Hebrew and Ashkenazic translations\n\nconst enDoW = [\n  'Sunday',\n  'Monday',\n  'Tuesday',\n  'Wednesday',\n  'Thursday',\n  'Friday',\n  'Saturday',\n] as const;\n\nconst heDayNames = [\n  'רִאשׁוֹן',\n  'שֵׁנִי',\n  'שְׁלִישִׁי',\n  'רְבִיעִי',\n  'חֲמִישִׁי',\n  'שִׁישִּׁי',\n  'שַׁבָּת',\n] as const;\n\nconst frDoW = [\n  'Dimanche',\n  'Lundi',\n  'Mardi',\n  'Mercredi',\n  'Jeudi',\n  'Vendredi',\n  'Samedi',\n] as const;\nconst night = 'בַּלַּ֥יְלָה';\n\nfunction getDayNames(locale?: string): readonly string[] {\n  if (Locale.isHebrewLocale(locale)) {\n    return heDayNames;\n  } else if (locale === 'fr') {\n    return frDoW;\n  }\n  return enDoW;\n}\n\nfunction getHebrewTimeOfDay(hour: number): string {\n  if (hour < 5) return night;\n  else if (hour < 12) return 'בַּבֹּקֶר';\n  else if (hour < 17) return 'בַּצׇּהֳרַיִים';\n  else if (hour < 21) return 'בָּעֶרֶב';\n  return night;\n}\n\n/**\n * Represents a molad, the moment when the new moon is \"born\"\n */\nexport class Molad {\n  private readonly m: MoladBase;\n  private readonly year: number;\n  private readonly month: number;\n  private instant?: Temporal.ZonedDateTime;\n\n  /**\n   * Calculates the molad for a Hebrew month\n   * @param year\n   * @param month 1=NISSAN, 7=TISHREI\n   */\n  constructor(year: number, month: number) {\n    this.m = calculateMolad(year, month);\n    this.year = year;\n    this.month = month;\n  }\n  /**\n   * The exact Hebrew date of the molad, which often falls on the\n   * 28th or 30th of the preceeding month, occasionally on the first of the\n   * month, and in extremely rare circumstances the 27th of the month.\n   * - Molad Shevat 5541 occured on 27 Tevet / 1781-01-24T19:57:20.170Z\n   * - Molad Shevat 5788 will occur on 27 Tevet / 2028-01-26T19:07:03.504Z\n   * - Molad Nissan 5866 will occur on 27 Adar II / 2106-04-03T21:08:46.837Z\n   */\n  getMoladDate(): HDate {\n    return this.m.hdate;\n  }\n  /**\n   * The year of the molad (as constructed)\n   */\n  getYear(): number {\n    return this.year;\n  }\n  /**\n   * The month (1=NISSAN, 7=TISHREI) as constructed\n   */\n  getMonth(): number {\n    return this.month;\n  }\n  /**\n   * Returns a transliterated string name of the molad's Hebrew month,\n   * for example 'Elul' or 'Cheshvan'.\n   */\n  getMonthName(): string {\n    return HDate.getMonthName(this.month, this.year);\n  }\n  /**\n   * @returns Day of Week (0=Sunday, 6=Saturday)\n   */\n  getDow(): number {\n    return this.m.hdate.getDay();\n  }\n  /**\n   * @returns hour of day (0-23)\n   */\n  getHour(): number {\n    return this.m.hour;\n  }\n  /**\n   * @returns minutes past hour (0-59)\n   */\n  getMinutes(): number {\n    return this.m.minutes;\n  }\n  /**\n   * @returns parts of a minute (0-17)\n   */\n  getChalakim(): number {\n    return this.m.chalakim;\n  }\n  /**\n   * Returns the molad in Standard Time in Yerushalayim as a Temporal.ZonedDateTime.\n   * This method subtracts 20.94 minutes (20 minutes and 56.496 seconds) from the computed time (Har Habayis with a longitude\n   * of 35.2354&deg; is 5.2354&deg; away from the %15 timezone longitude) to get to standard time. This method\n   * intentionally uses standard time and not daylight savings time.\n   *\n   * @return the Temporal.ZonedDateTime representing the moment of the molad in Yerushalayim standard time (GMT + 2)\n   */\n  getInstant(): Temporal.ZonedDateTime {\n    this.instant ??= getMoladAsDate(this.m);\n    return this.instant;\n  }\n  /**\n   * Returns the earliest time of _Kiddush Levana_ calculated as 3 days after the molad. This method returns the time\n   * even if it is during the day when _Kiddush Levana_ can't be said. Callers of this method should consider\n   * displaying the next _tzais_ if the zman is between _alos_ and _tzais_.\n   *\n   * @return the Temporal.ZonedDateTime representing the moment 3 days after the molad.\n   */\n  getTchilasZmanKidushLevana3Days(): Temporal.ZonedDateTime {\n    const zdt = this.getInstant();\n    return zdt.add({hours: 72});\n  }\n\n  /**\n   * Returns the earliest time of Kiddush Levana calculated as 7 days after the molad as mentioned by the <a\n   * href=\"https://en.wikipedia.org/wiki/Yosef_Karo\">Mechaber</a>. See the <a\n   * href=\"https://en.wikipedia.org/wiki/Yoel_Sirkis\">Bach's</a> opinion on this time. This method returns the time\n   * even if it is during the day when _Kiddush Levana_ can't be said. Callers of this method should consider\n   * displaying the next _tzais_ if the zman is between _alos_ and _tzais_.\n   *\n   * @return the Temporal.ZonedDateTime representing the moment 7 days after the molad.\n   */\n  getTchilasZmanKidushLevana7Days(): Temporal.ZonedDateTime {\n    const zdt = this.getInstant();\n    return zdt.add({hours: 168});\n  }\n\n  /**\n   * Returns the latest time of Kiddush Levana according to the <a\n   * href=\"https://en.wikipedia.org/wiki/Yaakov_ben_Moshe_Levi_Moelin\">Maharil's</a> opinion that it is calculated as\n   * halfway between molad and molad. This adds half the 29 days, 12 hours and 793 chalakim time between molad and\n   * molad (14 days, 18 hours, 22 minutes and 666 milliseconds) to the month's molad. This method returns the time\n   * even if it is during the day when _Kiddush Levana_ can't be said. Callers of this method should consider\n   * displaying _alos_ before this time if the zman is between _alos_ and _tzais_.\n   *\n   * @return the Temporal.ZonedDateTime representing the moment halfway between molad and molad.\n   */\n  getSofZmanKidushLevanaBetweenMoldos(): Temporal.ZonedDateTime {\n    const zdt = this.getInstant();\n    // add half the time between molad and molad (half of 29 days, 12 hours and 793 chalakim (44 minutes, 3.3\n    // seconds), or 14 days, 18 hours, 22 minutes and 666 milliseconds). Add it as hours, not days, to avoid\n    // DST/ST crossover issues.\n    return zdt.add({\n      hours: 24 * 14 + 18,\n      minutes: 22,\n      seconds: 1,\n      milliseconds: 666,\n    });\n  }\n\n  /**\n   * Returns the latest time of Kiddush Levana calculated as 15 days after the molad. This is the opinion brought down\n   * in the Shulchan Aruch (Orach Chaim 426). It should be noted that some opinions hold that the\n   * <a href=\"https://en.wikipedia.org/wiki/Moses_Isserles\">Rema</a> who brings down the opinion of the <a\n   * href=\"https://en.wikipedia.org/wiki/Yaakov_ben_Moshe_Levi_Moelin\">Maharil's</a> of calculating\n   * {@link Molad.getSofZmanKidushLevanaBetweenMoldos() half way between molad and mold} is of the opinion that Mechaber\n   * agrees to his opinion. Also see the Aruch Hashulchan. For additional details on the subject, See Rabbi Dovid\n   * Heber's very detailed writeup in Siman Daled (chapter 4) of <a\n   * href=\"https://www.worldcat.org/oclc/461326125\">Shaarei Zmanim</a>. This method returns the time even if it is during\n   * the day when _Kiddush Levana_ can't be said. Callers of this method should consider displaying _alos_\n   * before this time if the zman is between _alos_ and _tzais_.\n   *\n   * @return the Temporal.ZonedDateTime representing the moment 15 days after the molad.\n   */\n  getSofZmanKidushLevana15Days(): Temporal.ZonedDateTime {\n    const zdt = this.getInstant();\n    // 15 days after the molad. Add it as hours, not days, to avoid DST/ST crossover issues.\n    return zdt.add({hours: 24 * 15});\n  }\n\n  /**\n   * @param [locale] Optional locale name (defaults to empty locale)\n   * @param options\n   */\n  render(locale?: string, options?: CalOptions): string {\n    const monthName = Locale.gettext(this.getMonthName(), locale);\n    const dayNames = getDayNames(locale);\n    const dow = dayNames[this.getDow()];\n    const minutes = this.getMinutes();\n    const hour = this.getHour();\n    const chalakim = this.getChalakim();\n    const moladStr = Locale.gettext('Molad', locale);\n    const minutesStr = Locale.lookupTranslation('min', locale) ?? 'minutes';\n    const chalakimStr = Locale.gettext('chalakim', locale);\n    const and = Locale.gettext('and', locale);\n    if (Locale.isHebrewLocale(locale)) {\n      const ampm = getHebrewTimeOfDay(hour);\n      let result =\n        `${moladStr} ${monthName} יִהְיֶה בַּיּוֹם ${dow} בשָׁבוּעַ, ` +\n        `בְּשָׁעָה ${hour} ${ampm}, ` +\n        `ו-${minutes} ${minutesStr}`;\n      if (chalakim !== 0) {\n        result += ` ו-${chalakim} ${chalakimStr}`;\n      }\n      if (locale!.toLocaleLowerCase() === 'he-x-nonikud') {\n        return Locale.hebrewStripNikkud(result);\n      }\n      return result;\n    }\n    const fmtTime = reformatTimeStr(`${hour}:${pad2(minutes)}`, 'pm', options);\n    const month = monthName.replace(/'/g, '’');\n    const result = `${moladStr} ${month}: ${dow}, ${fmtTime}`;\n    if (chalakim === 0) {\n      return result;\n    }\n    return result + ` ${and} ${chalakim} ${chalakimStr}`;\n  }\n}\n\n/** Represents a Molad announcement on Shabbat Mevarchim */\nexport class MoladEvent extends Event {\n  readonly molad: Molad;\n  private readonly options: CalOptions;\n  /**\n   * @param date Hebrew date event occurs\n   * @param hyear molad year\n   * @param hmonth molad month\n   * @param options\n   */\n  constructor(date: HDate, hyear: number, hmonth: number, options: CalOptions) {\n    const m = new Molad(hyear, hmonth);\n    const monthName = m.getMonthName();\n    super(date, `Molad ${monthName} ${hyear}`, flags.MOLAD);\n    this.molad = m;\n    this.options = options;\n  }\n  /**\n   * @param [locale] Optional locale name (defaults to empty locale)\n   */\n  render(locale?: string): string {\n    return this.molad.render(locale, this.options);\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;AASA,MAAM,KAAK,GAAG;IACZ,QAAQ;IACR,QAAQ;IACR,SAAS;IACT,WAAW;IACX,UAAU;IACV,QAAQ;IACR,UAAU;CACF;AAEV,MAAM,UAAU,GAAG;IACjB,UAAU;IACV,QAAQ;IACR,YAAY;IACZ,UAAU;IACV,WAAW;IACX,WAAW;IACX,SAAS;CACD;AAEV,MAAM,KAAK,GAAG;IACZ,UAAU;IACV,OAAO;IACP,OAAO;IACP,UAAU;IACV,OAAO;IACP,UAAU;IACV,QAAQ;CACA;AACV,MAAM,KAAK,GAAG,cAAc;AAE5B,SAAS,WAAW,CAAC,MAAe,EAAA;AAClC,IAAA,IAAI,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE;AACjC,QAAA,OAAO,UAAU;IACnB;AAAO,SAAA,IAAI,MAAM,KAAK,IAAI,EAAE;AAC1B,QAAA,OAAO,KAAK;IACd;AACA,IAAA,OAAO,KAAK;AACd;AAEA,SAAS,kBAAkB,CAAC,IAAY,EAAA;IACtC,IAAI,IAAI,GAAG,CAAC;AAAE,QAAA,OAAO,KAAK;SACrB,IAAI,IAAI,GAAG,EAAE;AAAE,QAAA,OAAO,WAAW;SACjC,IAAI,IAAI,GAAG,EAAE;AAAE,QAAA,OAAO,gBAAgB;SACtC,IAAI,IAAI,GAAG,EAAE;AAAE,QAAA,OAAO,UAAU;AACrC,IAAA,OAAO,KAAK;AACd;AAEA;;AAEG;MACU,KAAK,CAAA;AACC,IAAA,CAAC;AACD,IAAA,IAAI;AACJ,IAAA,KAAK;AACd,IAAA,OAAO;AAEf;;;;AAIG;IACH,WAAA,CAAY,IAAY,EAAE,KAAa,EAAA;QACrC,IAAI,CAAC,CAAC,GAAG,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC;AACpC,QAAA,IAAI,CAAC,IAAI,GAAG,IAAI;AAChB,QAAA,IAAI,CAAC,KAAK,GAAG,KAAK;IACpB;AACA;;;;;;;AAOG;IACH,YAAY,GAAA;AACV,QAAA,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK;IACrB;AACA;;AAEG;IACH,OAAO,GAAA;QACL,OAAO,IAAI,CAAC,IAAI;IAClB;AACA;;AAEG;IACH,QAAQ,GAAA;QACN,OAAO,IAAI,CAAC,KAAK;IACnB;AACA;;;AAGG;IACH,YAAY,GAAA;AACV,QAAA,OAAO,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC;IAClD;AACA;;AAEG;IACH,MAAM,GAAA;QACJ,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE;IAC9B;AACA;;AAEG;IACH,OAAO,GAAA;AACL,QAAA,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI;IACpB;AACA;;AAEG;IACH,UAAU,GAAA;AACR,QAAA,OAAO,IAAI,CAAC,CAAC,CAAC,OAAO;IACvB;AACA;;AAEG;IACH,WAAW,GAAA;AACT,QAAA,OAAO,IAAI,CAAC,CAAC,CAAC,QAAQ;IACxB;AACA;;;;;;;AAOG;IACH,UAAU,GAAA;QACR,IAAI,CAAC,OAAO,KAAK,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO;IACrB;AACA;;;;;;AAMG;IACH,+BAA+B,GAAA;AAC7B,QAAA,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE;QAC7B,OAAO,GAAG,CAAC,GAAG,CAAC,EAAC,KAAK,EAAE,EAAE,EAAC,CAAC;IAC7B;AAEA;;;;;;;;AAQG;IACH,+BAA+B,GAAA;AAC7B,QAAA,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE;QAC7B,OAAO,GAAG,CAAC,GAAG,CAAC,EAAC,KAAK,EAAE,GAAG,EAAC,CAAC;IAC9B;AAEA;;;;;;;;;AASG;IACH,mCAAmC,GAAA;AACjC,QAAA,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE;;;;QAI7B,OAAO,GAAG,CAAC,GAAG,CAAC;AACb,YAAA,KAAK,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE;AACnB,YAAA,OAAO,EAAE,EAAE;AACX,YAAA,OAAO,EAAE,CAAC;AACV,YAAA,YAAY,EAAE,GAAG;AAClB,SAAA,CAAC;IACJ;AAEA;;;;;;;;;;;;;AAaG;IACH,4BAA4B,GAAA;AAC1B,QAAA,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE;;AAE7B,QAAA,OAAO,GAAG,CAAC,GAAG,CAAC,EAAC,KAAK,EAAE,EAAE,GAAG,EAAE,EAAC,CAAC;IAClC;AAEA;;;AAGG;IACH,MAAM,CAAC,MAAe,EAAE,OAAoB,EAAA;AAC1C,QAAA,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,MAAM,CAAC;AAC7D,QAAA,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAC;QACpC,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;AACnC,QAAA,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE;AACjC,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE;AAC3B,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE;QACnC,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC;AAChD,QAAA,MAAM,UAAU,GAAG,MAAM,CAAC,iBAAiB,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,SAAS;QACvE,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC;QACtD,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC;AACzC,QAAA,IAAI,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE;AACjC,YAAA,MAAM,IAAI,GAAG,kBAAkB,CAAC,IAAI,CAAC;YACrC,IAAI,MAAM,GACR,CAAA,EAAG,QAAQ,IAAI,SAAS,CAAA,kBAAA,EAAqB,GAAG,CAAA,YAAA,CAAc;gBAC9D,CAAA,UAAA,EAAa,IAAI,CAAA,CAAA,EAAI,IAAI,CAAA,EAAA,CAAI;AAC7B,gBAAA,CAAA,EAAA,EAAK,OAAO,CAAA,CAAA,EAAI,UAAU,CAAA,CAAE;AAC9B,YAAA,IAAI,QAAQ,KAAK,CAAC,EAAE;AAClB,gBAAA,MAAM,IAAI,CAAA,GAAA,EAAM,QAAQ,CAAA,CAAA,EAAI,WAAW,EAAE;YAC3C;AACA,YAAA,IAAI,MAAO,CAAC,iBAAiB,EAAE,KAAK,cAAc,EAAE;AAClD,gBAAA,OAAO,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC;YACzC;AACA,YAAA,OAAO,MAAM;QACf;AACA,QAAA,MAAM,OAAO,GAAG,eAAe,CAAC,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,IAAI,CAAC,OAAO,CAAC,CAAA,CAAE,EAAE,IAAI,EAAE,OAAO,CAAC;QAC1E,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC;QAC1C,MAAM,MAAM,GAAG,CAAA,EAAG,QAAQ,CAAA,CAAA,EAAI,KAAK,CAAA,EAAA,EAAK,GAAG,CAAA,EAAA,EAAK,OAAO,CAAA,CAAE;AACzD,QAAA,IAAI,QAAQ,KAAK,CAAC,EAAE;AAClB,YAAA,OAAO,MAAM;QACf;QACA,OAAO,MAAM,GAAG,CAAA,CAAA,EAAI,GAAG,IAAI,QAAQ,CAAA,CAAA,EAAI,WAAW,CAAA,CAAE;IACtD;AACD;AAED;AACM,MAAO,UAAW,SAAQ,KAAK,CAAA;AAC1B,IAAA,KAAK;AACG,IAAA,OAAO;AACxB;;;;;AAKG;AACH,IAAA,WAAA,CAAY,IAAW,EAAE,KAAa,EAAE,MAAc,EAAE,OAAmB,EAAA;QACzE,MAAM,CAAC,GAAG,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC;AAClC,QAAA,MAAM,SAAS,GAAG,CAAC,CAAC,YAAY,EAAE;AAClC,QAAA,KAAK,CAAC,IAAI,EAAE,CAAA,MAAA,EAAS,SAAS,CAAA,CAAA,EAAI,KAAK,CAAA,CAAE,EAAE,KAAK,CAAC,KAAK,CAAC;AACvD,QAAA,IAAI,CAAC,KAAK,GAAG,CAAC;AACd,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO;IACxB;AACA;;AAEG;AACH,IAAA,MAAM,CAAC,MAAe,EAAA;AACpB,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC;IAChD;AACD;;;;"}
+{"version":3,"file":"molad.js","sources":["../../../src/molad.ts"],"sourcesContent":["import './temporal-shim';\nimport {Event, flags} from './event';\nimport {CalOptions} from './CalOptions';\nimport {HDate, Locale, pad2} from '@hebcal/hdate';\nimport {reformatTimeStr} from './reformatTimeStr';\nimport {MoladBase, calculateMolad} from './moladBase';\nimport {getMoladAsDate} from './moladDate';\nimport './locale'; // Adds Hebrew and Ashkenazic translations\n\nconst enDoW = [\n  'Sunday',\n  'Monday',\n  'Tuesday',\n  'Wednesday',\n  'Thursday',\n  'Friday',\n  'Saturday',\n] as const;\n\nconst heDayNames = [\n  'רִאשׁוֹן',\n  'שֵׁנִי',\n  'שְׁלִישִׁי',\n  'רְבִיעִי',\n  'חֲמִישִׁי',\n  'שִׁישִּׁי',\n  'שַׁבָּת',\n] as const;\n\nconst frDoW = [\n  'Dimanche',\n  'Lundi',\n  'Mardi',\n  'Mercredi',\n  'Jeudi',\n  'Vendredi',\n  'Samedi',\n] as const;\nconst night = 'בַּלַּ֥יְלָה';\n\nfunction getDayNames(locale?: string): readonly string[] {\n  if (Locale.isHebrewLocale(locale)) {\n    return heDayNames;\n  } else if (locale === 'fr') {\n    return frDoW;\n  }\n  return enDoW;\n}\n\nfunction getHebrewTimeOfDay(hour: number): string {\n  if (hour < 5) return night;\n  else if (hour < 12) return 'בַּבֹּקֶר';\n  else if (hour < 17) return 'בַּצׇּהֳרַיִים';\n  else if (hour < 21) return 'בָּעֶרֶב';\n  return night;\n}\n\n/**\n * Represents a *molad* — the calculated moment when the new moon is \"born\"\n * for a given Hebrew month.\n *\n * The molad is announced in synagogue on Shabbat Mevarchim (the Shabbat\n * before Rosh Chodesh) and is the anchor point for Kiddush Levana zmanim.\n * Calculations use the traditional chalakim arithmetic\n * (1 hour = 1080 chalakim) anchored to *Molad Tohu BaHaRaD*.\n *\n * @example\n * import {Molad, months} from '@hebcal/core';\n * const m = new Molad(5784, months.NISAN);\n * console.log(m.getMonthName()); // 'Nisan'\n * console.log(m.getHour(), m.getMinutes(), m.getChalakim()); // e.g. 1 31 12\n * console.log(m.render('en')); // 'Molad Nisan: Mon, 1:31am and 12 chalakim'\n */\nexport class Molad {\n  private readonly m: MoladBase;\n  private readonly year: number;\n  private readonly month: number;\n  private instant?: Temporal.ZonedDateTime;\n\n  /**\n   * Calculates the molad for a given Hebrew year and month.\n   * @param year Hebrew year\n   * @param month 1=NISAN, 7=TISHREI (uses Nisan-based numbering)\n   */\n  constructor(year: number, month: number) {\n    this.m = calculateMolad(year, month);\n    this.year = year;\n    this.month = month;\n  }\n  /**\n   * The exact Hebrew date of the molad, which often falls on the\n   * 28th or 30th of the preceeding month, occasionally on the first of the\n   * month, and in extremely rare circumstances the 27th of the month.\n   * - Molad Shevat 5541 occured on 27 Tevet / 1781-01-24T19:57:20.170Z\n   * - Molad Shevat 5788 will occur on 27 Tevet / 2028-01-26T19:07:03.504Z\n   * - Molad Nissan 5866 will occur on 27 Adar II / 2106-04-03T21:08:46.837Z\n   */\n  getMoladDate(): HDate {\n    return this.m.hdate;\n  }\n  /**\n   * The year of the molad (as constructed)\n   */\n  getYear(): number {\n    return this.year;\n  }\n  /**\n   * The month (1=NISSAN, 7=TISHREI) as constructed\n   */\n  getMonth(): number {\n    return this.month;\n  }\n  /**\n   * Returns a transliterated string name of the molad's Hebrew month,\n   * for example 'Elul' or 'Cheshvan'.\n   */\n  getMonthName(): string {\n    return HDate.getMonthName(this.month, this.year);\n  }\n  /**\n   * @returns Day of Week (0=Sunday, 6=Saturday)\n   */\n  getDow(): number {\n    return this.m.hdate.getDay();\n  }\n  /**\n   * @returns hour of day (0-23)\n   */\n  getHour(): number {\n    return this.m.hour;\n  }\n  /**\n   * @returns minutes past hour (0-59)\n   */\n  getMinutes(): number {\n    return this.m.minutes;\n  }\n  /**\n   * @returns parts of a minute (0-17)\n   */\n  getChalakim(): number {\n    return this.m.chalakim;\n  }\n  /**\n   * Returns the molad in Standard Time in Yerushalayim as a `Temporal.ZonedDateTime`.\n   * This method subtracts 20.94 minutes (20 minutes and 56.496 seconds) from the computed time (Har Habayis with a longitude\n   * of 35.2354&deg; is 5.2354&deg; away from the %15 timezone longitude) to get to standard time. This method\n   * intentionally uses standard time and not daylight savings time.\n   *\n   * The returned value is cached after the first call.\n   * @example\n   * import {Molad, months} from '@hebcal/core';\n   * const m = new Molad(5784, months.NISAN);\n   * const zdt = m.getInstant();\n   * console.log(zdt.toString()); // e.g. '2024-04-08T17:21:13.333+00:00[UTC]'\n   * @return the `Temporal.ZonedDateTime` representing the moment of the molad\n   */\n  getInstant(): Temporal.ZonedDateTime {\n    this.instant ??= getMoladAsDate(this.m);\n    return this.instant;\n  }\n  /**\n   * Returns the earliest time of _Kiddush Levana_ calculated as 3 days after the molad. This method returns the time\n   * even if it is during the day when _Kiddush Levana_ can't be said. Callers of this method should consider\n   * displaying the next _tzais_ if the zman is between _alos_ and _tzais_.\n   *\n   * @return the Temporal.ZonedDateTime representing the moment 3 days after the molad.\n   */\n  getTchilasZmanKidushLevana3Days(): Temporal.ZonedDateTime {\n    const zdt = this.getInstant();\n    return zdt.add({hours: 72});\n  }\n\n  /**\n   * Returns the earliest time of Kiddush Levana calculated as 7 days after the molad as mentioned by the <a\n   * href=\"https://en.wikipedia.org/wiki/Yosef_Karo\">Mechaber</a>. See the <a\n   * href=\"https://en.wikipedia.org/wiki/Yoel_Sirkis\">Bach's</a> opinion on this time. This method returns the time\n   * even if it is during the day when _Kiddush Levana_ can't be said. Callers of this method should consider\n   * displaying the next _tzais_ if the zman is between _alos_ and _tzais_.\n   *\n   * @return the Temporal.ZonedDateTime representing the moment 7 days after the molad.\n   */\n  getTchilasZmanKidushLevana7Days(): Temporal.ZonedDateTime {\n    const zdt = this.getInstant();\n    return zdt.add({hours: 168});\n  }\n\n  /**\n   * Returns the latest time of Kiddush Levana according to the <a\n   * href=\"https://en.wikipedia.org/wiki/Yaakov_ben_Moshe_Levi_Moelin\">Maharil's</a> opinion that it is calculated as\n   * halfway between molad and molad. This adds half the 29 days, 12 hours and 793 chalakim time between molad and\n   * molad (14 days, 18 hours, 22 minutes and 666 milliseconds) to the month's molad. This method returns the time\n   * even if it is during the day when _Kiddush Levana_ can't be said. Callers of this method should consider\n   * displaying _alos_ before this time if the zman is between _alos_ and _tzais_.\n   *\n   * @return the Temporal.ZonedDateTime representing the moment halfway between molad and molad.\n   */\n  getSofZmanKidushLevanaBetweenMoldos(): Temporal.ZonedDateTime {\n    const zdt = this.getInstant();\n    // add half the time between molad and molad (half of 29 days, 12 hours and 793 chalakim (44 minutes, 3.3\n    // seconds), or 14 days, 18 hours, 22 minutes and 666 milliseconds). Add it as hours, not days, to avoid\n    // DST/ST crossover issues.\n    return zdt.add({\n      hours: 24 * 14 + 18,\n      minutes: 22,\n      seconds: 1,\n      milliseconds: 666,\n    });\n  }\n\n  /**\n   * Returns the latest time of Kiddush Levana calculated as 15 days after the molad. This is the opinion brought down\n   * in the Shulchan Aruch (Orach Chaim 426). It should be noted that some opinions hold that the\n   * <a href=\"https://en.wikipedia.org/wiki/Moses_Isserles\">Rema</a> who brings down the opinion of the <a\n   * href=\"https://en.wikipedia.org/wiki/Yaakov_ben_Moshe_Levi_Moelin\">Maharil's</a> of calculating\n   * {@link Molad.getSofZmanKidushLevanaBetweenMoldos() half way between molad and mold} is of the opinion that Mechaber\n   * agrees to his opinion. Also see the Aruch Hashulchan. For additional details on the subject, See Rabbi Dovid\n   * Heber's very detailed writeup in Siman Daled (chapter 4) of <a\n   * href=\"https://www.worldcat.org/oclc/461326125\">Shaarei Zmanim</a>. This method returns the time even if it is during\n   * the day when _Kiddush Levana_ can't be said. Callers of this method should consider displaying _alos_\n   * before this time if the zman is between _alos_ and _tzais_.\n   *\n   * @return the Temporal.ZonedDateTime representing the moment 15 days after the molad.\n   */\n  getSofZmanKidushLevana15Days(): Temporal.ZonedDateTime {\n    const zdt = this.getInstant();\n    // 15 days after the molad. Add it as hours, not days, to avoid DST/ST crossover issues.\n    return zdt.add({hours: 24 * 15});\n  }\n\n  /**\n   * Returns a human-readable, localized string announcing the molad —\n   * suitable for use on Shabbat Mevarchim. The format includes the Hebrew\n   * month name, day of week, hour : minute, and chalakim if non-zero.\n   *\n   * Time format honors `options.hour12` and `options.location` (12-hour vs.\n   * 24-hour); see {@link HebrewCalendar.reformatTimeStr}.\n   * @example\n   * import {Molad, months} from '@hebcal/core';\n   * const m = new Molad(5784, months.NISAN);\n   * m.render('en', {hour12: true});\n   * // => 'Molad Nisan: Mon, 7:21pm and 6 chalakim'\n   * m.render('he');\n   * // => 'מוֹלָד נִיסָן יִהְיֶה בַּיּוֹם שֵׁנִי בשָׁבוּעַ, …'\n   * @param [locale] Optional locale name (defaults to empty locale)\n   * @param options used for time formatting (12-hour vs 24-hour)\n   */\n  render(locale?: string, options?: CalOptions): string {\n    const monthName = Locale.gettext(this.getMonthName(), locale);\n    const dayNames = getDayNames(locale);\n    const dow = dayNames[this.getDow()];\n    const minutes = this.getMinutes();\n    const hour = this.getHour();\n    const chalakim = this.getChalakim();\n    const moladStr = Locale.gettext('Molad', locale);\n    const minutesStr = Locale.lookupTranslation('min', locale) ?? 'minutes';\n    const chalakimStr = Locale.gettext('chalakim', locale);\n    const and = Locale.gettext('and', locale);\n    if (Locale.isHebrewLocale(locale)) {\n      const ampm = getHebrewTimeOfDay(hour);\n      let result =\n        `${moladStr} ${monthName} יִהְיֶה בַּיּוֹם ${dow} בשָׁבוּעַ, ` +\n        `בְּשָׁעָה ${hour} ${ampm}, ` +\n        `ו-${minutes} ${minutesStr}`;\n      if (chalakim !== 0) {\n        result += ` ו-${chalakim} ${chalakimStr}`;\n      }\n      if (locale!.toLocaleLowerCase() === 'he-x-nonikud') {\n        return Locale.hebrewStripNikkud(result);\n      }\n      return result;\n    }\n    const fmtTime = reformatTimeStr(`${hour}:${pad2(minutes)}`, 'pm', options);\n    const month = monthName.replace(/'/g, '’');\n    const result = `${moladStr} ${month}: ${dow}, ${fmtTime}`;\n    if (chalakim === 0) {\n      return result;\n    }\n    return result + ` ${and} ${chalakim} ${chalakimStr}`;\n  }\n}\n\n/** Represents a Molad announcement on Shabbat Mevarchim */\nexport class MoladEvent extends Event {\n  readonly molad: Molad;\n  private readonly options: CalOptions;\n  /**\n   * @param date Hebrew date event occurs\n   * @param hyear molad year\n   * @param hmonth molad month\n   * @param options\n   */\n  constructor(date: HDate, hyear: number, hmonth: number, options: CalOptions) {\n    const m = new Molad(hyear, hmonth);\n    const monthName = m.getMonthName();\n    super(date, `Molad ${monthName} ${hyear}`, flags.MOLAD);\n    this.molad = m;\n    this.options = options;\n  }\n  /**\n   * @param [locale] Optional locale name (defaults to empty locale)\n   */\n  render(locale?: string): string {\n    return this.molad.render(locale, this.options);\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;AASA,MAAM,KAAK,GAAG;IACZ,QAAQ;IACR,QAAQ;IACR,SAAS;IACT,WAAW;IACX,UAAU;IACV,QAAQ;IACR,UAAU;CACF;AAEV,MAAM,UAAU,GAAG;IACjB,UAAU;IACV,QAAQ;IACR,YAAY;IACZ,UAAU;IACV,WAAW;IACX,WAAW;IACX,SAAS;CACD;AAEV,MAAM,KAAK,GAAG;IACZ,UAAU;IACV,OAAO;IACP,OAAO;IACP,UAAU;IACV,OAAO;IACP,UAAU;IACV,QAAQ;CACA;AACV,MAAM,KAAK,GAAG,cAAc;AAE5B,SAAS,WAAW,CAAC,MAAe,EAAA;AAClC,IAAA,IAAI,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE;AACjC,QAAA,OAAO,UAAU;IACnB;AAAO,SAAA,IAAI,MAAM,KAAK,IAAI,EAAE;AAC1B,QAAA,OAAO,KAAK;IACd;AACA,IAAA,OAAO,KAAK;AACd;AAEA,SAAS,kBAAkB,CAAC,IAAY,EAAA;IACtC,IAAI,IAAI,GAAG,CAAC;AAAE,QAAA,OAAO,KAAK;SACrB,IAAI,IAAI,GAAG,EAAE;AAAE,QAAA,OAAO,WAAW;SACjC,IAAI,IAAI,GAAG,EAAE;AAAE,QAAA,OAAO,gBAAgB;SACtC,IAAI,IAAI,GAAG,EAAE;AAAE,QAAA,OAAO,UAAU;AACrC,IAAA,OAAO,KAAK;AACd;AAEA;;;;;;;;;;;;;;;AAeG;MACU,KAAK,CAAA;AACC,IAAA,CAAC;AACD,IAAA,IAAI;AACJ,IAAA,KAAK;AACd,IAAA,OAAO;AAEf;;;;AAIG;IACH,WAAA,CAAY,IAAY,EAAE,KAAa,EAAA;QACrC,IAAI,CAAC,CAAC,GAAG,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC;AACpC,QAAA,IAAI,CAAC,IAAI,GAAG,IAAI;AAChB,QAAA,IAAI,CAAC,KAAK,GAAG,KAAK;IACpB;AACA;;;;;;;AAOG;IACH,YAAY,GAAA;AACV,QAAA,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK;IACrB;AACA;;AAEG;IACH,OAAO,GAAA;QACL,OAAO,IAAI,CAAC,IAAI;IAClB;AACA;;AAEG;IACH,QAAQ,GAAA;QACN,OAAO,IAAI,CAAC,KAAK;IACnB;AACA;;;AAGG;IACH,YAAY,GAAA;AACV,QAAA,OAAO,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC;IAClD;AACA;;AAEG;IACH,MAAM,GAAA;QACJ,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE;IAC9B;AACA;;AAEG;IACH,OAAO,GAAA;AACL,QAAA,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI;IACpB;AACA;;AAEG;IACH,UAAU,GAAA;AACR,QAAA,OAAO,IAAI,CAAC,CAAC,CAAC,OAAO;IACvB;AACA;;AAEG;IACH,WAAW,GAAA;AACT,QAAA,OAAO,IAAI,CAAC,CAAC,CAAC,QAAQ;IACxB;AACA;;;;;;;;;;;;;AAaG;IACH,UAAU,GAAA;QACR,IAAI,CAAC,OAAO,KAAK,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO;IACrB;AACA;;;;;;AAMG;IACH,+BAA+B,GAAA;AAC7B,QAAA,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE;QAC7B,OAAO,GAAG,CAAC,GAAG,CAAC,EAAC,KAAK,EAAE,EAAE,EAAC,CAAC;IAC7B;AAEA;;;;;;;;AAQG;IACH,+BAA+B,GAAA;AAC7B,QAAA,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE;QAC7B,OAAO,GAAG,CAAC,GAAG,CAAC,EAAC,KAAK,EAAE,GAAG,EAAC,CAAC;IAC9B;AAEA;;;;;;;;;AASG;IACH,mCAAmC,GAAA;AACjC,QAAA,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE;;;;QAI7B,OAAO,GAAG,CAAC,GAAG,CAAC;AACb,YAAA,KAAK,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE;AACnB,YAAA,OAAO,EAAE,EAAE;AACX,YAAA,OAAO,EAAE,CAAC;AACV,YAAA,YAAY,EAAE,GAAG;AAClB,SAAA,CAAC;IACJ;AAEA;;;;;;;;;;;;;AAaG;IACH,4BAA4B,GAAA;AAC1B,QAAA,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE;;AAE7B,QAAA,OAAO,GAAG,CAAC,GAAG,CAAC,EAAC,KAAK,EAAE,EAAE,GAAG,EAAE,EAAC,CAAC;IAClC;AAEA;;;;;;;;;;;;;;;;AAgBG;IACH,MAAM,CAAC,MAAe,EAAE,OAAoB,EAAA;AAC1C,QAAA,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,MAAM,CAAC;AAC7D,QAAA,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAC;QACpC,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;AACnC,QAAA,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE;AACjC,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE;AAC3B,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE;QACnC,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC;AAChD,QAAA,MAAM,UAAU,GAAG,MAAM,CAAC,iBAAiB,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,SAAS;QACvE,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC;QACtD,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC;AACzC,QAAA,IAAI,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE;AACjC,YAAA,MAAM,IAAI,GAAG,kBAAkB,CAAC,IAAI,CAAC;YACrC,IAAI,MAAM,GACR,CAAA,EAAG,QAAQ,IAAI,SAAS,CAAA,kBAAA,EAAqB,GAAG,CAAA,YAAA,CAAc;gBAC9D,CAAA,UAAA,EAAa,IAAI,CAAA,CAAA,EAAI,IAAI,CAAA,EAAA,CAAI;AAC7B,gBAAA,CAAA,EAAA,EAAK,OAAO,CAAA,CAAA,EAAI,UAAU,CAAA,CAAE;AAC9B,YAAA,IAAI,QAAQ,KAAK,CAAC,EAAE;AAClB,gBAAA,MAAM,IAAI,CAAA,GAAA,EAAM,QAAQ,CAAA,CAAA,EAAI,WAAW,EAAE;YAC3C;AACA,YAAA,IAAI,MAAO,CAAC,iBAAiB,EAAE,KAAK,cAAc,EAAE;AAClD,gBAAA,OAAO,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC;YACzC;AACA,YAAA,OAAO,MAAM;QACf;AACA,QAAA,MAAM,OAAO,GAAG,eAAe,CAAC,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,IAAI,CAAC,OAAO,CAAC,CAAA,CAAE,EAAE,IAAI,EAAE,OAAO,CAAC;QAC1E,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC;QAC1C,MAAM,MAAM,GAAG,CAAA,EAAG,QAAQ,CAAA,CAAA,EAAI,KAAK,CAAA,EAAA,EAAK,GAAG,CAAA,EAAA,EAAK,OAAO,CAAA,CAAE;AACzD,QAAA,IAAI,QAAQ,KAAK,CAAC,EAAE;AAClB,YAAA,OAAO,MAAM;QACf;QACA,OAAO,MAAM,GAAG,CAAA,CAAA,EAAI,GAAG,IAAI,QAAQ,CAAA,CAAA,EAAI,WAAW,CAAA,CAAE;IACtD;AACD;AAED;AACM,MAAO,UAAW,SAAQ,KAAK,CAAA;AAC1B,IAAA,KAAK;AACG,IAAA,OAAO;AACxB;;;;;AAKG;AACH,IAAA,WAAA,CAAY,IAAW,EAAE,KAAa,EAAE,MAAc,EAAE,OAAmB,EAAA;QACzE,MAAM,CAAC,GAAG,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC;AAClC,QAAA,MAAM,SAAS,GAAG,CAAC,CAAC,YAAY,EAAE;AAClC,QAAA,KAAK,CAAC,IAAI,EAAE,CAAA,MAAA,EAAS,SAAS,CAAA,CAAA,EAAI,KAAK,CAAA,CAAE,EAAE,KAAK,CAAC,KAAK,CAAC;AACvD,QAAA,IAAI,CAAC,KAAK,GAAG,CAAC;AACd,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO;IACxB;AACA;;AAEG;AACH,IAAA,MAAM,CAAC,MAAe,EAAA;AACpB,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC;IAChD;AACD;;;;"}

package/dist/esm/moladBase.js

@@ -1,4 +1,4 @@
-/*! @hebcal/core v6.5.1, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
+/*! @hebcal/core v6.5.2, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
 import { HDate, isLeapYear } from '@hebcal/hdate';
 
 /*

package/dist/esm/moladDate.js

@@ -1,4 +1,4 @@
-/*! @hebcal/core v6.5.1, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
+/*! @hebcal/core v6.5.2, distributed under GPLv2 https://www.gnu.org/licenses/gpl-2.0.txt */
 import './temporal-shim.js';
 import { getTimezoneOffset } from '@hebcal/hdate';
 

package/dist/esm/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 `חֶֽסֶד שֶׁבִּגְבוּרָה`
      */