jcal-zmanim 1.3.2 → 1.5.0

package/dist/index.d.cts

@@ -61,7 +61,7 @@ declare class Sedra {
     static getDayOnOrBefore(day_of_week: number, date: number): number;
     static getSedraOrder(year: number, israel: boolean): {
         firstSatInYear: number;
-        sedraArray?: number[] | undefined;
+        sedraArray?: number[];
         year: number;
         israel: boolean;
     };
@@ -302,12 +302,28 @@ declare class jDate {
     static daysJMonth(year: number, month: number): number;
     /**Elapsed days since creation of the world until Rosh Hashana of the given year*/
     static tDays(year: number): number;
+    /**The index for the year type of the given year.
+     * IMPORTANT NOTE: Only works for years 5000 and after.
+     */
+    static yearType(year: number): {
+        isLeapYear: boolean;
+        dow: number;
+        isLongCheshvan: boolean;
+        isLongKislev: boolean;
+        daysInYear: number;
+    };
     /**number of days in the given Jewish Year.*/
     static daysJYear(year: number): number;
     /**Does Cheshvan for the given Jewish Year have 30 days?*/
     static isLongCheshvan(year: number): boolean;
     /**Does Kislev for the given Jewish Year have 29 days?*/
     static isShortKislev(year: number): boolean;
+    /**number of days in the given Jewish Year.*/
+    static daysJYear_(year: number): number;
+    /**Does Cheshvan for the given Jewish Year have 30 days?*/
+    static isLongCheshvan_(year: number): boolean;
+    /**Does Kislev for the given Jewish Year have 29 days?*/
+    static isShortKislev_(year: number): boolean;
     /**Does the given Jewish Year have 13 months?*/
     static isJdLeapY(year: number): boolean;
     /**number of months in Jewish Year.*/
@@ -569,9 +585,9 @@ declare class Utils {
         jdate: jDate;
     };
     /** Returns true if "thing" is either a string primitive or String object.*/
-    static isString(thing: unknown): boolean;
+    static isString(thing: unknown): thing is string | String;
     /** Returns true if "thing" is either a number primitive or a Number object.*/
-    static isNumber(thing: unknown): boolean;
+    static isNumber(thing: unknown): thing is number | Number;
     /** Returns true if "thing" is a Date object containing a valid date.*/
     static isValidDate(thing: unknown): boolean;
     /** Returns whether or not the given, array, string, or argument list contains the given item or substring.
@@ -766,6 +782,39 @@ declare const ZmanTypeIds: Readonly<{
 }>;
 /**
  * List of Zman Types. Used to acquire the Zmanim for a particular day.
+ *
+ * An array of objects representing different Zmanim (Jewish halachic times).
+ * Each object contains the following properties:
+ * - `id`: A unique identifier for the Zman.
+ * - `desc`: A description of the Zman in Hebrew.
+ * - `eng`: The English translation of the Zman.
+ * - `heb`: The Hebrew name of the Zman.
+ *
+ * The Zmanim included are:
+ * - Chatzos Layla (Midnight)
+ * - Alos Hashachar (Dawn) - 90 minutes
+ * - Alos Hashachar (Dawn) - 72 minutes
+ * - Taliss and Tefillin (36 minutes)
+ * - Sunrise at current elevation
+ * - Sunrise at sea level
+ * - Zman Krias Shma according to MG"A
+ * - Zman Krias Shma according to GR"A
+ * - Zman Tefilla according to MG"A
+ * - Zman Tefilla according to GR"A
+ * - Chatzos (Midday)
+ * - Mincha Gedola
+ * - Mincha Ketana
+ * - Plag HaMincha
+ * - Sunset at sea level
+ * - Sunset at current elevation
+ * - Nightfall (45 minutes after sunset)
+ * - Nightfall (50 minutes after sunset)
+ * - Rabbeinu Tam (72 minutes after sunset)
+ * - Rabbeinu Tam - Zmanios
+ * - Rabbeinu Tam - Zmanios MG"A
+ * - Candle lighting time
+ * - Stop eating Chometz
+ * - Destroy Chometz
  */
 declare const ZmanTypes: ZmanToShow[];
 /**
@@ -884,7 +933,7 @@ declare class ZmanimUtils {
      * @param {jDate} jdate
      * @param {Location} location
      */
-    static getWhichDays(date: Date, jdate: jDate, location: Location): 0 | 1 | 2 | 4 | 8 | 32 | 16 | 64 | 128;
+    static getWhichDays(date: Date, jdate: jDate, location: Location): 0 | 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128;
     /**
      * Returns the zmanim necessary for showing basic shul notifications: chatzosHayom, chatzosHalayla, alos
      * @param {jDate|Date} date
@@ -905,7 +954,7 @@ declare class ZmanimUtils {
     */
     static getAllZmanim(date: jDate | Date, location: Location): {
         zmanType: ZmanToShow;
-        time?: Time | undefined;
+        time?: Time;
     }[];
 }
 

package/dist/index.d.ts

@@ -61,7 +61,7 @@ declare class Sedra {
     static getDayOnOrBefore(day_of_week: number, date: number): number;
     static getSedraOrder(year: number, israel: boolean): {
         firstSatInYear: number;
-        sedraArray?: number[] | undefined;
+        sedraArray?: number[];
         year: number;
         israel: boolean;
     };
@@ -302,12 +302,28 @@ declare class jDate {
     static daysJMonth(year: number, month: number): number;
     /**Elapsed days since creation of the world until Rosh Hashana of the given year*/
     static tDays(year: number): number;
+    /**The index for the year type of the given year.
+     * IMPORTANT NOTE: Only works for years 5000 and after.
+     */
+    static yearType(year: number): {
+        isLeapYear: boolean;
+        dow: number;
+        isLongCheshvan: boolean;
+        isLongKislev: boolean;
+        daysInYear: number;
+    };
     /**number of days in the given Jewish Year.*/
     static daysJYear(year: number): number;
     /**Does Cheshvan for the given Jewish Year have 30 days?*/
     static isLongCheshvan(year: number): boolean;
     /**Does Kislev for the given Jewish Year have 29 days?*/
     static isShortKislev(year: number): boolean;
+    /**number of days in the given Jewish Year.*/
+    static daysJYear_(year: number): number;
+    /**Does Cheshvan for the given Jewish Year have 30 days?*/
+    static isLongCheshvan_(year: number): boolean;
+    /**Does Kislev for the given Jewish Year have 29 days?*/
+    static isShortKislev_(year: number): boolean;
     /**Does the given Jewish Year have 13 months?*/
     static isJdLeapY(year: number): boolean;
     /**number of months in Jewish Year.*/
@@ -569,9 +585,9 @@ declare class Utils {
         jdate: jDate;
     };
     /** Returns true if "thing" is either a string primitive or String object.*/
-    static isString(thing: unknown): boolean;
+    static isString(thing: unknown): thing is string | String;
     /** Returns true if "thing" is either a number primitive or a Number object.*/
-    static isNumber(thing: unknown): boolean;
+    static isNumber(thing: unknown): thing is number | Number;
     /** Returns true if "thing" is a Date object containing a valid date.*/
     static isValidDate(thing: unknown): boolean;
     /** Returns whether or not the given, array, string, or argument list contains the given item or substring.
@@ -766,6 +782,39 @@ declare const ZmanTypeIds: Readonly<{
 }>;
 /**
  * List of Zman Types. Used to acquire the Zmanim for a particular day.
+ *
+ * An array of objects representing different Zmanim (Jewish halachic times).
+ * Each object contains the following properties:
+ * - `id`: A unique identifier for the Zman.
+ * - `desc`: A description of the Zman in Hebrew.
+ * - `eng`: The English translation of the Zman.
+ * - `heb`: The Hebrew name of the Zman.
+ *
+ * The Zmanim included are:
+ * - Chatzos Layla (Midnight)
+ * - Alos Hashachar (Dawn) - 90 minutes
+ * - Alos Hashachar (Dawn) - 72 minutes
+ * - Taliss and Tefillin (36 minutes)
+ * - Sunrise at current elevation
+ * - Sunrise at sea level
+ * - Zman Krias Shma according to MG"A
+ * - Zman Krias Shma according to GR"A
+ * - Zman Tefilla according to MG"A
+ * - Zman Tefilla according to GR"A
+ * - Chatzos (Midday)
+ * - Mincha Gedola
+ * - Mincha Ketana
+ * - Plag HaMincha
+ * - Sunset at sea level
+ * - Sunset at current elevation
+ * - Nightfall (45 minutes after sunset)
+ * - Nightfall (50 minutes after sunset)
+ * - Rabbeinu Tam (72 minutes after sunset)
+ * - Rabbeinu Tam - Zmanios
+ * - Rabbeinu Tam - Zmanios MG"A
+ * - Candle lighting time
+ * - Stop eating Chometz
+ * - Destroy Chometz
  */
 declare const ZmanTypes: ZmanToShow[];
 /**
@@ -884,7 +933,7 @@ declare class ZmanimUtils {
      * @param {jDate} jdate
      * @param {Location} location
      */
-    static getWhichDays(date: Date, jdate: jDate, location: Location): 0 | 1 | 2 | 4 | 8 | 32 | 16 | 64 | 128;
+    static getWhichDays(date: Date, jdate: jDate, location: Location): 0 | 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128;
     /**
      * Returns the zmanim necessary for showing basic shul notifications: chatzosHayom, chatzosHalayla, alos
      * @param {jDate|Date} date
@@ -905,7 +954,7 @@ declare class ZmanimUtils {
     */
     static getAllZmanim(date: jDate | Date, location: Location): {
         zmanType: ZmanToShow;
-        time?: Time | undefined;
+        time?: Time;
     }[];
 }