@hebcal/core 6.1.0 → 6.3.0

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;

package/dist/coverage/block-navigation.d.ts

@@ -1 +0,0 @@
-declare function jumpToCode(event: any): void;

package/dist/coverage/block-navigation.js

@@ -1,70 +0,0 @@
-"use strict";
-/* eslint-disable */
-var jumpToCode = (function init() {
-    // Classes of code we would like to highlight in the file view
-    var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no'];
-    // Elements to highlight in the file listing view
-    var fileListingElements = ['td.pct.low'];
-    // We don't want to select elements that are direct descendants of another match
-    var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
-    // Selector that finds elements on the page to which we can jump
-    var selector = fileListingElements.join(', ') +
-        ', ' +
-        notSelector +
-        missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
-    // The NodeList of matching elements
-    var missingCoverageElements = document.querySelectorAll(selector);
-    var currentIndex;
-    function toggleClass(index) {
-        missingCoverageElements
-            .item(currentIndex)
-            .classList.remove('highlighted');
-        missingCoverageElements.item(index).classList.add('highlighted');
-    }
-    function makeCurrent(index) {
-        toggleClass(index);
-        currentIndex = index;
-        missingCoverageElements.item(index).scrollIntoView({
-            behavior: 'smooth',
-            block: 'center',
-            inline: 'center'
-        });
-    }
-    function goToPrevious() {
-        var nextIndex = 0;
-        if (typeof currentIndex !== 'number' || currentIndex === 0) {
-            nextIndex = missingCoverageElements.length - 1;
-        }
-        else if (missingCoverageElements.length > 1) {
-            nextIndex = currentIndex - 1;
-        }
-        makeCurrent(nextIndex);
-    }
-    function goToNext() {
-        var nextIndex = 0;
-        if (typeof currentIndex === 'number' &&
-            currentIndex < missingCoverageElements.length - 1) {
-            nextIndex = currentIndex + 1;
-        }
-        makeCurrent(nextIndex);
-    }
-    return function jump(event) {
-        if (document.getElementById('fileSearch') === document.activeElement &&
-            document.activeElement != null) {
-            // if we're currently focused on the search input, we don't want to navigate
-            return;
-        }
-        switch (event.which) {
-            case 78: // n
-            case 74: // j
-                goToNext();
-                break;
-            case 66: // b
-            case 75: // k
-            case 80: // p
-                goToPrevious();
-                break;
-        }
-    };
-})();
-window.addEventListener('keydown', jumpToCode);