jcal-zmanim 1.0.4

package/build/JCal/Zmanim.d.ts

@@ -0,0 +1,95 @@
+import jDate from './jDate.js';
+import Location from './Location.js';
+import { SunTimes, Time } from '../jcal-zmanim.js';
+/**
+ * Computes the daily Zmanim for any single date at any location.
+ * The astronomical and mathematical calculations were directly adapted from the excellent
+ * Jewish calendar calculation in C# Copyright © by Ulrich and Ziporah Greve (2005)
+ */
+export default class Zmanim {
+    /**
+     * Gets sunrise and sunset time for given date and Location.
+     * Accepts a javascript Date object, a string for creating a javascript date object or a jDate object.
+     * Location object is required.
+     * @returns {SunTimes}
+     * @param {Date | jDate} date A Javascript Date or Jewish Date for which to calculate the sun times.
+     * @param {Location} location Where on the globe to calculate the sun times for.
+     * @param {Boolean} considerElevation
+     */
+    static getSunTimes(date: Date | jDate, location: Location, considerElevation?: boolean): SunTimes;
+    /**
+     * @param {jDate | Date} date
+     * @param {Location} location
+     */
+    static getChatzos(date: jDate | Date, location: Location): Time;
+    /**
+     * @param {SunTimes} sunTimes
+     */
+    static getChatzosFromSuntimes(sunTimes: SunTimes): Time;
+    /**
+     * @param {jDate | Date} date
+     * @param {Location} location
+     * @param {any} offset
+     */
+    static getShaaZmanis(date: jDate | Date, location: Location, offset: number): number;
+    /**
+     * @param {{ sunrise: any; sunset: any; }} sunTimes
+     * @param {number} [offset]
+     */
+    static getShaaZmanisFromSunTimes(sunTimes: SunTimes, offset?: number): number;
+    /**
+     * @param {{ sunrise: any; sunset: any; }} sunTimes
+     * @param {boolean} israel
+     */
+    static getShaaZmanisMga(sunTimes: SunTimes, israel: boolean): number;
+    /**
+     * @param {jDate | Date} date
+     * @param {Location} location
+     */
+    static getCandleLighting(date: Date | jDate, location: Location): Time | undefined;
+    /**
+     * @param {SunTimes} sunTimes
+     * @param {any} location
+     */
+    static getCandleLightingFromSunTimes(sunTimes: SunTimes, location: Location): Time | undefined;
+    /**
+     * @param {Time} sunset
+     * @param {Location} location
+     */
+    static getCandleLightingFromSunset(sunset: Time, location: Location): Time | undefined;
+    /**
+     * @param {Date} date
+     */
+    static dayOfYear(date: Date): number;
+    /**
+     * @param {number} deg
+     * @param {number} min
+     */
+    static degToDec(deg: number, min: number): number;
+    /**
+     * @param {number} x
+     */
+    static M(x: number): number;
+    /**
+     * @param {number} x
+     */
+    static L(x: number): number;
+    /**
+     * @param {number} x
+     */
+    static adj(x: number): number;
+    /**
+     * @param {number} rad
+     */
+    static radToDeg(rad: number): number;
+    /**
+     * @param {number} time
+     * @param {Date} date
+     * @param {Location} location
+     */
+    static timeAdj(time: number, date: Date, location: Location): {
+        hour: number;
+        minute: number;
+        second: number;
+    };
+}

package/build/JCal/Zmanim.js

@@ -0,0 +1,224 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Utils_js_1 = __importDefault(require("./Utils.js"));
+const jDate_js_1 = __importDefault(require("./jDate.js"));
+const GeneralUtils_js_1 = require("../GeneralUtils.js");
+/**
+ * Computes the daily Zmanim for any single date at any location.
+ * The astronomical and mathematical calculations were directly adapted from the excellent
+ * Jewish calendar calculation in C# Copyright © by Ulrich and Ziporah Greve (2005)
+ */
+class Zmanim {
+    /**
+     * Gets sunrise and sunset time for given date and Location.
+     * Accepts a javascript Date object, a string for creating a javascript date object or a jDate object.
+     * Location object is required.
+     * @returns {SunTimes}
+     * @param {Date | jDate} date A Javascript Date or Jewish Date for which to calculate the sun times.
+     * @param {Location} location Where on the globe to calculate the sun times for.
+     * @param {Boolean} considerElevation
+     */
+    static getSunTimes(date, location, considerElevation = true) {
+        if (date instanceof jDate_js_1.default) {
+            date = date.getDate();
+        }
+        else if (date instanceof String) {
+            date = new Date(date);
+        }
+        if (!(0, GeneralUtils_js_1.isValidDate)(date)) {
+            throw 'Zmanim.getSunTimes: supplied date parameter cannot be converted to a Date';
+        }
+        let sunrise, sunset, zenithDeg = 90, zenithMin = 50, lonHour = 0, longitude = 0, latitude = 0, cosLat = 0, sinLat = 0, cosZen = 0, sinDec = 0, cosDec = 0, xmRise = 0, xmSet = 0, xlRise = 0, xlSet = 0, aRise = 0, aSet = 0, ahrRise = 0, ahrSet = 0, hRise = 0, hSet = 0, tRise = 0, tSet = 0, utRise = 0, utSet = 0;
+        const day = Zmanim.dayOfYear(date), earthRadius = 6356900, zenithAtElevation = Zmanim.degToDec(zenithDeg, zenithMin) +
+            Zmanim.radToDeg(Math.acos(earthRadius / (earthRadius +
+                (considerElevation ? location.Elevation : 0))));
+        zenithDeg = Math.floor(zenithAtElevation);
+        zenithMin = (zenithAtElevation - zenithDeg) * 60;
+        cosZen = Math.cos(0.01745 * Zmanim.degToDec(zenithDeg, zenithMin));
+        longitude = location.Longitude;
+        lonHour = longitude / 15;
+        latitude = location.Latitude;
+        cosLat = Math.cos(0.01745 * latitude);
+        sinLat = Math.sin(0.01745 * latitude);
+        tRise = day + (6 + lonHour) / 24;
+        tSet = day + (18 + lonHour) / 24;
+        xmRise = Zmanim.M(tRise);
+        xlRise = Zmanim.L(xmRise);
+        xmSet = Zmanim.M(tSet);
+        xlSet = Zmanim.L(xmSet);
+        aRise = 57.29578 * Math.atan(0.91746 * Math.tan(0.01745 * xlRise));
+        aSet = 57.29578 * Math.atan(0.91746 * Math.tan(0.01745 * xlSet));
+        if (Math.abs(aRise + 360 - xlRise) > 90) {
+            aRise += 180;
+        }
+        if (aRise > 360) {
+            aRise -= 360;
+        }
+        if (Math.abs(aSet + 360 - xlSet) > 90) {
+            aSet += 180;
+        }
+        if (aSet > 360) {
+            aSet -= 360;
+        }
+        ahrRise = aRise / 15;
+        sinDec = 0.39782 * Math.sin(0.01745 * xlRise);
+        cosDec = Math.sqrt(1 - sinDec * sinDec);
+        hRise = (cosZen - sinDec * sinLat) / (cosDec * cosLat);
+        ahrSet = aSet / 15;
+        sinDec = 0.39782 * Math.sin(0.01745 * xlSet);
+        cosDec = Math.sqrt(1 - sinDec * sinDec);
+        hSet = (cosZen - sinDec * sinLat) / (cosDec * cosLat);
+        if (Math.abs(hRise) <= 1) {
+            hRise = 57.29578 * Math.acos(hRise);
+            utRise = ((360 - hRise) / 15) + ahrRise + Zmanim.adj(tRise) + lonHour;
+            sunrise = Zmanim.timeAdj(utRise + location.UTCOffset, date, location);
+            if (sunrise.hour > 12) {
+                sunrise.hour -= 12;
+            }
+        }
+        if (Math.abs(hSet) <= 1) {
+            hSet = 57.29578 * Math.acos(hSet);
+            utSet = (hRise / 15) + ahrSet + Zmanim.adj(tSet) + lonHour;
+            sunset = Zmanim.timeAdj(utSet + location.UTCOffset, date, location);
+            if (sunset.hour > 0 && sunset.hour < 12) {
+                sunset.hour += 12;
+            }
+        }
+        return { sunrise: sunrise, sunset: sunset };
+    }
+    /**
+     * @param {jDate | Date} date
+     * @param {Location} location
+     */
+    static getChatzos(date, location) {
+        return Zmanim.getChatzosFromSuntimes(Zmanim.getSunTimes(date, location, false));
+    }
+    /**
+     * @param {SunTimes} sunTimes
+     */
+    static getChatzosFromSuntimes(sunTimes) {
+        const rise = sunTimes.sunrise, set = sunTimes.sunset;
+        if (rise === undefined || isNaN(rise.hour) || set === undefined || isNaN(set.hour)) {
+            return { hour: NaN, minute: NaN };
+        }
+        const chatz = Utils_js_1.default.toInt((Utils_js_1.default.totalSeconds(set) - Utils_js_1.default.totalSeconds(rise)) / 2);
+        return Utils_js_1.default.addSeconds(rise, chatz);
+    }
+    /**
+     * @param {jDate | Date} date
+     * @param {Location} location
+     * @param {any} offset
+     */
+    static getShaaZmanis(date, location, offset) {
+        return Zmanim.getShaaZmanisFromSunTimes(Zmanim.getSunTimes(date, location, false), offset);
+    }
+    /**
+     * @param {{ sunrise: any; sunset: any; }} sunTimes
+     * @param {number} [offset]
+     */
+    static getShaaZmanisFromSunTimes(sunTimes, offset) {
+        if (!sunTimes || !sunTimes.sunrise || !sunTimes.sunset) {
+            return 0;
+        }
+        let rise = sunTimes.sunrise, set = sunTimes.sunset;
+        if (!rise || isNaN(rise.hour) || !set || isNaN(set.hour)) {
+            return NaN;
+        }
+        if (offset) {
+            rise = Utils_js_1.default.addMinutes(rise, -offset);
+            set = Utils_js_1.default.addMinutes(set, offset);
+        }
+        return (Utils_js_1.default.totalSeconds(set) - Utils_js_1.default.totalSeconds(rise)) / 720;
+    }
+    /**
+     * @param {{ sunrise: any; sunset: any; }} sunTimes
+     * @param {boolean} israel
+     */
+    static getShaaZmanisMga(sunTimes, israel) {
+        const minutes = israel ? 90 : 72;
+        let rise = sunTimes.sunrise && Utils_js_1.default.addMinutes(sunTimes.sunrise, -minutes), set = sunTimes.sunset && Utils_js_1.default.addMinutes(sunTimes.sunset, minutes);
+        if (!rise || isNaN(rise.hour) || !set || isNaN(set.hour)) {
+            return NaN;
+        }
+        return (Utils_js_1.default.totalSeconds(set) - Utils_js_1.default.totalSeconds(rise)) / 720;
+    }
+    /**
+     * @param {jDate | Date} date
+     * @param {Location} location
+     */
+    static getCandleLighting(date, location) {
+        return Zmanim.getCandleLightingFromSunTimes(Zmanim.getSunTimes(date, location), location);
+    }
+    /**
+     * @param {SunTimes} sunTimes
+     * @param {any} location
+     */
+    static getCandleLightingFromSunTimes(sunTimes, location) {
+        return sunTimes.sunset && Zmanim.getCandleLightingFromSunset(sunTimes.sunset, location);
+    }
+    /**
+     * @param {Time} sunset
+     * @param {Location} location
+     */
+    static getCandleLightingFromSunset(sunset, location) {
+        return Utils_js_1.default.addMinutes(sunset, -(location.CandleLighting || 0));
+    }
+    /**
+     * @param {Date} date
+     */
+    static dayOfYear(date) {
+        const month = date.getMonth(), isLeap = () => Utils_js_1.default.isSecularLeapYear(date.getFullYear()), yearDay = [0, 1, 32, 60, 91, 121, 152, 182, 213, 244, 274, 305, 335];
+        return yearDay[month + 1] + date.getDate() + ((month > 1 && isLeap()) ? 1 : 0);
+    }
+    /**
+     * @param {number} deg
+     * @param {number} min
+     */
+    static degToDec(deg, min) {
+        return (deg + min / 60);
+    }
+    /**
+     * @param {number} x
+     */
+    static M(x) {
+        return (0.9856 * x - 3.251);
+    }
+    /**
+     * @param {number} x
+     */
+    static L(x) {
+        return (x + 1.916 * Math.sin(0.01745 * x) + 0.02 * Math.sin(2 * 0.01745 * x) + 282.565);
+    }
+    /**
+     * @param {number} x
+     */
+    static adj(x) {
+        return (-0.06571 * x - 6.62);
+    }
+    /**
+     * @param {number} rad
+     */
+    static radToDeg(rad) {
+        return 57.29578 * rad;
+    }
+    /**
+     * @param {number} time
+     * @param {Date} date
+     * @param {Location} location
+     */
+    static timeAdj(time, date, location) {
+        if (time < 0) {
+            time += 24;
+        }
+        let hour = Utils_js_1.default.toInt(time);
+        const minFloat = (time - hour) * 60 + 0.5, min = Utils_js_1.default.toInt(minFloat), sec = Math.round(60.0 * (minFloat - min));
+        if (Utils_js_1.default.isDST(location, date)) {
+            hour++;
+        }
+        return Utils_js_1.default.fixTime({ hour: hour, minute: min, second: sec });
+    }
+}
+exports.default = Zmanim;

package/build/JCal/jDate.d.ts

@@ -0,0 +1,203 @@
+import Sedra from './Sedra.js';
+import Location from './Location';
+/** Represents a single day in the Jewish Calendar. */
+export default class jDate {
+    Day: number;
+    Month: number;
+    Year: number;
+    Abs: number;
+    /**
+     *  Create a new Jdate.
+     *  new jDate() - Sets the Jewish Date for the current system date
+     *  new jDate(javascriptDateObject) - Sets to the Jewish date on the given Gregorian date
+     *  new jDate("January 1 2045") - Accepts any valid javascript Date string (uses javascripts new Date(string))
+     *  new jDate(jewishYear, jewishMonth, jewishDay) - Months start at 1. Nissan is month 1 Adar Sheini is 13.
+     *  new jDate(jewishYear, jewishMonth) - Same as above, with Day defaulting to 1
+     *  new jDate( { year: 5776, month: 4, day: 5 } ) - same as new jDate(jewishYear, jewishMonth, jewishDay)
+     *  new jDate( { year: 5776, month: 4 } ) - same as new jDate(jewishYear, jewishMonth)
+     *  new jDate( { year: 5776 } ) - sets to the first day of Rosh Hashana on the given year
+     *  new jDate(absoluteDate) - The number of days elapsed since the theoretical date Sunday, December 31, 0001 BCE
+     *  new jDate(jewishYear, jewishMonth, jewishDay, absoluteDate) - Most efficient constructor. Needs no calculations at all.
+     *  new jDate( { year: 5776, month: 4, day: 5, abs: 122548708 } ) - same as new jDate(jewishYear, jewishMonth, jewishDay, absoluteDate)
+     * @param {number | Date | string | {year:number,month:number,day:number} | [number, number, number, number]} [arg] The full Jewish year number OR Javascript Date object or string OR object or array of year, month, day
+     * @param {number} [month] The month of the Jewish date. Nissan is 1.
+     * @param {number} [day] The day of the month
+     * @param {number} [abs] The number of days that have passed since 12/31/0001
+     */
+    constructor(arg?: number | Date | string | {
+        year: number;
+        month: number;
+        day: number;
+    } | [number, number, number, number], month?: number, day?: number, abs?: number);
+    /**Sets the current Jewish date from the given absolute date*/
+    fromAbs(absolute: number): void;
+    /**Returns a valid javascript Date object that represents the Gregorian date
+    that starts at midnight of the current Jewish date.*/
+    getDate(): Date;
+    /**
+     * @returns {number} The day of the week for the current Jewish date. Sunday is 0 and Shabbos is 6.
+     */
+    getDayOfWeek(): number;
+    /**
+     * @returns {number} The day of the week for the current Jewish date. Sunday is 0 and Shabbos is 6
+     */
+    get DayOfWeek(): number;
+    /**Returns a new Jewish date represented by adding the given number of days to the current Jewish date.*/
+    addDays(days: number): jDate;
+    /**
+     * Returns a new Jewish date represented by adding the given number of
+     * Jewish Months to the current Jewish date.
+     * If the current Day is 30 and the new month only has 29 days,
+     * the 29th day of the month is returned.
+     * @param {number} months
+     */
+    addMonths(months: number): jDate;
+    /**
+     * Returns a new Jewish date represented by adding the
+     * given number of Jewish Years to the current Jewish date.
+     * If the current Day is 30 and the new dates month only has 29 days,
+     * the 29th day of the month is returned.
+     * @param {number} years
+     */
+    addYears(years: number): jDate;
+    addSecularMonths(months: number): jDate;
+    addSecularYears(years: number): jDate;
+    /**Gets the number of days separating this Jewish Date and the given one.
+     *
+     * If the given date is before this one, the number will be negative.
+     * @param {jDate} jd
+     * */
+    diffDays(jd: jDate): number;
+    /**Gets the number of months separating this Jewish Date and the given one.
+     *
+     * Ignores the Day property:
+     *
+     * jDate.toJDate(5777, 6, 29).diffMonths(jDate.toJDate(5778, 7, 1)) will return 1 even though they are a day apart.
+     *
+     * If the given date is before this one, the number will be negative.
+     * @param {jDate} jd
+     * */
+    diffMonths(jd: jDate): number;
+    /**Gets the number of years separating this Jewish Date and the given one.
+     *
+     * Ignores the Day and Month properties:
+     *
+     * jDate.toJDate(5777, 6, 29).diffYears(jDate.toJDate(5778, 7, 1)) will return 1 even though they are a day apart.
+     *
+     * If the given date is before this one, the number will be negative.
+     * @param {jDate} jd*/
+    diffYears(jd: jDate): number;
+    /**
+     * Returns the current Jewish date in the format: Thursday, the 3rd of Kislev 5776.
+     * @param {boolean} hideDayOfWeek
+     * @param {boolean} dontCapitalize
+     */
+    toString(hideDayOfWeek?: boolean, dontCapitalize?: boolean): string;
+    /**
+     * Returns the current Jewish date in the format "[Tuesday] Nissan 3, 5778"
+     * @param {boolean} showDow - show day of week?
+     */
+    toShortstring(showDow: boolean): string;
+    /**
+     * Returns the current Jewish date in the format "Nissan 5778"
+     * @param {boolean} showYear - show the year number?
+     */
+    monthName(showYear?: boolean): string;
+    /**Returns the current Jewish date in the format: יום חמישי כ"א כסלו תשע"ו.*/
+    toStringHeb(): string;
+    /**Gets the day of the omer for the current Jewish date. If the date is not during sefira, 0 is returned.*/
+    getDayOfOmer(): number;
+    /**
+     * Returns true if this day is yomtov or chol hamoed
+     * @param {boolean} israel
+     */
+    isYomTovOrCholHamoed(israel: boolean): boolean;
+    /**
+     * Returns true if this day is yomtov
+     * @param {boolean} israel
+     */
+    isYomTov(israel: boolean): boolean;
+    /**Is today Erev Yom Tov? (includes Erev second days of Sukkos and Pesach) */
+    isErevYomTov(): boolean;
+    /**Does the current Jewish date have candle lighting before sunset?*/
+    hasCandleLighting(): boolean;
+    /**Is the current Jewish Date the day before a yomtov that contains a Friday?*/
+    hasEiruvTavshilin(israel: boolean): boolean;
+    /**Gets the candle lighting time for the current Jewish date for the given Location object.*/
+    getCandleLighting(location: Location, nullIfNoCandles: boolean): import("../jcal-zmanim").Time | null | undefined;
+    /**Get the sedra of the week for the current Jewish date.*/
+    getSedra(israel: boolean): Sedra;
+    /**Get the prakim of Pirkei Avos for the current Jewish date.*/
+    getPirkeiAvos(israel: boolean): number[];
+    /**Gets sunrise and sunset time for the current Jewish date at the given Location.
+     *
+     * Return format: {sunrise: {hour: 6, minute: 18}, sunset: {hour: 19, minute: 41}}*/
+    getSunriseSunset(location: Location, ignoreElevation?: boolean): import("../jcal-zmanim").SunTimes;
+    /**Gets Chatzos for both the day and the night for the current Jewish date at the given Location.
+     *
+     *Return format: {hour: 11, minute: 48}*/
+    getChatzos(location: Location): import("../jcal-zmanim").Time;
+    /**Gets the length of a single Sha'a Zmanis in minutes for the current Jewish date at the given Location.*/
+    getShaaZmanis(location: Location, offset: number): number;
+    /**Returns the daily daf in English. For example: Sukkah, Daf 3.*/
+    getDafYomi(): string;
+    /**Gets the daily daf in Hebrew. For example: 'סוכה דף כ.*/
+    getDafyomiHeb(): string;
+    /**
+     *  Converts its argument/s to a Jewish Date.
+     *  Samples of use:
+     *    To get the current Jewish Date: jDate.toJDate(new Date()).
+     *    To print out the current date in English: jDate.toJDate(new Date()).toString()
+     *    To print out the current date in Hebrew: jDate.toJDate(new Date()).toStringHeb()
+     *
+     *  Arguments to the jDate.toJDate function can be one of the following:
+     *  jDate.toJDate() - Sets the Jewish Date for the current system date
+     *  jDate.toJDate(Date) - Sets to the Jewish date on the given Javascript Date object
+     *  jDate.toJDate("January 1 2045") - Accepts any valid Javascript Date string (uses string constructor of Date object)
+     *  jDate.toJDate(jewishYear, jewishMonth, jewishDay) - Months start at 1. Nissan is month 1 Adara Sheini is 13.
+     *  jDate.toJDate(jewishYear, jewishMonth) - Same as above, with Day defaulting to 1
+     *  jDate.toJDate(jewishYear) - sets to the first day of Rosh Hashana on the given year
+     *  jDate.toJDate( { year: 5776, month: 4, day: 5 } ) - Months start at 1. Nissan is month 1 Adara Sheini is 13.
+     *  jDate.toJDate( { year: 5776, month: 4 } ) - Same as above, with Day defaulting to 1
+     *  jDate.toJDate( { year: 5776 } ) - sets to the first day of Rosh Hashana on the given year
+     *  jDate.toJDate(jewishYear, jewishMonth, jewishDay, absoluteDate) - Most efficient. Needs no calculations at all. The absoluteDate is the number of days elapsed since the theoretical date Sunday, December 31, 0001 BCE.
+     *  jDate.toJDate( { year: 5776, month: 4, day: 5, abs: 122548708 } ) - same as jDate.toJDate(jewishYear, jewishMonth, jewishDay, absoluteDate)
+     ****************************************************************************************************************/
+    static toJDate(arg?: number | Date | string | {
+        year: number;
+        month: number;
+        day: number;
+    } | [number, number, number, number], month?: number, day?: number, abs?: number): jDate;
+    static now(): jDate;
+    /**Calculate the Jewish year, month and day for the given absolute date.*/
+    static fromAbs(absDay: number): {
+        year: number;
+        month: number;
+        day: number;
+    };
+    /**
+     * Gets the absolute date of the given javascript Date object.
+     * @param {Date} date
+     */
+    static absSd(date: Date): number;
+    /**Calculate the absolute date for the given Jewish Date.*/
+    static absJd(year: number, month: number, day: number): number;
+    /**
+     * Gets a javascript date from an absolute date
+     */
+    static sdFromAbs(abs: number): Date;
+    /**number of days in the given Jewish Month. Nissan is 1 and Adar Sheini is 13.*/
+    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;
+    /**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.*/
+    static monthsJYear(year: number): number;
+}