@hebcal/core 3.33.4 → 3.33.5

package/dist/index.mjs

@@ -1,4 +1,4 @@
-/*! @hebcal/core v3.33.4 */
+/*! @hebcal/core v3.33.5 */
 /*
     Hebcal - A Jewish Calendar Generator
     Copyright (c) 1994-2020 Danny Sadinoff
@@ -42,53 +42,55 @@ function quotient(x, y) {
 }
 /**
  * Gregorian date helper functions.
- * @namespace
  */
 
 
-const greg = {
+class greg {
   /**
    * Long names of the Gregorian months (1='January', 12='December')
    * @readonly
    * @type {string[]}
    */
-  monthNames: ['', 'January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'],
-
+  static monthNames = ['', 'January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'];
   /**
    * Returns true if the Gregorian year is a leap year
    * @param {number} year Gregorian year
    * @return {boolean}
    */
-  isLeapYear: function (year) {
-    return !(year % 4) && (!!(year % 100) || !(year % 400));
-  },
 
+  static isLeapYear(year) {
+    return !(year % 4) && (!!(year % 100) || !(year % 400));
+  }
   /**
    * Number of days in the Gregorian month for given year
    * @param {number} month Gregorian month (1=January, 12=December)
    * @param {number} year Gregorian year
    * @return {number}
    */
-  daysInMonth: function (month, year) {
+
+
+  static daysInMonth(month, year) {
     // 1 based months
     return monthLengths[+this.isLeapYear(year)][month];
-  },
-
+  }
   /**
    * Returns true if the object is a Javascript Date
    * @param {Object} obj
    * @return {boolean}
    */
-  isDate: function (obj) {
-    return typeof obj === 'object' && Date.prototype === obj.__proto__;
-  },
 
+
+  static isDate(obj) {
+    return typeof obj === 'object' && Date.prototype === obj.__proto__;
+  }
   /**
    * Returns number of days since January 1 of that year
    * @param {Date} date Gregorian date
    * @return {number}
    */
-  dayOfYear: function (date) {
+
+
+  static dayOfYear(date) {
     if (!this.isDate(date)) {
       throw new TypeError('Argument to greg.dayOfYear not a Date');
     }
@@ -105,14 +107,15 @@ const greg = {
     }
 
     return doy;
-  },
-
+  }
   /**
    * Converts Gregorian date to absolute R.D. (Rata Die) days
    * @param {Date} date Gregorian date
    * @return {number}
    */
-  greg2abs: function (date) {
+
+
+  static greg2abs(date) {
     if (!this.isDate(date)) {
       throw new TypeError('Argument to greg.greg2abs not a Date');
     }
@@ -123,14 +126,15 @@ const greg = {
     Math.floor(year / 4) - // + Julian Leap years
     Math.floor(year / 100) + // - century years
     Math.floor(year / 400)); // + Gregorian leap years
-  },
-
+  }
   /**
    * @private
    * @param {number} theDate - R.D. number of days
    * @return {number}
    */
-  yearFromFixed: function (theDate) {
+
+
+  static yearFromFixed(theDate) {
     const l0 = theDate - 1;
     const n400 = quotient(l0, 146097);
     const d1 = mod(l0, 146097);
@@ -141,8 +145,7 @@ const greg = {
     const n1 = quotient(d3, 365);
     const year = 400 * n400 + 100 * n100 + 4 * n4 + n1;
     return n100 != 4 && n1 != 4 ? year + 1 : year;
-  },
-
+  }
   /**
    * @private
    * @param {number} year
@@ -150,11 +153,12 @@ const greg = {
    * @param {number} day
    * @return {number}
    */
-  toFixed: function (year, month, day) {
+
+
+  static toFixed(year, month, day) {
     const py = year - 1;
     return 0 + 365 * py + quotient(py, 4) - quotient(py, 100) + quotient(py, 400) + quotient(367 * month - 362, 12) + Math.floor(month <= 2 ? 0 : this.isLeapYear(year) ? -1 : -2) + day;
-  },
-
+  }
   /**
    * Converts from Rata Die (R.D. number) to Gregorian date.
    * See the footnote on page 384 of ``Calendrical Calculations, Part II:
@@ -164,7 +168,9 @@ const greg = {
    * @param {number} theDate - R.D. number of days
    * @return {Date}
    */
-  abs2greg: function (theDate) {
+
+
+  static abs2greg(theDate) {
     if (typeof theDate !== 'number') {
       throw new TypeError('Argument to greg.abs2greg not a Number');
     }
@@ -183,7 +189,8 @@ const greg = {
 
     return dt;
   }
-};
+
+}
 
 const GERESH = '׳';
 const GERSHAYIM = '״';
@@ -371,19 +378,17 @@ const alias = {
  * * `ashkenazi` - Ashkenazi transliterations (e.g. "Shabbos")
  * * `he` - Hebrew (e.g. "שַׁבָּת")
  * * `he-x-NoNikud` - Hebrew without nikud (e.g. "שבת")
- * @namespace
  */
 
-const Locale = {
+class Locale {
   /** @private */
-  locales: Object.create(null),
-
+  static locales = Object.create(null);
   /** @private */
-  activeLocale: null,
 
+  static activeLocale = null;
   /** @private */
-  activeName: null,
 
+  static activeName = null;
   /**
    * Returns translation only if `locale` offers a non-empty translation for `id`.
    * Otherwise, returns `undefined`.
@@ -391,7 +396,8 @@ const Locale = {
    * @param {string} [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
    * @return {string}
    */
-  lookupTranslation: function lookupTranslation(id, locale) {
+
+  static lookupTranslation(id, locale) {
     const locale0 = locale && locale.toLowerCase();
     const loc = typeof locale == 'string' && this.locales[locale0] || this.activeLocale;
     const array = loc[id];
@@ -401,15 +407,16 @@ const Locale = {
     }
 
     return undefined;
-  },
-
+  }
   /**
    * By default, if no translation was found, returns `id`.
    * @param {string} id Message ID to translate
    * @param {string} [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
    * @return {string}
    */
-  gettext: function gettext(id, locale) {
+
+
+  static gettext(id, locale) {
     const text = this.lookupTranslation(id, locale);
 
     if (typeof text == 'undefined') {
@@ -417,21 +424,21 @@ const Locale = {
     }
 
     return text;
-  },
-
+  }
   /**
    * Register locale translations.
    * @param {string} locale Locale name (i.e.: `'he'`, `'fr'`)
    * @param {LocaleDate} data parsed data from a `.po` file.
    */
-  addLocale: function addLocale(locale, data) {
+
+
+  static addLocale(locale, data) {
     if (typeof data.contexts !== 'object' || typeof data.contexts[''] !== 'object') {
       throw new TypeError(`Locale '${locale}' invalid compact format`);
     }
 
     this.locales[locale.toLowerCase()] = data.contexts[''];
-  },
-
+  }
   /**
    * Activates a locale. Throws an error if the locale has not been previously added.
    * After setting the locale to be used, all strings marked for translations
@@ -439,7 +446,9 @@ const Locale = {
    * @param {string} locale Locale name (i.e: `'he'`, `'fr'`)
    * @return {LocaleData}
    */
-  useLocale: function useLocale(locale) {
+
+
+  static useLocale(locale) {
     const locale0 = locale.toLowerCase();
     const obj = this.locales[locale0];
 
@@ -450,30 +459,33 @@ const Locale = {
     this.activeName = alias[locale0] || locale0;
     this.activeLocale = obj;
     return this.activeLocale;
-  },
-
+  }
   /**
    * Returns the name of the active locale (i.e. 'he', 'ashkenazi', 'fr')
    * @return {string}
    */
-  getLocaleName: function getLocaleName() {
-    return this.activeName;
-  },
 
+
+  static getLocaleName() {
+    return this.activeName;
+  }
   /**
    * Returns the names of registered locales
    * @return {string[]}
    */
-  getLocaleNames: function getLocaleNames() {
-    return Object.keys(this.locales).sort();
-  },
 
+
+  static getLocaleNames() {
+    return Object.keys(this.locales).sort();
+  }
   /**
    * @param {number} n
    * @param {string} [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
    * @return {string}
    */
-  ordinal: function ordinal(n, locale) {
+
+
+  static ordinal(n, locale) {
     const locale1 = locale && locale.toLowerCase();
     const locale0 = locale1 || this.activeName;
 
@@ -502,28 +514,31 @@ const Locale = {
       default:
         return n + '.';
     }
-  },
-
+  }
   /**
    * @private
    * @param {number} n
    * @return {string}
    */
-  getEnOrdinal: function getEnOrdinal(n) {
+
+
+  static getEnOrdinal(n) {
     const s = ['th', 'st', 'nd', 'rd'];
     const v = n % 100;
     return n + (s[(v - 20) % 10] || s[v] || s[0]);
-  },
-
+  }
   /**
    * Removes nekudot from Hebrew string
    * @param {string} str
    * @return {string}
    */
-  hebrewStripNikkud: function hebrewStripNikkud(str) {
+
+
+  static hebrewStripNikkud(str) {
     return str.replace(/[\u0590-\u05bd]/g, '').replace(/[\u05bf-\u05c7]/g, '');
   }
-};
+
+}
 Locale.addLocale('en', noopLocale);
 Locale.addLocale('s', noopLocale);
 Locale.addLocale('', noopLocale);
@@ -3052,7 +3067,7 @@ const TZEIT_3MEDIUM_STARS = 7.083;
  * @param {HDate} hd
  * @param {number} dow
  * @param {Location} location
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @return {Event}
  */
 
@@ -4998,7 +5013,7 @@ function getBirthdayOrAnniversary_(hyear, gdate) {
   return new HDate(day, month, hyear);
 }
 
-var version="3.33.4";
+var version="3.33.5";
 
 var headers$1={"plural-forms":"nplurals=2; plural=(n > 1);",language:"en_CA@ashkenazi"};var contexts$1={"":{Berachot:["Berachos"],Shabbat:["Shabbos"],Taanit:["Taanis"],Yevamot:["Yevamos"],Ketubot:["Kesubos"],"Baba Batra":["Baba Basra"],Makkot:["Makkos"],Shevuot:["Shevuos"],Horayot:["Horayos"],Menachot:["Menachos"],Bechorot:["Bechoros"],Keritot:["Kerisos"],Midot:["Midos"],"Achrei Mot":["Achrei Mos"],Bechukotai:["Bechukosai"],"Beha'alotcha":["Beha'aloscha"],Bereshit:["Bereshis"],Chukat:["Chukas"],"Erev Shavuot":["Erev Shavuos"],"Erev Sukkot":["Erev Sukkos"],"Ki Tavo":["Ki Savo"],"Ki Teitzei":["Ki Seitzei"],"Ki Tisa":["Ki Sisa"],Matot:["Matos"],"Purim Katan":["Purim Koton"],Tazria:["Sazria"],"Shabbat Chazon":["Shabbos Chazon"],"Shabbat HaChodesh":["Shabbos HaChodesh"],"Shabbat HaGadol":["Shabbos HaGadol"],"Shabbat Nachamu":["Shabbos Nachamu"],"Shabbat Parah":["Shabbos Parah"],"Shabbat Shekalim":["Shabbos Shekalim"],"Shabbat Shuva":["Shabbos Shuvah"],"Shabbat Zachor":["Shabbos Zachor"],Shavuot:["Shavuos"],"Shavuot I":["Shavuos I"],"Shavuot II":["Shavuos II"],Shemot:["Shemos"],"Shmini Atzeret":["Shmini Atzeres"],"Simchat Torah":["Simchas Torah"],Sukkot:["Sukkos"],"Sukkot I":["Sukkos I"],"Sukkot II":["Sukkos II"],"Sukkot II (CH''M)":["Sukkos II (CH''M)"],"Sukkot III (CH''M)":["Sukkos III (CH''M)"],"Sukkot IV (CH''M)":["Sukkos IV (CH''M)"],"Sukkot V (CH''M)":["Sukkos V (CH''M)"],"Sukkot VI (CH''M)":["Sukkos VI (CH''M)"],"Sukkot VII (Hoshana Raba)":["Sukkos VII (Hoshana Raba)"],"Ta'anit Bechorot":["Ta'anis Bechoros"],"Ta'anit Esther":["Ta'anis Esther"],Toldot:["Toldos"],Vaetchanan:["Vaeschanan"],Yitro:["Yisro"],"Vezot Haberakhah":["Vezos Haberakhah"],Parashat:["Parshas"],"Leil Selichot":["Leil Selichos"],"Shabbat Mevarchim Chodesh":["Shabbos Mevorchim Chodesh"],"Shabbat Shirah":["Shabbos Shirah"],Tevet:["Teves"],"Asara B'Tevet":["Asara B'Teves"],Berakhot:["Berakhos"],Sheviit:["Sheviis"],Terumot:["Terumos"],Maasrot:["Maasros"],Eduyot:["Eduyos"],Avot:["Avos"],Bekhorot:["Bekhoros"],Middot:["Middos"],Oholot:["Oholos"],Tahorot:["Tahoros"],Mikvaot:["Mikvaos"]}};var poAshkenazi = {headers:headers$1,contexts:contexts$1};
 
@@ -5108,7 +5123,7 @@ const RECOGNIZED_OPTIONS = {
 };
 /**
  * @private
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  */
 
 function warnUnrecognizedOptions(options) {
@@ -5135,7 +5150,7 @@ function shallowCopy(target, source) {
 /**
  * Modifies options in-place
  * @private
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  */
 
 
@@ -5170,7 +5185,7 @@ function checkCandleOptions(options) {
 }
 /**
  * Options to configure which events are returned
- * @typedef {Object} HebrewCalendar.Options
+ * @typedef {Object} CalOptions
  * @property {Location} location - latitude/longitude/tzid used for candle-lighting
  * @property {number} year - Gregorian or Hebrew year
  * @property {boolean} isHebrewYear - to interpret year as Hebrew year
@@ -5226,7 +5241,7 @@ function getAbs(d) {
 /**
  * Parse options object to determine start & end days
  * @private
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @return {number[]}
  */
 
@@ -5303,7 +5318,7 @@ function getStartAndEnd(options) {
 /**
  * Mask to filter Holiday array
  * @private
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @return {number}
  */
 
@@ -5427,7 +5442,7 @@ function observedInDiaspora(ev) {
 
 class HebrewCalendar {
   /**
-   * Calculates holidays and other Hebrew calendar events based on {@link HebrewCalendar.Options}.
+   * Calculates holidays and other Hebrew calendar events based on {@link CalOptions}.
    *
    * Each holiday is represented by an {@link Event} object which includes a date,
    * a description, flags and optional attributes.
@@ -5523,7 +5538,7 @@ class HebrewCalendar {
    *   const date = hd.greg();
    *   console.log(date.toLocaleDateString(), ev.render(), hd.toString());
    * }
-   * @param {HebrewCalendar.Options} [options={}]
+   * @param {CalOptions} [options={}]
    * @return {Event[]}
    */
   static calendar(options = {}) {
@@ -5788,11 +5803,11 @@ class HebrewCalendar {
   }
   /**
    * Helper function to format a 23-hour (00:00-23:59) time in US format ("8:13pm") or
-   * keep as "20:13" for any other locale/country. Uses `HebrewCalendar.Options` to determine
+   * keep as "20:13" for any other locale/country. Uses `CalOptions` to determine
    * locale.
    * @param {string} timeStr - original time like "20:30"
    * @param {string} suffix - "p" or "pm" or " P.M.". Add leading space if you want it
-   * @param {HebrewCalendar.Options} options
+   * @param {CalOptions} options
    * @return {string}
    */
 
@@ -5843,7 +5858,7 @@ class HebrewCalendar {
  * @private
  * @param {Event[]} events
  * @param {Event} ev
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @param {Event} candlesEv
  * @param {number} dow
  * @return {Event}