@hebcal/core 5.2.0 → 5.2.2

package/hebcal.d.ts

@@ -1,5 +1,3 @@
-import { GeoLocation } from '@hebcal/noaa';
-
 declare module '@hebcal/core' {
     export const version: string;
 
@@ -91,6 +89,8 @@ declare module '@hebcal/core' {
         YERUSHALMI_YOMI = 0x1000000,
         /** Nach Yomi */
         NACH_YOMI = 0x2000000,
+        /** Daily Learning */
+        DAILY_LEARNING = 0x4000000,
     }
 
     export type UnitTypeShort = 'd' | 'w' | 'M' | 'y';
@@ -278,6 +278,54 @@ declare module '@hebcal/core' {
         static fromGematriyaString(str: string, currentThousands?: number): HDate;
     }
 
+    /**
+     * A class that contains location information such as latitude and longitude required for astronomical calculations. The
+     * elevation field may not be used by some calculation engines and would be ignored if set.
+     *
+     * @author © Eliyahu Hershfeld 2004 - 2016
+     * @version 1.1
+     */
+    export class GeoLocation {
+        /**
+         * GeoLocation constructor with parameters for all required fields.
+         *
+         * @param name
+         *            The location name for display use such as "Lakewood, NJ"
+         * @param latitude
+         *            the latitude in a double format such as 40.095965 for Lakewood, NJ.
+         *            <b>Note: </b> For latitudes south of the equator, a negative value should be used.
+         * @param longitude
+         *            longitude in a double format such as -74.222130 for Lakewood, NJ.
+         *            <b>Note: </b> For longitudes west of the <a href="http://en.wikipedia.org/wiki/Prime_Meridian">Prime
+         *            Meridian </a> (Greenwich), a negative value should be used.
+         * @param elevation
+         *            the elevation above sea level in Meters. Elevation is not used in most algorithms used for calculating
+         *            sunrise and set.
+         * @param timeZoneId
+         *            the <code>TimeZone</code> for the location.
+         */
+        constructor(name: string | null, latitude: number, longitude: number, elevation: number, timeZoneId: string);
+        /**
+         * get the elevation in Meters
+         * @return {number} Returns the elevation in Meters
+         */
+        getElevation(): number;
+        /**
+         * set the elevation in Meters <b>above </b> sea level
+         * @param elevation
+         *            The elevation to set in Meters. An Error will be thrown if the value is a negative.
+         */
+        setElevation(elevation: number): void;
+        setLatitude(latitude: number): void;
+        getLatitude(): number;
+        setLongitude(longitude: number): void;
+        getLongitude(): number;
+        getLocationName(): string | null;
+        setLocationName(name: string | null): void;
+        getTimeZone(): string;
+        setTimeZone(timeZoneId: string): void;
+    }
+
     /**
      * A Hebcal location is used for Zmanim and a latitude, longitude, timezone, and more
      */
@@ -504,7 +552,7 @@ declare module '@hebcal/core' {
          * @param id - Message ID to translate
          * @param [locale] - Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
          */
-        static lookupTranslation(id: string, locale?: string): string;
+        static lookupTranslation(id: string, locale?: string): string | undefined;
         /**
          * By default, if no translation was found, returns `id`.
          * @param id - Message ID to translate
@@ -707,7 +755,7 @@ declare module '@hebcal/core' {
          * @param date - Hebrew Date, Gregorian date, or absolute R.D. day number
          * @param il - use the Israeli schedule for holidays
          */
-        static getHolidaysOnDate(date: HDate | Date | number, il?: boolean): Event[];
+        static getHolidaysOnDate(date: HDate | Date | number, il?: boolean): Event[] | undefined;
 
         /**
          * Calculates a birthday or anniversary (non-yahrzeit).
@@ -730,7 +778,7 @@ declare module '@hebcal/core' {
          * @param gdate - Gregorian or Hebrew date of event
          * @returns anniversary occurring in hyear
          */
-        static getBirthdayOrAnniversary(hyear: number, gdate: Date | HDate): HDate;
+        static getBirthdayOrAnniversary(hyear: number, gdate: Date | HDate): HDate | undefined;
 
         /**
          * Calculates yahrzeit.
@@ -761,7 +809,7 @@ declare module '@hebcal/core' {
          * @param gdate - Gregorian or Hebrew date of death
          * @returns anniversary occurring in hyear
          */
-        static getYahrzeit(hyear: number, gdate: Date | HDate): HDate;
+        static getYahrzeit(hyear: number, gdate: Date | HDate): HDate | undefined;
 
         /**
          * Helper function to format a 23-hour (00:00-23:59) time in US format ("8:13pm") or

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/core",
-  "version": "5.2.0",
+  "version": "5.2.2",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "contributors": [
     "Eyal Schachter (https://github.com/Scimonster)",
@@ -68,14 +68,14 @@
     "verbose": true
   },
   "peerDependencies": {
-    "temporal-polyfill": "^0.1.1"
+    "temporal-polyfill": "^0.2.1"
   },
   "devDependencies": {
     "@babel/core": "^7.23.9",
     "@babel/preset-env": "^7.23.9",
     "@babel/register": "^7.23.7",
     "@hebcal/hdate": "^0.9.1",
-    "@hebcal/noaa": "^0.8.11",
+    "@hebcal/noaa": "^0.8.12",
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-json": "^6.1.0",
@@ -86,7 +86,7 @@
     "eslint": "^8.56.0",
     "eslint-config-google": "^0.14.0",
     "jsdoc": "^4.0.2",
-    "jsdoc-to-markdown": "^8.0.0",
+    "jsdoc-to-markdown": "^8.0.1",
     "nyc": "^15.1.0",
     "quick-lru": "^7.0.0",
     "rollup": "^4.9.6",