Add more documentation and examples for HDate

Author: mjradwin

.editorconfig

@@ -0,0 +1,8 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+insert_final_newline = true

.eslintignore

@@ -0,0 +1,5 @@
+build/
+test/
+docs/
+dist/
+src/*.po.ts

.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "./node_modules/gts/"
+}

.prettierrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  ...require('gts/.prettierrc.json')
+}

jest.config.js

@@ -3,4 +3,4 @@ module.exports = {
   preset: 'ts-jest',
   verbose: true,
   testEnvironment: 'node',
-};
+};

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/hdate",
-  "version": "0.11.0",
+  "version": "0.11.1",
   "description": "converts between Hebrew and Gregorian dates using Rata Die (R.D.) algorithm by Dershowitz and Reingold",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "contributors": [

package.json

@@ -8,7 +8,7 @@ import {
   longCheshvan,
   SimpleHebrewDate,
 } from './hdate-base';
-import { abs2greg, greg2abs, isDate } from './greg';
+import {abs2greg, greg2abs, isDate} from './greg';
 
 const NISAN = months.NISAN;
 const CHESHVAN = months.CHESHVAN;

src/anniversary.ts

@@ -25,7 +25,7 @@ const dateFormatRegex = /^(\d+).(\d+).(\d+),?\s+(\d+).(\d+).(\d+)/;
 /**
  * Returns a string similar to `Date.toISOString()` but in the
  * timezone `tzid`. Contrary to the typical meaning of `Z` at the end
- * of the string, this is not actually a UTC date. 
+ * of the string, this is not actually a UTC date.
  */
 export function getPseudoISO(tzid: string, date: Date): string {
   const str = getFormatter(tzid).format(date);

src/dateFormat.ts

@@ -44,99 +44,95 @@ const ABS_2SEP1752 = 639785;
  * Formerly in namespace, now top-level
  */
 
-  /**
-   * Returns true if the Gregorian year is a leap year
-   * @param year Gregorian year
-   */
-  export function isGregLeapYear(year: number): boolean {
-    return !(year % 4) && (!!(year % 100) || !(year % 400));
-  }
+/**
+ * Returns true if the Gregorian year is a leap year
+ * @param year Gregorian year
+ */
+export function isGregLeapYear(year: number): boolean {
+  return !(year % 4) && (!!(year % 100) || !(year % 400));
+}
 
-  /**
-   * Number of days in the Gregorian month for given year
-   * @param month Gregorian month (1=January, 12=December)
-   * @param year Gregorian year
-   */
-  export function daysInGregMonth(month: number, year: number): number {
-    // 1 based months
-    return monthLengths[+isGregLeapYear(year)][month];
-  }
+/**
+ * Number of days in the Gregorian month for given year
+ * @param month Gregorian month (1=January, 12=December)
+ * @param year Gregorian year
+ */
+export function daysInGregMonth(month: number, year: number): number {
+  // 1 based months
+  return monthLengths[+isGregLeapYear(year)][month];
+}
 
-  /**
-   * Returns true if the object is a Javascript Date
-   */
-  export function isDate(obj: any): boolean {
-    // eslint-disable-next-line no-prototype-builtins
-    return typeof obj === 'object' && Date.prototype.isPrototypeOf(obj);
-  }
+/**
+ * Returns true if the object is a Javascript Date
+ */
+export function isDate(obj: any): boolean {
+  // eslint-disable-next-line no-prototype-builtins
+  return typeof obj === 'object' && Date.prototype.isPrototypeOf(obj);
+}
 
-  /**
-   * @private
-   * @param year
-   * @param month (1-12)
-   * @param day (1-31)
-   */
-  function toFixed(year: number, month: number, day: number): number {
-    const py: number = year - 1;
-    return (
-      365 * py +
-      quotient(py, 4) -
-      quotient(py, 100) +
-      quotient(py, 400) +
-      quotient(367 * month - 362, 12) +
-      (month <= 2 ? 0 : isGregLeapYear(year) ? -1 : -2) +
-      day
-    );
-  }
+/**
+ * @private
+ * @param year
+ * @param month (1-12)
+ * @param day (1-31)
+ */
+function toFixed(year: number, month: number, day: number): number {
+  const py: number = year - 1;
+  return (
+    365 * py +
+    quotient(py, 4) -
+    quotient(py, 100) +
+    quotient(py, 400) +
+    quotient(367 * month - 362, 12) +
+    (month <= 2 ? 0 : isGregLeapYear(year) ? -1 : -2) +
+    day
+  );
+}
 
-  /**
-   * Converts Gregorian date to absolute R.D. (Rata Die) days
-   * @param date Gregorian date
-   */
-  export function greg2abs(date: Date): number {
-    if (!isDate(date)) {
-      throw new TypeError(`Argument not a Date: ${date}`);
-    }
-    const abs = toFixed(
-      date.getFullYear(),
-      date.getMonth() + 1,
-      date.getDate()
-    );
-    /*
+/**
+ * Converts Gregorian date to absolute R.D. (Rata Die) days
+ * @param date Gregorian date
+ */
+export function greg2abs(date: Date): number {
+  if (!isDate(date)) {
+    throw new TypeError(`Argument not a Date: ${date}`);
+  }
+  const abs = toFixed(date.getFullYear(), date.getMonth() + 1, date.getDate());
+  /*
     if (abs < ABS_14SEP1752 && abs > ABS_2SEP1752) {
       throw new RangeError(`Invalid Date: ${date}`);
     }
     */
-    return abs;
-  }
+  return abs;
+}
 
-  /**
-   * Converts from Rata Die (R.D. number) to Gregorian date.
-   * See the footnote on page 384 of ``Calendrical Calculations, Part II:
-   * 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.
-   * @param abs - R.D. number of days
-   */
-  export function abs2greg(abs: number): Date {
-    if (typeof abs !== 'number') {
-      throw new TypeError(`Argument not a Number: ${abs}`);
-    }
-    abs = Math.trunc(abs);
-    /*
+/**
+ * Converts from Rata Die (R.D. number) to Gregorian date.
+ * See the footnote on page 384 of ``Calendrical Calculations, Part II:
+ * 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.
+ * @param abs - R.D. number of days
+ */
+export function abs2greg(abs: number): Date {
+  if (typeof abs !== 'number') {
+    throw new TypeError(`Argument not a Number: ${abs}`);
+  }
+  abs = Math.trunc(abs);
+  /*
     if (abs < ABS_14SEP1752 && abs > ABS_2SEP1752) {
       throw new RangeError(`Invalid Date: ${abs}`);
     }
     */
-    const year: number = yearFromFixed(abs);
-    const priorDays: number = abs - toFixed(year, 1, 1);
-    const correction: number =
-      abs < toFixed(year, 3, 1) ? 0 : isGregLeapYear(year) ? 1 : 2;
-    const month: number = quotient(12 * (priorDays + correction) + 373, 367);
-    const day: number = abs - toFixed(year, month, 1) + 1;
-    const dt: Date = new Date(year, month - 1, day);
-    if (year < 100 && year >= 0) {
-      dt.setFullYear(year);
-    }
-    return dt;
+  const year: number = yearFromFixed(abs);
+  const priorDays: number = abs - toFixed(year, 1, 1);
+  const correction: number =
+    abs < toFixed(year, 3, 1) ? 0 : isGregLeapYear(year) ? 1 : 2;
+  const month: number = quotient(12 * (priorDays + correction) + 373, 367);
+  const day: number = abs - toFixed(year, month, 1) + 1;
+  const dt: Date = new Date(year, month - 1, day);
+  if (year < 100 && year >= 0) {
+    dt.setFullYear(year);
   }
+  return dt;
+}

src/greg.ts

@@ -1,4 +1,11 @@
-import { abs2greg, daysInGregMonth, greg2abs, isDate, isGregLeapYear } from './greg';
+/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-namespace */
+import {
+  abs2greg,
+  daysInGregMonth,
+  greg2abs,
+  isDate,
+  isGregLeapYear,
+} from './greg';
 
 /**
  * Gregorian date helper functions
@@ -9,7 +16,7 @@ export namespace greg {
   export declare function greg2abs(date: Date): number;
   export declare function isDate(obj: any): boolean;
   export declare function isLeapYear(year: number): boolean;
-};
+}
 
 greg.abs2greg = abs2greg;
 greg.daysInMonth = daysInGregMonth;