@hebcal/core 5.4.8 → 5.4.10

package/dist/zmanim.d.ts

@@ -34,10 +34,10 @@ export declare class Zmanim {
     private useElevation;
     /**
      * Initialize a Zmanim instance.
-     * @param {GeoLocation} gloc GeoLocation including latitude, longitude, and timezone
-     * @param {Date|HDate} date Regular or Hebrew Date. If `date` is a regular `Date`,
+     * @param gloc GeoLocation including latitude, longitude, and timezone
+     * @param date Regular or Hebrew Date. If `date` is a regular `Date`,
      *    hours, minutes, seconds and milliseconds are ignored.
-     * @param {boolean} useElevation use elevation for calculations (default `false`).
+     * @param useElevation use elevation for calculations (default `false`).
      *    If `true`, use elevation to affect the calculation of all sunrise/sunset based
      *    zmanim. Note: there are some zmanim such as degree-based zmanim that are driven
      *    by the amount of light in the sky and are not impacted by elevation.
@@ -47,115 +47,98 @@ export declare class Zmanim {
     /**
      * Returns `true` if elevation adjustment is enabled
      * for zmanim support elevation adjustment
-     * @return {boolean}
      */
     getUseElevation(): boolean;
     /**
      * Enables or disables elevation adjustment for zmanim support elevation adjustment
-     * @param {boolean} useElevation
+     * @param useElevation
      */
     setUseElevation(useElevation: boolean): void;
     /**
      * Convenience function to get the time when sun is above or below the horizon
      * for a certain angle (in degrees).
      * This function does not support elevation adjustment.
-     * @param {number} angle
-     * @param {boolean} rising
-     * @return {Date}
+     * @param angle
+     * @param rising
      */
     timeAtAngle(angle: number, rising: boolean): Date;
     /**
      * Upper edge of the Sun appears over the eastern horizon in the morning (0.833° above horizon)
      * If elevation is enabled, this function will include elevation in the calculation.
-     * @return {Date}
      */
     sunrise(): Date;
     /**
      * Upper edge of the Sun appears over the eastern horizon in the morning (0.833° above horizon).
      * This function does not support elevation adjustment.
-     * @return {Date}
      */
     seaLevelSunrise(): Date;
     /**
      * When the upper edge of the Sun disappears below the horizon (0.833° below horizon).
      * If elevation is enabled, this function will include elevation in the calculation.
-     * @return {Date}
      */
     sunset(): Date;
     /**
      * When the upper edge of the Sun disappears below the horizon (0.833° below horizon).
      * This function does not support elevation adjustment.
-     * @return {Date}
      */
     seaLevelSunset(): Date;
     /**
      * Civil dawn; Sun is 6° below the horizon in the morning.
      * Because degree-based functions estimate the amount of light in the sky,
      * the result is not impacted by elevation.
-     * @return {Date}
      */
     dawn(): Date;
     /**
      * Civil dusk; Sun is 6° below the horizon in the evening.
      * Because degree-based functions estimate the amount of light in the sky,
      * the result is not impacted by elevation.
-     * @return {Date}
      */
     dusk(): Date;
     /**
      * Returns sunset for the previous day.
      * If elevation is enabled, this function will include elevation in the calculation.
-     * @return {Date}
      */
     gregEve(): Date;
     /**
      * @private
-     * @return {number}
      */
     nightHour(): number;
     /**
      * Midday – Chatzot; Sunrise plus 6 halachic hours
-     * @return {Date}
      */
     chatzot(): Date;
     /**
      * Midnight – Chatzot; Sunset plus 6 halachic hours.
      * If elevation is enabled, this function will include elevation in the calculation.
-     * @return {Date}
      */
     chatzotNight(): Date;
     /**
      * Dawn – Alot haShachar; Sun is 16.1° below the horizon in the morning.
      * Because degree-based functions estimate the amount of light in the sky,
      * the result is not impacted by elevation.
-     * @return {Date}
      */
     alotHaShachar(): Date;
     /**
      * Earliest talis & tefillin – Misheyakir; Sun is 11.5° below the horizon in the morning.
      * Because degree-based functions estimate the amount of light in the sky,
      * the result is not impacted by elevation.
-     * @return {Date}
      */
     misheyakir(): Date;
     /**
      * Earliest talis & tefillin – Misheyakir Machmir; Sun is 10.2° below the horizon in the morning.
      * Because degree-based functions estimate the amount of light in the sky,
      * the result is not impacted by elevation.
-     * @return {Date}
      */
     misheyakirMachmir(): Date;
     /**
      * Utility method for using elevation-aware sunrise/sunset
      * @private
-     * @param {number} hours
-     * @return {Date}
+     * @param hours
      */
     getShaahZmanisBasedZman(hours: number): Date;
     /**
      * Latest Shema (Gra); Sunrise plus 3 halachic hours, according to the Gra.
      * If elevation is enabled, this function will include elevation in the calculation.
-     * @return {Date}
      */
     sofZmanShma(): Date;
     /**
@@ -167,7 +150,6 @@ export declare class Zmanim {
      * to the [GRA](https://en.wikipedia.org/wiki/Vilna_Gaon).
      *
      * If elevation is enabled, this function will include elevation in the calculation.
-     * @return {Date}
      */
     sofZmanTfilla(): Date;
     /**
@@ -185,14 +167,12 @@ export declare class Zmanim {
      * Based on the opinion of the MGA that the day is calculated from
      * dawn being fixed 72 minutes before sea-level sunrise, and nightfall is fixed
      * 72 minutes after sea-level sunset.
-     * @return {Date}
      */
     sofZmanShmaMGA(): Date;
     /**
      * Latest Shema (MGA); Sunrise plus 3 halachic hours, according to Magen Avraham.
      * Based on the opinion of the MGA that the day is calculated from
      * dawn to nightfall with both being 16.1° below the horizon.
-     * @return {Date}
      */
     sofZmanShmaMGA16Point1(): Date;
     /**
@@ -203,19 +183,16 @@ export declare class Zmanim {
      * This calculation is based on the position of the sun 90 minutes after sunset in Jerusalem
      * around the equinox / equilux which calculates to 19.8° below geometric zenith.
      * https://kosherjava.com/2022/01/12/equinox-vs-equilux-zmanim-calculations/
-     * @return {Date}
      */
     sofZmanShmaMGA19Point8(): Date;
     /**
      * Latest Shacharit (MGA); Sunrise plus 4 halachic hours, according to Magen Avraham
-     * @return {Date}
      */
     sofZmanTfillaMGA(): Date;
     /**
      * Latest Shacharit (MGA); Sunrise plus 4 halachic hours, according to Magen Avraham.
      * Based on the opinion of the MGA that the day is calculated from
      * dawn to nightfall with both being 16.1° below the horizon.
-     * @return {Date}
      */
     sofZmanTfillaMGA16Point1(): Date;
     /**
@@ -226,7 +203,6 @@ export declare class Zmanim {
      * This calculation is based on the position of the sun 90 minutes after sunset in Jerusalem
      * around the equinox / equilux which calculates to 19.8° below geometric zenith.
      * https://kosherjava.com/2022/01/12/equinox-vs-equilux-zmanim-calculations/
-     * @return {Date}
      */
     sofZmanTfillaMGA19Point8(): Date;
     /**
@@ -241,7 +217,6 @@ export declare class Zmanim {
      * The Ramba"m is of the opinion that it is better to delay *mincha* until
      * *mincha ketana* while the Ra"sh, Tur, GRA and others are of the
      * opinion that *mincha* can be prayed *lechatchila* starting at *mincha gedola*.
-     * @return {Date}
      */
     minchaGedola(): Date;
     /**
@@ -251,7 +226,6 @@ export declare class Zmanim {
      * This method returns the time of *mincha gedola* according to the Magen Avraham
      * with the day starting 72 minutes before sunrise and ending 72 minutes after sunset.
      * This is the earliest time to pray *mincha*.
-     * @return {Date}
      */
     minchaGedolaMGA(): Date;
     /**
@@ -263,7 +237,6 @@ export declare class Zmanim {
      * that is 9.5 *shaos zmaniyos* (solar hours) after sunrise or sea level sunrise
      * (depending on the `useElevation` setting), according
      * to the [GRA](https://en.wikipedia.org/wiki/Vilna_Gaon).
-     * @return {Date}
      */
     minchaKetana(): Date;
     /**
@@ -273,31 +246,26 @@ export declare class Zmanim {
      * the [Rambam](https://en.wikipedia.org/wiki/Maimonides) and others.
      *
      * If elevation is enabled, this function will include elevation in the calculation.
-     * @return {Date}
      */
     minchaKetanaMGA(): Date;
     /**
      * Plag haMincha; Sunrise plus 10.75 halachic hours.
      * If elevation is enabled, this function will include elevation in the calculation.
-     * @return {Date}
      */
     plagHaMincha(): Date;
     /**
-     * @param {number} [angle=8.5] optional time for solar depression.
+     * @param [angle=8.5] optional time for solar depression.
      *   Default is 8.5 degrees for 3 small stars, use 7.083 degrees for 3 medium-sized stars.
      * Because degree-based functions estimate the amount of light in the sky,
      * the result is not impacted by elevation.
-     * @return {Date}
      */
     tzeit(angle?: number): Date;
     /**
      * Alias for sunrise
-     * @return {Date}
      */
     neitzHaChama(): Date;
     /**
      * Alias for sunset
-     * @return {Date}
      */
     shkiah(): Date;
     /**
@@ -307,54 +275,45 @@ export declare class Zmanim {
      * it is 13.5 minutes before tzies 7.083.
      * Because degree-based functions estimate the amount of light in the sky,
      * the result is not impacted by elevation.
-     * @return {Date}
      */
     beinHaShmashos(): Date;
     /**
      * Uses timeFormat to return a date like '20:34'
-     * @param {Date} dt
-     * @param {Intl.DateTimeFormat} timeFormat
-     * @return {string}
      */
     static formatTime(dt: Date, timeFormat: Intl.DateTimeFormat): string;
     /**
      * Discards seconds, rounding to nearest minute.
-     * @param {Date} dt
-     * @return {Date}
+     * @param dt
      */
     static roundTime(dt: Date): Date;
     /**
      * Get offset string (like "+05:00" or "-08:00") from tzid (like "Europe/Moscow")
-     * @param {string} tzid
-     * @param {Date} date
-     * @return {string}
+     * @param tzid
+     * @param date
      */
     static timeZoneOffset(tzid: string, date: Date): string;
     /**
      * Returns a string like "2022-04-01T13:06:00-11:00"
-     * @param {string} tzid
-     * @param {Date} date
-     * @return {string}
+     * @param tzid
+     * @param date
      */
     static formatISOWithTimeZone(tzid: string, date: Date): string;
     /**
      * Returns sunrise + `offset` minutes (either positive or negative).
      * If elevation is enabled, this function will include elevation in the calculation
      *  unless `forceSeaLevel` is `true`.
-     * @param {number} offset minutes
-     * @param {boolean} roundMinute round time to nearest minute (default true)
-     * @param {boolean} forceSeaLevel use sea-level sunrise (default false)
-     * @return {Date}
+     * @param offset minutes
+     * @param roundMinute round time to nearest minute (default true)
+     * @param forceSeaLevel use sea-level sunrise (default false)
      */
     sunriseOffset(offset: number, roundMinute?: boolean, forceSeaLevel?: boolean): Date;
     /**
      * Returns sunset + `offset` minutes (either positive or negative).
      * If elevation is enabled, this function will include elevation in the calculation
      *  unless `forceSeaLevel` is `true`.
-     * @param {number} offset minutes
-     * @param {boolean} roundMinute round time to nearest minute (default true)
-     * @param {boolean} forceSeaLevel use sea-level sunset (default false)
-     * @return {Date}
+     * @param offset minutes
+     * @param roundMinute round time to nearest minute (default true)
+     * @param forceSeaLevel use sea-level sunset (default false)
      */
     sunsetOffset(offset: number, roundMinute?: boolean, forceSeaLevel?: boolean): Date;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/core",
-  "version": "5.4.8",
+  "version": "5.4.10",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "contributors": [
     "Eyal Schachter (https://github.com/Scimonster)",
@@ -49,11 +49,13 @@
     "prepublish": "npm run build",
     "version": "node ./version.cjs package.json src/pkgVersion.ts",
     "po2json": "node ./po2json.cjs po/*.po",
-    "readme": "cp dist/index.mjs tmp.js && npx -p jsdoc-to-markdown jsdoc2md tmp.js && rm -f tmp.js",
+    "docs": "typedoc",
     "pretest": "npm run build",
-    "lint": "eslint src",
+    "lint": "gts lint",
     "coverage": "jest --coverage",
-    "test": "jest"
+    "test": "jest",
+    "clean": "gts clean",
+    "fix": "gts fix"
   },
   "license": "GPL-2.0",
   "overrides": {
@@ -65,8 +67,8 @@
     "temporal-polyfill": "^0.2.4"
   },
   "devDependencies": {
-    "@babel/core": "^7.24.7",
-    "@babel/preset-env": "^7.24.7",
+    "@babel/core": "^7.24.9",
+    "@babel/preset-env": "^7.24.8",
     "@babel/preset-typescript": "^7.24.7",
     "@babel/register": "^7.24.6",
     "@rollup/plugin-babel": "^6.0.4",
@@ -76,19 +78,18 @@
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^11.1.6",
     "@types/jest": "^29.5.12",
+    "@types/node": "^20.14.10",
     "core-js": "^3.37.1",
-    "eslint": "<=8.57.0",
-    "eslint-config-google": "^0.14.0",
+    "gts": "^5.3.1",
     "jest": "^29.7.0",
-    "jsdoc": "^4.0.3",
-    "jsdoc-to-markdown": "^8.0.1",
     "quick-lru": "<=6.1.2",
-    "rollup": "^4.18.0",
+    "rollup": "^4.18.1",
     "ttag-cli": "^1.10.12",
+    "typedoc": "^0.26.4",
     "typescript": "^5.5.3"
   },
   "dependencies": {
-    "@hebcal/hdate": "^0.10.1",
+    "@hebcal/hdate": "^0.11.1",
     "@hebcal/noaa": "^0.8.14",
     "tslib": "^2.6.3"
   }