@hebcal/core
    Preparing search index...

    Type Alias CalOptions

    Options to configure which events are returned

    type CalOptions = {
        addHebrewDates?: boolean;
        addHebrewDatesForEvents?: boolean;
        ashkenazi?: boolean;
        behab?: boolean;
        candlelighting?: boolean;
        candleLightingMins?: number;
        dailyLearning?: Record<string, DailyLearningValue>;
        end?: number | HDate | Date;
        fastEndDeg?: number;
        fastEndMins?: number;
        fastStartDeg?: number;
        fastStartMins?: number;
        havdalahDeg?: number;
        havdalahMins?: number;
        hour12?: boolean;
        il?: boolean;
        isHebrewYear?: boolean;
        kiddushLevanaMaharil?: boolean;
        locale?: string;
        location?: Location;
        mask?: number;
        molad?: boolean;
        month?: number | string;
        noHolidays?: boolean;
        noMinorFast?: boolean;
        noModern?: boolean;
        noRoshChodesh?: boolean;
        noSpecialShabbat?: boolean;
        numYears?: number;
        omer?: boolean;
        sedrot?: boolean;
        shabbatMevarchim?: boolean;
        start?: number | HDate | Date;
        tishaBavEndDeg?: number;
        tishaBavEndMins?: number;
        useElevation?: boolean;
        year?: number;
        yizkor?: boolean;
        yomKippurKatan?: boolean;
    }
    Index
    addHebrewDates? addHebrewDatesForEvents? ashkenazi? behab? candlelighting? candleLightingMins? dailyLearning? end? fastEndDeg? fastEndMins? fastStartDeg? fastStartMins? havdalahDeg? havdalahMins? hour12? il? isHebrewYear? kiddushLevanaMaharil? locale? location? mask? molad? month? noHolidays? noMinorFast? noModern? noRoshChodesh? noSpecialShabbat? numYears? omer? sedrot? shabbatMevarchim? start? tishaBavEndDeg? tishaBavEndMins? useElevation? year? yizkor? yomKippurKatan?
    addHebrewDates?: boolean

    print the Hebrew date for the entire date range

    addHebrewDatesForEvents?: boolean

    print the Hebrew date for dates with some events

    ashkenazi?: boolean

    use Ashkenazi transliterations for event titles (default Sephardi transliterations)

    use event.render('ashkenazi') instead

    behab?: boolean

    include BeHaB fast days on Monday, Thursday and Monday after Pesach and Sukkot (default false).

    candlelighting?: boolean

    calculate candle-lighting and havdalah times

    candleLightingMins?: number

    minutes before sundown to light candles. Defaults to 18 minutes in the Diaspora and 20 minutes in Israel (40 minutes for Jerusalem, 30 minutes for Haifa and Zikhron Ya'akov).

    dailyLearning?: Record<string, DailyLearningValue>

    map of options to enable daily study calendars such as dafYomi, mishnaYomi, nachYomi with value true. For yerushalmi the value should be a number for edition (1 for Vilna, 2 for Schottenstein).

    end?: number | HDate | Date

    use specific end date (requires start date)

    fastEndDeg?: number

    degrees for solar depression for the end of minor fasts. When set to a nonzero value, minor fasts (including Yom Kippur Katan) end at this many degrees below the horizon. Commonly-used values include 7.083 degrees for 3 medium-sized stars and 6.45 degrees, as calculated by Rabbi Yechiel Michel Tucazinsky. Mutually exclusive with fastEndMins. If neither is specified, minor fasts end at 7.083 degrees in the Diaspora, or 15 minutes after sunset in Israel (Rabbi Deblitzky's practice). Note: Tish'a B'Av is not affected by this option; see tishaBavEndDeg.

    fastEndMins?: number

    minutes after sunset for the end of minor fasts. When set to a nonzero value, minor fasts (including Yom Kippur Katan) end this many minutes after sunset. Mutually exclusive with fastEndDeg. Note: Tish'a B'Av is not affected by this option; see tishaBavEndMins.

    fastStartDeg?: number

    degrees for solar depression for the start of minor fasts. When set to a nonzero value, minor fasts (including Yom Kippur Katan) begin when the sun is this many degrees below the horizon in the morning. Mutually exclusive with fastStartMins. If neither is specified, minor fasts begin at Alot HaShachar, 16.1 degrees. Note: Tish'a B'Av begins at sunset on the previous day and is not affected by this option.

    fastStartMins?: number

    minutes before sunrise for the start of minor fasts (typical values are 72 or 90). When set to a nonzero value, minor fasts (including Yom Kippur Katan) begin this many minutes before sunrise. Mutually exclusive with fastStartDeg. Note: Tish'a B'Av begins at sunset on the previous day and is not affected by this option.

    havdalahDeg?: number

    degrees for solar depression for Havdalah. Default is 8.5 degrees for 3 small stars. use 7.083 degrees for 3 medium-sized stars. If 0, Havdalah times are suppressed.

    havdalahMins?: number

    minutes after sundown for Havdalah (typical values are 42, 50, or 72). If undefined (the default), calculate Havdalah according to Tzeit Hakochavim - Nightfall (the point when 3 small stars are observable in the night time sky with the naked eye). If 0, Havdalah times are suppressed.

    hour12?: boolean

    Whether to use 12-hour time (as opposed to 24-hour time). Possible values are true and false; the default is locale dependent.

    il?: boolean

    Israeli holiday and sedra schedule

    isHebrewYear?: boolean

    to interpret year as Hebrew year

    kiddushLevanaMaharil?: boolean

    include the latest time for Kiddush Levana each month, calculated as halfway between one molad and the next (the Maharil's opinion). Requires options.location. See KiddushLevanaEvent.

    locale?: string

    translate event titles according to a locale Default value is en, also built-in are he and ashkenazi. Additional locales (such as ru or fr) are provided by the @hebcal/locales package

    location?: Location

    latitude/longitude/tzid used for candle-lighting

    mask?: number

    use bitmask from flags to filter events

    molad?: boolean

    include event announcing the molad

    month?: number | string

    Gregorian or Hebrew month (to filter results to a single month)

    noHolidays?: boolean

    suppress regular holidays

    noMinorFast?: boolean

    suppress minor fasts

    noModern?: boolean

    suppress modern holidays

    noRoshChodesh?: boolean

    suppress Rosh Chodesh

    noSpecialShabbat?: boolean

    suppress Special Shabbat

    numYears?: number

    generate calendar for multiple years (default 1, maximum 2000)

    omer?: boolean

    include Days of the Omer

    sedrot?: boolean

    calculate Parashat HaShavua on Saturdays

    shabbatMevarchim?: boolean

    add Shabbat Mevarchim

    start?: number | HDate | Date

    use specific start date (requires end date)

    tishaBavEndDeg?: number

    degrees for solar depression for the end of Tish'a B'Av. When set to a nonzero value, Tish'a B'Av ends when the sun is this many degrees below the horizon in the evening. Mutually exclusive with tishaBavEndMins. If neither is specified, Tish'a B'Av ends at 6.45 degrees, as calculated by Rabbi Yechiel Michel Tucazinsky.

    tishaBavEndMins?: number

    minutes after sunset for the end of Tish'a B'Av. When set to a nonzero value, Tish'a B'Av ends this many minutes after sunset. Mutually exclusive with tishaBavEndDeg.

    useElevation?: boolean

    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. These zmanim intentionally do not support elevation adjustment.

    year?: number

    Gregorian or Hebrew year

    yizkor?: boolean

    Yizkor (Hebrew: יִזְכּוֹר) is an Ashkenazi Jewish memorial prayer service for the dead. Yizkor is recited in synagogue as part of the service during four holidays each year:

    1. Yom Kippur
    2. Shmini Atzeret
    3. The final day of Passover (8th day Pesach in Diaspora, 7th day Pesach in Israel)
    4. Shavuot (2nd day Shavuot in Diaspora)
    yomKippurKatan?: boolean

    include Yom Kippur Katan (default false). יוֹם כִּפּוּר קָטָן is a minor day of atonement occurring monthly on the day preceeding each Rosh Chodesh. Yom Kippur Katan is omitted in Elul (on the day before Rosh Hashanah), Tishrei (Yom Kippur has just passed), Kislev (due to Chanukah) and Nisan (fasting not permitted during Nisan). When Rosh Chodesh occurs on Shabbat or Sunday, Yom Kippur Katan is observed on the preceding Thursday. See Wikipedia Yom Kippur Katan practices

    Settings
    Member Visibility

    On This Page
    Properties