@hebcal/core 6.1.0 → 6.2.0

package/dist/CalOptions.d.ts

@@ -1,168 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import type { Location } from './location';
-export type DailyLearningValue = boolean | number | string;
-/**
- * Options to configure which events are returned
- */
-export type CalOptions = {
-    /**
-     * latitude/longitude/tzid used for candle-lighting
-     */
-    location?: Location;
-    /**
-     * Gregorian or Hebrew year
-     */
-    year?: number;
-    /**
-     * to interpret year as Hebrew year
-     */
-    isHebrewYear?: boolean;
-    /**
-     * Gregorian or Hebrew month (to filter results to a single month)
-     */
-    month?: number | string;
-    /**
-     * generate calendar for multiple years (default 1)
-     */
-    numYears?: number;
-    /**
-     * use specific start date (requires end date)
-     */
-    start?: number | HDate | Date;
-    /**
-     * use specific end date (requires start date)
-     */
-    end?: number | HDate | Date;
-    /**
-     * calculate candle-lighting and havdalah times
-     */
-    candlelighting?: boolean;
-    /**
-     * minutes before sundown to light candles (default 18)
-     */
-    candleLightingMins?: 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.
-     */
-    havdalahMins?: 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.
-     */
-    havdalahDeg?: 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.
-     */
-    fastEndDeg?: number;
-    /**
-     * 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.
-     */
-    useElevation?: boolean;
-    /**
-     * calculate parashah hashavua on Saturdays
-     */
-    sedrot?: boolean;
-    /**
-     * Israeli holiday and sedra schedule
-     */
-    il?: boolean;
-    /**
-     * suppress minor fasts
-     */
-    noMinorFast?: boolean;
-    /**
-     * suppress modern holidays
-     */
-    noModern?: boolean;
-    /**
-     * suppress Rosh Chodesh
-     */
-    noRoshChodesh?: boolean;
-    /**
-     * add Shabbat Mevarchim
-     */
-    shabbatMevarchim?: boolean;
-    /**
-     * suppress Special Shabbat
-     */
-    noSpecialShabbat?: boolean;
-    /**
-     * suppress regular holidays
-     */
-    noHolidays?: boolean;
-    /**
-     * include Days of the Omer
-     */
-    omer?: boolean;
-    /**
-     * include event announcing the molad
-     */
-    molad?: boolean;
-    /**
-     * use Ashkenazi transliterations for event titles (default Sephardi transliterations)
-     * @deprecated use `event.render('ashkenazi')` instead
-     */
-    ashkenazi?: boolean;
-    /**
-     * 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
-     * {@link https://github.com/hebcal/hebcal-locales @hebcal/locales} package
-     */
-    locale?: string;
-    /**
-     * print the Hebrew date for the entire date range
-     */
-    addHebrewDates?: boolean;
-    /**
-     * print the Hebrew date for dates with some events
-     */
-    addHebrewDatesForEvents?: boolean;
-    /**
-     * use bitmask from `flags` to filter events
-     */
-    mask?: number;
-    /**
-     * 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 {@link https://en.wikipedia.org/wiki/Yom_Kippur_Katan#Practices Wikipedia Yom Kippur Katan practices}
-     */
-    yomKippurKatan?: boolean;
-    /**
-     * Whether to use 12-hour time (as opposed to 24-hour time).
-     * Possible values are `true` and `false`; the default is locale dependent.
-     */
-    hour12?: boolean;
-    /**
-     * 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).
-     */
-    dailyLearning?: Record<string, DailyLearningValue>;
-    /**
-     * 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)
-     */
-    yizkor?: boolean;
-};

package/dist/DailyLearning.d.ts

@@ -1,32 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import { Event } from './event';
-/**
- * Plug-ins for daily learning calendars such as Daf Yomi, Mishna Yomi, Nach Yomi, etc.
- *
- * Learning schedules are provided by the `@hebcal/learning` package.
- */
-export declare class DailyLearning {
-    /**
-     * Register a new learning calendar.
-     * @param name case insensitive
-     * @param calendar a function that returns an `Event` or `null`
-     * @param startDate the first date for which this calendar is valid
-     */
-    static addCalendar(name: string, calendar: (hd: HDate, il: boolean) => Event | null, startDate?: HDate): void;
-    /**
-     * Returns an event from daily calendar for a given date. Returns `null` if there
-     * is no learning from this calendar on this date.
-     * @param name case insensitive
-     * @param hd Hebrew Date
-     * @param il true for Israel, false for Diaspora
-     */
-    static lookup(name: string, hd: HDate, il: boolean): Event | null;
-    static getStartDate(name: string): HDate | undefined;
-    /**
-     * Tests to see if learning calendar has been registered
-     * @param name case insensitive
-     */
-    static has(name: string): boolean;
-    /** Returns the names of all calendars registered */
-    static getCalendars(): string[];
-}

package/dist/HebrewDateEvent.d.ts

@@ -1,37 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import { Event } from './event';
-import './locale';
-/** Daily Hebrew date ("11th of Sivan, 5780") */
-export declare class HebrewDateEvent extends Event {
-    /**
-     * @param date
-     */
-    constructor(date: HDate);
-    /**
-     * @param [locale] Optional locale name (defaults to empty locale)
-     * @example
-     * import {HDate, HebrewDateEvent, months} from '@hebcal/core';
-     *
-     * const hd = new HDate(15, months.CHESHVAN, 5769);
-     * const ev = new HebrewDateEvent(hd);
-     * console.log(ev.render('en')); // '15th of Cheshvan, 5769'
-     * console.log(ev.render('he')); // 'ט״ו חֶשְׁוָן תשס״ט'
-     */
-    render(locale?: string): string;
-    /**
-     * @private
-     * @param locale
-     */
-    private renderBriefHebrew;
-    /**
-     * @param [locale] Optional locale name (defaults to empty locale)
-     * @example
-     * import {HDate, HebrewDateEvent, months} from '@hebcal/core';
-     *
-     * const hd = new HDate(15, months.CHESHVAN, 5769);
-     * const ev = new HebrewDateEvent(hd);
-     * console.log(ev.renderBrief()); // '15th of Cheshvan'
-     * console.log(ev.renderBrief('he')); // 'ט״ו חֶשְׁוָן'
-     */
-    renderBrief(locale?: string): string;
-}

package/dist/HolidayEvent.d.ts

@@ -1,84 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import { Event } from './event';
-import './locale';
-/** Represents a built-in holiday like Pesach, Purim or Tu BiShvat */
-export declare class HolidayEvent extends Event {
-    /** During Sukkot or Pesach */
-    cholHaMoedDay?: number;
-    /**
-     * `true` if the fast day was postponed a day to avoid Shabbat.
-     * - Tish'a B'Av postponed from the 9th to the 10th
-     * - Tzom Tammuz postponed from the 17th to the 18th
-     */
-    observed?: boolean;
-    constructor(date: HDate, desc: string, mask?: number, attrs?: object);
-    basename(): string;
-    url(): string | undefined;
-    urlDateSuffix(): string;
-    getEmoji(): string;
-    getCategories(): string[];
-    /**
-     * Returns (translated) description of this event
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    render(locale?: string): string;
-    /**
-     * Returns a brief (translated) description of this event.
-     * For most events, this is the same as render(). For some events, it procudes
-     * a shorter text (e.g. without a time or added description).
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    renderBrief(locale?: string): string;
-}
-/**
- * Because Asara B'Tevet often occurs twice in the same Gregorian year,
- * we subclass HolidayEvent to generate the correct URL.
- */
-export declare class AsaraBTevetEvent extends HolidayEvent {
-    urlDateSuffix(): string;
-}
-/**
- * Because Chanukah sometimes starts in December and ends in January,
- * we subclass HolidayEvent to generate the correct URL.
- */
-export declare class ChanukahEvent extends HolidayEvent {
-    readonly chanukahDay?: number;
-    /**
-     * @param chanukahDay should be undefined for 1st night of Chanukah
-     */
-    constructor(date: HDate, desc: string, mask: number, chanukahDay?: number);
-    urlDateSuffix(): string;
-}
-/** Represents Rosh Hashana, the Jewish New Year */
-export declare class RoshHashanaEvent extends HolidayEvent {
-    private readonly hyear;
-    /**
-     * @private
-     * @param date Hebrew date event occurs
-     * @param hyear Hebrew year
-     * @param mask optional holiday flags
-     */
-    constructor(date: HDate, hyear: number, mask: number);
-    /**
-     * Returns (translated) description of this event
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    render(locale?: string): string;
-    getEmoji(): string;
-}
-/** Represents Rosh Chodesh, the beginning of a new month */
-export declare class RoshChodeshEvent extends HolidayEvent {
-    /**
-     * Constructs Rosh Chodesh event
-     * @param date Hebrew date event occurs
-     * @param monthName Hebrew month name (not translated)
-     */
-    constructor(date: HDate, monthName: string);
-    /**
-     * Returns (translated) description of this event
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    render(locale?: string): string;
-    basename(): string;
-    getEmoji(): string;
-}

package/dist/MevarchimChodeshEvent.d.ts

@@ -1,26 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import { Event } from './event';
-import './locale';
-/** Represents Mevarchim haChodesh, the announcement of the new month */
-export declare class MevarchimChodeshEvent extends Event {
-    readonly monthName: string;
-    /**
-     * Constructs Mevarchim haChodesh event
-     * @param date Hebrew date event occurs
-     * @param monthName Hebrew month name (not translated)
-     * @param [memo]
-     * @param locale Optional locale name
-     */
-    constructor(date: HDate, monthName: string, memo: string, locale?: string);
-    basename(): string;
-    /**
-     * Returns (translated) description of this event
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    render(locale?: string): string;
-    /**
-     * Returns (translated) description of this event
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    renderBrief(locale?: string): string;
-}

package/dist/ParshaEvent.d.ts

@@ -1,19 +0,0 @@
-import { Event } from './event';
-import { SedraResult } from './sedra';
-import './locale';
-/**
- * Represents one of 54 weekly Torah portions, always on a Saturday
- */
-export declare class ParshaEvent extends Event {
-    readonly p: SedraResult;
-    constructor(parsha: SedraResult);
-    /**
-     * @param [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to empty locale.
-     */
-    render(locale?: string): string;
-    basename(): string;
-    url(): string | undefined;
-    urlDateSuffix(): string;
-    /** convenience function for compatibility with previous implementation */
-    get parsha(): string[];
-}

package/dist/TimedEvent.d.ts

@@ -1,47 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import { CalOptions } from './CalOptions';
-import { Location } from './location';
-import { Event } from './event';
-import './locale';
-/** An event that has an `eventTime` and `eventTimeStr` */
-export declare class TimedEvent extends Event {
-    readonly eventTime: Date;
-    readonly location: Location;
-    readonly eventTimeStr: string;
-    readonly fmtTime: string;
-    readonly linkedEvent?: Event;
-    /**
-     * @param desc Description (not translated)
-     */
-    constructor(date: HDate, desc: string, mask: number, eventTime: Date, location: Location, linkedEvent?: Event, options?: CalOptions);
-    /**
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    render(locale?: string): string;
-    /**
-     * Returns translation of "Candle lighting" without the time.
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    renderBrief(locale?: string): string;
-    getCategories(): string[];
-}
-/** Candle lighting before Shabbat or holiday */
-export declare class CandleLightingEvent extends TimedEvent {
-    constructor(date: HDate, mask: number, eventTime: Date, location: Location, linkedEvent?: Event, options?: CalOptions);
-    getEmoji(): string;
-}
-/** Havdalah after Shabbat or holiday */
-export declare class HavdalahEvent extends TimedEvent {
-    private readonly havdalahMins?;
-    constructor(date: HDate, mask: number, eventTime: Date, location: Location, havdalahMins?: number, linkedEvent?: Event, options?: CalOptions);
-    /**
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    render(locale?: string): string;
-    /**
-     * Returns translation of "Havdalah" without the time.
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    renderBrief(locale?: string): string;
-    getEmoji(): string;
-}

package/dist/YomKippurKatanEvent.d.ts

@@ -1,23 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import { HolidayEvent } from './HolidayEvent';
-import './locale';
-/** YKK is minor day of atonement on the day preceeding each Rosh Chodesh */
-export declare class YomKippurKatanEvent extends HolidayEvent {
-    private readonly nextMonthName;
-    /**
-     * @private
-     * @param date Hebrew date event occurs
-     * @param nextMonthName name of the upcoming month
-     */
-    constructor(date: HDate, nextMonthName: string);
-    basename(): string;
-    /**
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    render(locale?: string): string;
-    /**
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    renderBrief(locale?: string): string;
-    url(): string | undefined;
-}

package/dist/ashkenazi.po.d.ts

@@ -1,82 +0,0 @@
-declare const _default: {
-    headers: {
-        "plural-forms": string;
-        language: string;
-    };
-    contexts: {
-        "": {
-            Shabbat: string[];
-            "Achrei Mot": string[];
-            Bechukotai: string[];
-            "Beha'alotcha": string[];
-            Bereshit: string[];
-            Chukat: string[];
-            "Erev Shavuot": string[];
-            "Erev Sukkot": string[];
-            "Ki Tavo": string[];
-            "Ki Teitzei": string[];
-            "Ki Tisa": string[];
-            Matot: string[];
-            "Pesach Shabbat Chol ha-Moed": string[];
-            "Purim Katan": string[];
-            "Shabbat Chazon": string[];
-            "Shabbat HaChodesh": string[];
-            "Shabbat HaGadol": string[];
-            "Shabbat Nachamu": string[];
-            "Shabbat Parah": string[];
-            "Shabbat Shekalim": string[];
-            "Shabbat Shuva": string[];
-            "Shabbat Zachor": string[];
-            Shavuot: string[];
-            "Shavuot I": string[];
-            "Shavuot II": string[];
-            Shemot: string[];
-            "Shmini Atzeret": string[];
-            "Simchat Torah": string[];
-            Sukkot: string[];
-            "Sukkot I": string[];
-            "Sukkot II": string[];
-            "Sukkot II (CH''M)": string[];
-            "Sukkot III (CH''M)": string[];
-            "Sukkot IV (CH''M)": string[];
-            "Sukkot V (CH''M)": string[];
-            "Sukkot VI (CH''M)": string[];
-            "Sukkot VII (Hoshana Raba)": string[];
-            "Sukkot Shabbat Chol ha-Moed": string[];
-            "Ta'anit Bechorot": string[];
-            "Ta'anit Esther": string[];
-            Toldot: string[];
-            Vaetchanan: string[];
-            Yitro: string[];
-            "Vezot Haberakhah": string[];
-            Parashat: string[];
-            "Leil Selichot": string[];
-            "Shabbat Mevarchim Chodesh": string[];
-            "Shabbat Shirah": string[];
-            "Asara B'Tevet": string[];
-            "Birkat Hachamah": string[];
-            "Birkat HaChamah": string[];
-            "Shushan Purim Katan": string[];
-            "Alot HaShachar": string[];
-            Misheyakir: string[];
-            "Misheyakir Machmir": string[];
-            Sunrise: string[];
-            "Kriat Shema, sof zeman": string[];
-            "Tefilah, sof zeman": string[];
-            "Kriat Shema, sof zeman (MGA)": string[];
-            "Kriat Shema, sof zeman (GRA)": string[];
-            "Tefilah, sof zeman (MGA)": string[];
-            "Tefilah, sof zeman (GRA)": string[];
-            "Chatzot HaLailah": string[];
-            "Chatzot HaYom": string[];
-            "Chatzot hayom": string[];
-            "Mincha Gedolah": string[];
-            "Mincha Ketanah": string[];
-            "Plag HaMincha": string[];
-            Sunset: string[];
-            "Bein HaShemashot": string[];
-            "Tzeit HaKochavim": string[];
-        };
-    };
-};
-export default _default;

package/dist/calendar.d.ts

@@ -1,111 +0,0 @@
-import { CalOptions } from './CalOptions';
-import { Event } from './event';
-/**
- * Calculates holidays and other Hebrew calendar events based on {@link CalOptions}.
- *
- * Each holiday is represented by an {@link Event} object which includes a date,
- * a description, flags and optional attributes.
- * If given no options, returns holidays for the Diaspora for the current Gregorian year.
- *
- * The date range returned by this function can be controlled by:
- * * `options.year` - Gregorian (e.g. 1993) or Hebrew year (e.g. 5749)
- * * `options.isHebrewYear` - to interpret `year` as Hebrew year
- * * `options.numYears` - generate calendar for multiple years (default 1)
- * * `options.month` - Gregorian or Hebrew month (to filter results to a single month)
- *
- * Alternatively, specify start and end days with `Date` or {@link HDate} instances:
- * * `options.start` - use specific start date (requires `end` date)
- * * `options.end` - use specific end date (requires `start` date)
- *
- * Unless `options.noHolidays == true`, default holidays include:
- * * Major holidays - Rosh Hashana, Yom Kippur, Pesach, Sukkot, etc.
- * * Minor holidays - Purim, Chanukah, Tu BiShvat, Lag BaOmer, etc.
- * * Minor fasts - Ta'anit Esther, Tzom Gedaliah, etc. (unless `options.noMinorFast`)
- * * Special Shabbatot - Shabbat Shekalim, Zachor, etc. (unless `options.noSpecialShabbat`)
- * * Modern Holidays - Yom HaShoah, Yom HaAtzma'ut, etc. (unless `options.noModern`)
- * * Rosh Chodesh (unless `options.noRoshChodesh`)
- *
- * Holiday and Torah reading schedules differ between Israel and the Disapora.
- * Set `options.il=true` to use the Israeli schedule.
- *
- * Additional non-default event types can be specified:
- * * Parashat HaShavua - weekly Torah Reading on Saturdays (`options.sedrot`)
- * * Counting of the Omer (`options.omer`)
- * * Shabbat Mevarchim HaChodesh on Saturday before Rosh Chodesh (`options.shabbatMevarchim`)
- * * Molad announcement on Saturday before Rosh Chodesh (`options.molad`)
- * * Yom Kippur Katan (`options.yomKippurKatan`)
- * * Yizkor (`options.yizkor`)
- *
- * Daily Study of texts are supported by the
- * {@link https://github.com/hebcal/hebcal-learning @hebcal/learning} package,
- * for example:
- * * Babylonian Talmud Daf Yomi (`options.dailyLearning.dafYomi`)
- * * Jerusalem Talmud (Yerushalmi) Yomi (`options.dailyLearning.yerushalmi`)
- * * Mishna Yomi (`options.dailyLearning.mishnaYomi`)
- * * Nach Yomi (`options.dailyLearning.nachYomi`)
- *
- * Candle-lighting and Havdalah times are approximated using latitude and longitude
- * specified by the {@link Location} class. The `Location` class contains a small
- * database of cities with their associated geographic information and time-zone information.
- * If you ever have any doubts about Hebcal's times, consult your local halachic authority.
- * If you enter geographic coordinates above the arctic circle or antarctic circle,
- * the times are guaranteed to be wrong.
- *
- * To add candle-lighting options, set `options.candlelighting=true` and set
- * `options.location` to an instance of `Location`. By default, candle lighting
- * time is 18 minutes before sundown (40 minutes for Jerusalem,
- * 30 minutes for Haifa and Zikhron Ya'akov) and Havdalah is
- * calculated according to Tzeit Hakochavim - Nightfall (the point when 3 small stars
- * are observable in the night time sky with the naked eye). The default Havdalah
- * option (Tzeit Hakochavim) is calculated when the sun is 8.5° below the horizon.
- * These defaults can be changed using these options:
- * * `options.candleLightingMins` - minutes before sundown to light candles
- * * `options.havdalahMins` - minutes after sundown for Havdalah (typical values are 42, 50, or 72).
- *    Havdalah times are suppressed when `options.havdalahMins=0`.
- * * `options.havdalahDeg` - degrees for solar depression for Havdalah.
- *    Default is 8.5 degrees for 3 small stars. Use 7.083 degrees for 3 medium-sized stars.
- *    Havdalah times are suppressed when `options.havdalahDeg=0`.
- *
- * If both `options.candlelighting=true` and `options.location` is specified,
- * Chanukah candle-lighting times and minor fast start/end times will also be generated.
- * Chanukah candle-lighting is at Bein HaShmashos (13.5 minutes before
- * the sun is 7.083° below the horizon in the evening)
- * on weekdays, at regular candle-lighting time on Fridays, and at regular Havdalah time on
- * Saturday night (see above).
- *
- * Minor fasts begin at Alot HaShachar (sun is 16.1° below the horizon in the morning) and
- * end when 3 medium-sized stars are observable in the night sky (sun is 7.083° below the horizon
- * in the evening).
- *
- * Two options also exist for generating an Event with the Hebrew date:
- * * `options.addHebrewDates` - print the Hebrew date for the entire date range
- * * `options.addHebrewDatesForEvents` - print the Hebrew date for dates with some events
- *
- * Lastly, translation and transliteration of event titles is controlled by
- * `options.locale` and the {@link Locale} API.
- * `@hebcal/core` supports three locales by default:
- * * `en` - default, Sephardic transliterations (e.g. "Shabbat")
- * * `ashkenazi` - Ashkenazi transliterations (e.g. "Shabbos")
- * * `he` - Hebrew (e.g. "שַׁבָּת")
- *
- * Additional locales (such as `ru` or `fr`) are supported by the
- * {@link https://github.com/hebcal/hebcal-locales @hebcal/locales} package
- *
- * @example
- * import {HebrewCalendar, HDate, Location, Event} from '@hebcal/core';
- * const options: CalOptions = {
- *   year: 1981,
- *   isHebrewYear: false,
- *   candlelighting: true,
- *   location: Location.lookup('San Francisco'),
- *   sedrot: true,
- *   omer: true,
- * };
- * const events = HebrewCalendar.calendar(options);
- * for (const ev of events) {
- *   const hd = ev.getDate();
- *   const date = hd.greg();
- *   console.log(date.toLocaleDateString(), ev.render('en'), hd.toString());
- * }
- */
-export declare function calendar(options?: CalOptions): Event[];

package/dist/candles.d.ts

@@ -1,44 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import { CalOptions } from './CalOptions';
-import { Location } from './location';
-import { Event } from './event';
-import { ChanukahEvent, HolidayEvent } from './HolidayEvent';
-import { TimedEvent } from './TimedEvent';
-/**
- * @private
- */
-export declare function makeCandleEvent(ev: Event | undefined, hd: HDate, options: CalOptions, isFriday: boolean, isSaturday: boolean): TimedEvent | undefined;
-/** A fast day also contains a start and end time */
-export declare class FastDayEvent extends HolidayEvent {
-    /** original event */
-    readonly linkedEvent: HolidayEvent;
-    /** this will be a "Fast begins" event */
-    readonly startEvent?: TimedEvent;
-    /** this will be a "Fast ends" event */
-    readonly endEvent?: TimedEvent;
-    constructor(linkedEvent: HolidayEvent, startEvent?: TimedEvent, endEvent?: TimedEvent);
-    render(locale?: string): string;
-    renderBrief(locale?: string): string;
-    urlDateSuffix(): string;
-    url(): string | undefined;
-    getEmoji(): string;
-    getCategories(): string[];
-}
-/**
- * Makes a pair of events representing fast start and end times
- * @private
- */
-export declare function makeFastStartEnd(ev: HolidayEvent, options: CalOptions): FastDayEvent;
-export declare class TimedChanukahEvent extends ChanukahEvent {
-    eventTime: Date;
-    eventTimeStr: string;
-    readonly location: Location;
-    constructor(ev: ChanukahEvent, eventTime: Date, location: Location);
-}
-/**
- * Makes a candle-lighting event for Chankah (not on Friday/Saturday).
- * At one point this used civil dusk (6 degrees below horizon).
- * Another source suggests 4.6667 degrees below horizon.
- * @private
- */
-export declare function makeWeekdayChanukahCandleLighting(ev: ChanukahEvent, options: CalOptions): TimedChanukahEvent | null;