Type Alias CalOptions

CalOptions: {
    addHebrewDates?: boolean;
    addHebrewDatesForEvents?: boolean;
    ashkenazi?: boolean;
    candlelighting?: boolean;
    candleLightingMins?: number;
    dailyLearning?: {
        [x: string]: DailyLearningValue;
    };
    end?: number | HDate | Date;
    fastEndDeg?: number;
    havdalahDeg?: number;
    havdalahMins?: number;
    hour12?: boolean;
    il?: boolean;
    isHebrewYear?: 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;
    useElevation?: boolean;
    year?: number;
    yomKippurKatan?: boolean;
}

Options to configure which events are returned

Type declaration

  • OptionaladdHebrewDates?: boolean

    print the Hebrew date for the entire date range

  • OptionaladdHebrewDatesForEvents?: boolean

    print the Hebrew date for dates with some events

  • Optionalashkenazi?: boolean

    use Ashkenazi transliterations for event titles (default Sephardi transliterations)

  • Optionalcandlelighting?: boolean

    calculate candle-lighting and havdalah times

  • OptionalcandleLightingMins?: number

    minutes before sundown to light candles (default 18)

  • OptionaldailyLearning?: {
        [x: 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).

  • Optionalend?: number | HDate | Date

    use specific end date (requires start date)

  • OptionalfastEndDeg?: number

    degrees for solar depression for end of fast days. Default is 7.083 degrees for 3 medium-sized stars. Other commonly-used values include 6.45 degrees, as calculated by Rabbi Yechiel Michel Tucazinsky.

  • OptionalhavdalahDeg?: 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 (observed by Dr. Baruch (Berthold) Cohn in his luach published in France in 1899). If 0, Havdalah times are suppressed.

  • OptionalhavdalahMins?: 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.

  • Optionalhour12?: boolean

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

  • Optionalil?: boolean

    Israeli holiday and sedra schedule

  • OptionalisHebrewYear?: boolean

    to interpret year as Hebrew year

  • Optionallocale?: 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

  • Optionallocation?: Location

    latitude/longitude/tzid used for candle-lighting

  • Optionalmask?: number

    use bitmask from flags to filter events

  • Optionalmolad?: boolean

    include event announcing the molad

  • Optionalmonth?: number | string

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

  • OptionalnoHolidays?: boolean

    suppress regular holidays

  • OptionalnoMinorFast?: boolean

    suppress minor fasts

  • OptionalnoModern?: boolean

    suppress modern holidays

  • OptionalnoRoshChodesh?: boolean

    suppress Rosh Chodesh

  • OptionalnoSpecialShabbat?: boolean

    suppress Special Shabbat

  • OptionalnumYears?: number

    generate calendar for multiple years (default 1)

  • Optionalomer?: boolean

    include Days of the Omer

  • Optionalsedrot?: boolean

    calculate parashah hashavua on Saturdays

  • OptionalshabbatMevarchim?: boolean

    add Shabbat Mevarchim

  • Optionalstart?: number | HDate | Date

    use specific start date (requires end date)

  • OptionaluseElevation?: 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.

  • Optionalyear?: number

    Gregorian or Hebrew year

  • OptionalyomKippurKatan?: 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