@hebcal/core 5.7.4 → 5.7.6

package/dist/bundle.js

@@ -1,9 +1,9 @@
-/*! @hebcal/core v5.7.4 */
+/*! @hebcal/core v5.7.6 */
 var hebcal = (function (exports) {
 'use strict';
 
 /** DO NOT EDIT THIS AUTO-GENERATED FILE! */
-const version = '5.7.4';
+const version = '5.7.6';
 
 /* eslint-disable @typescript-eslint/no-namespace, no-inner-declarations */
 /** @private */
@@ -101,7 +101,18 @@ function greg2abs(date) {
  * Three Historical Calendars'' by E. M. Reingold,  N. Dershowitz, and S. M.
  * Clamen, Software--Practice and Experience, Volume 23, Number 4
  * (April, 1993), pages 383-404 for an explanation.
+ *
+ * Note that this function returns the daytime portion of the date.
+ * For example, the 15th of Cheshvan 5769 began at sundown on
+ * 12 November 2008 and continues through 13 November 2008. This
+ * function would return only the date 13 November 2008.
  * @param abs - R.D. number of days
+ * @example
+ * const abs = hebrew2abs(5769, months.CHESHVAN, 15);
+ * const date = abs2greg(abs); // 13 November 2008
+ * const year = date.getFullYear(); // 2008
+ * const monthNum = date.getMonth() + 1; // 11
+ * const day = date.getDate(); // 13
  */
 function abs2greg(abs) {
   if (typeof abs !== 'number') {
@@ -212,6 +223,8 @@ function assertNumber(n, name) {
  * @param year Hebrew year
  * @param month Hebrew month
  * @param day Hebrew date (1-30)
+ * @example
+ * const abs = hebrew2abs(5769, months.CHESHVAN, 15);
  */
 function hebrew2abs(year, month, day) {
   assertNumber(year, 'year');
@@ -1430,13 +1443,20 @@ class HDate {
   }
   /**
    * Converts this Hebrew date to the corresponding Gregorian date.
+   *
+   * The returned `Date` object will be in the local (i.e. host system) time zone.
+   * Hours, minutes, seconds and milliseconds will all be zero.
+   *
    * Note that this function returns the daytime portion of the date.
    * For example, the 15th of Cheshvan 5769 began at sundown on
    * 12 November 2008 and continues through 13 November 2008. This
    * function would return only the date 13 November 2008.
    * @example
    * const hd = new HDate(15, 'Cheshvan', 5769);
-   * hd.greg(); // 13 November 2008
+   * const date = hd.greg(); // 13 November 2008
+   * const year = date.getFullYear(); // 2008
+   * const monthNum = date.getMonth() + 1; // 11
+   * const day = date.getDate(); // 13
    */
   greg() {
     return abs2greg(this.abs());