@hebcal/core 5.4.0 → 5.4.1

package/dist/candles.d.ts

@@ -1,74 +1,27 @@
+import { HDate } from '@hebcal/hdate';
+import { CalOptions } from './CalOptions';
+import { Location } from './location';
+import { Event } from './event';
+import { HolidayEvent } from './HolidayEvent';
 /**
  * @private
- * @param {Event} e
- * @param {HDate} hd
- * @param {CalOptions} options
- * @param {boolean} isFriday
- * @param {boolean} isSaturday
- * @return {Event}
  */
-export function makeCandleEvent(e: Event, hd: HDate, options: CalOptions, isFriday: boolean, isSaturday: boolean): Event;
+export declare function makeCandleEvent(ev: Event | undefined, hd: HDate, options: CalOptions, isFriday: boolean, isSaturday: boolean): Event | null;
 /**
  * Makes a pair of events representing fast start and end times
  * @private
- * @param {Event} ev
- * @param {CalOptions} options
- * @return {Event}
  */
-export function makeFastStartEnd(ev: Event, options: CalOptions): Event;
+export declare function makeFastStartEnd(ev: HolidayEvent, options: CalOptions): HolidayEvent;
+export declare class ChanukahEvent extends HolidayEvent {
+    readonly eventTime: Date;
+    readonly eventTimeStr: string;
+    readonly location: Location;
+    constructor(date: HDate, desc: string, mask: number, 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
- * @param {Event} ev
- * @param {HDate} hd
- * @param {CalOptions} options
- * @return {TimedEvent}
  */
-export function makeWeekdayChanukahCandleLighting(ev: Event, hd: HDate, options: CalOptions): TimedEvent;
-/** An event that has an `eventTime` and `eventTimeStr` */
-export class TimedEvent extends Event {
-    /**
-     * @param {HDate} date
-     * @param {string} desc Description (not translated)
-     * @param {number} mask
-     * @param {Date} eventTime
-     * @param {Location} location
-     * @param {Event} linkedEvent
-     * @param {CalOptions} options
-     */
-    constructor(date: HDate, desc: string, mask: number, eventTime: Date, location: Location, linkedEvent: Event, options: CalOptions);
-    eventTime: Date;
-    location: Location;
-    eventTimeStr: string;
-    fmtTime: string;
-    linkedEvent: Event | undefined;
-}
-/** Havdalah after Shabbat or holiday */
-export class HavdalahEvent extends TimedEvent {
-    /**
-     * @param {HDate} date
-     * @param {number} mask
-     * @param {Date} eventTime
-     * @param {Location} location
-     * @param {number} havdalahMins
-     * @param {Event} linkedEvent
-     * @param {CalOptions} options
-     */
-    constructor(date: HDate, mask: number, eventTime: Date, location: Location, havdalahMins: number, linkedEvent: Event, options: CalOptions);
-    havdalahMins: number | undefined;
-}
-/** Candle lighting before Shabbat or holiday */
-export class CandleLightingEvent extends TimedEvent {
-    /**
-     * @param {HDate} date
-     * @param {number} mask
-     * @param {Date} eventTime
-     * @param {Location} location
-     * @param {Event} linkedEvent
-     * @param {CalOptions} options
-     */
-    constructor(date: HDate, mask: number, eventTime: Date, location: Location, linkedEvent: Event, options: CalOptions);
-}
-import { Event } from './event.js';
+export declare function makeWeekdayChanukahCandleLighting(ev: Event, hd: HDate, options: CalOptions): ChanukahEvent | null;

package/dist/event.d.ts

@@ -1,38 +1,73 @@
+import { HDate } from '@hebcal/hdate';
 /**
  * Holiday flags for Event
+ * @readonly
+ * @enum {number}
  */
-export type flags = number;
-export namespace flags {
-    let CHAG: number;
-    let LIGHT_CANDLES: number;
-    let YOM_TOV_ENDS: number;
-    let CHUL_ONLY: number;
-    let IL_ONLY: number;
-    let LIGHT_CANDLES_TZEIS: number;
-    let CHANUKAH_CANDLES: number;
-    let ROSH_CHODESH: number;
-    let MINOR_FAST: number;
-    let SPECIAL_SHABBAT: number;
-    let PARSHA_HASHAVUA: number;
-    let DAF_YOMI: number;
-    let OMER_COUNT: number;
-    let MODERN_HOLIDAY: number;
-    let MAJOR_FAST: number;
-    let SHABBAT_MEVARCHIM: number;
-    let MOLAD: number;
-    let USER_EVENT: number;
-    let HEBREW_DATE: number;
-    let MINOR_HOLIDAY: number;
-    let EREV: number;
-    let CHOL_HAMOED: number;
-    let MISHNA_YOMI: number;
-    let YOM_KIPPUR_KATAN: number;
-    let YERUSHALMI_YOMI: number;
-    let NACH_YOMI: number;
-    let DAILY_LEARNING: number;
-}
+export declare const flags: {
+    /** Chag, yontiff, yom tov */
+    CHAG: number;
+    /** Light candles 18 minutes before sundown */
+    LIGHT_CANDLES: number;
+    /** End of holiday (end of Yom Tov)  */
+    YOM_TOV_ENDS: number;
+    /** Observed only in the Diaspora (chutz l'aretz)  */
+    CHUL_ONLY: number;
+    /** Observed only in Israel */
+    IL_ONLY: number;
+    /** Light candles in the evening at Tzeit time (3 small stars) */
+    LIGHT_CANDLES_TZEIS: number;
+    /** Candle-lighting for Chanukah */
+    CHANUKAH_CANDLES: number;
+    /** Rosh Chodesh, beginning of a new Hebrew month */
+    ROSH_CHODESH: number;
+    /** Minor fasts like Tzom Tammuz, Ta'anit Esther, ... */
+    MINOR_FAST: number;
+    /** Shabbat Shekalim, Zachor, ... */
+    SPECIAL_SHABBAT: number;
+    /** Weekly sedrot on Saturdays */
+    PARSHA_HASHAVUA: number;
+    /** Daily page of Talmud (Bavli) */
+    DAF_YOMI: number;
+    /** Days of the Omer */
+    OMER_COUNT: number;
+    /** Yom HaShoah, Yom HaAtzma'ut, ... */
+    MODERN_HOLIDAY: number;
+    /** Yom Kippur and Tish'a B'Av */
+    MAJOR_FAST: number;
+    /** On the Saturday before Rosh Chodesh */
+    SHABBAT_MEVARCHIM: number;
+    /** Molad */
+    MOLAD: number;
+    /** Yahrzeit or Hebrew Anniversary */
+    USER_EVENT: number;
+    /** Daily Hebrew date ("11th of Sivan, 5780") */
+    HEBREW_DATE: number;
+    /** A holiday that's not major, modern, rosh chodesh, or a fast day */
+    MINOR_HOLIDAY: number;
+    /** Evening before a major or minor holiday */
+    EREV: number;
+    /** Chol haMoed, intermediate days of Pesach or Sukkot */
+    CHOL_HAMOED: number;
+    /** Mishna Yomi */
+    MISHNA_YOMI: number;
+    /** Yom Kippur Katan, minor day of atonement on the day preceeding each Rosh Chodesh */
+    YOM_KIPPUR_KATAN: number;
+    /** Daily page of Jerusalem Talmud (Yerushalmi) */
+    YERUSHALMI_YOMI: number;
+    /** Nach Yomi */
+    NACH_YOMI: number;
+    /** Daily Learning */
+    DAILY_LEARNING: number;
+};
 /** Represents an Event with a title, date, and flags */
-export class Event {
+export declare class Event {
+    readonly date: HDate;
+    readonly desc: string;
+    readonly mask: number;
+    emoji?: string;
+    memo?: string;
+    alarm?: Date;
     /**
      * Constructs Event
      * @param {HDate} date Hebrew date event occurs
@@ -40,10 +75,7 @@ export class Event {
      * @param {number} [mask=0] optional bitmask of holiday flags (see {@link flags})
      * @param {Object} [attrs={}] optional additional attributes (e.g. `eventTimeStr`, `cholHaMoedDay`)
      */
-    constructor(date: HDate, desc: string, mask?: number | undefined, attrs?: Object | undefined);
-    date: HDate;
-    desc: string;
-    mask: number;
+    constructor(date: HDate, desc: string, mask?: number, attrs?: object);
     /**
      * Hebrew date of this event
      * @return {HDate}
@@ -69,7 +101,7 @@ export class Event {
      * @param {string} [locale] Optional locale name (defaults to active locale).
      * @return {string}
      */
-    render(locale?: string | undefined): string;
+    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
@@ -77,12 +109,12 @@ export class Event {
      * @param {string} [locale] Optional locale name (defaults to active locale).
      * @return {string}
      */
-    renderBrief(locale?: string | undefined): string;
+    renderBrief(locale?: string): string;
     /**
      * Optional holiday-specific Emoji or `null`.
-     * @return {string}
+     * @return {string | null}
      */
-    getEmoji(): string;
+    getEmoji(): string | null;
     /**
      * Returns a simplified (untranslated) description for this event. For example,
      * the {@link HolidayEvent} class supports
@@ -94,9 +126,9 @@ export class Event {
     /**
      * Returns a URL to hebcal.com or sefaria.org for more detail on the event.
      * Returns `undefined` for events with no detail page.
-     * @return {string}
+     * @return {string | undefined}
      */
-    url(): string;
+    url(): string | undefined;
     /**
      * Is this event observed in Israel?
      * @example
@@ -141,4 +173,3 @@ export class Event {
      */
     getCategories(): string[];
 }
-import { HDate } from '@hebcal/hdate';

package/dist/getStartAndEnd.d.ts

@@ -0,0 +1,6 @@
+import { CalOptions } from './CalOptions';
+/**
+ * Parse options object to determine start & end days
+ * @private
+ */
+export declare function getStartAndEnd(options: CalOptions): number[];

package/dist/hallel.d.ts

@@ -1,7 +1,9 @@
+import { HDate } from '@hebcal/hdate';
+import { Event } from './event';
 /**
  * @private
  * @param {Event[]} events
  * @param {HDate} hdate
  * @return {number}
  */
-export function hallel_(events: Event[], hdate: HDate): number;
+export declare function hallel_(events: Event[], hdate: HDate): number;

package/dist/hebcal.d.ts

@@ -1,10 +1,3 @@
-/**
- * Parse options object to determine start & end days
- * @private
- * @param {CalOptions} options
- * @return {number[]}
- */
-export function getStartAndEnd(options: CalOptions): number[];
 /**
  * HebrewCalendar is the main interface to the `@hebcal/core` library.
  * This namespace is used to calculate holidays, rosh chodesh, candle lighting & havdalah times,
@@ -104,7 +97,7 @@ export class HebrewCalendar {
      *
      * @example
      * import {HebrewCalendar, HDate, Location, Event} from '@hebcal/core';
-     * const options = {
+     * const options: CalOptions = {
      *   year: 1981,
      *   isHebrewYear: false,
      *   candlelighting: true,
@@ -121,7 +114,7 @@ export class HebrewCalendar {
      * @param {CalOptions} [options={}]
      * @return {Event[]}
      */
-    static calendar(options?: CalOptions | undefined): Event[];
+    static calendar(options?: import("./CalOptions").CalOptions | undefined): Event[];
     /**
      * Calculates a birthday or anniversary (non-yahrzeit).
      * `hyear` must be after original `gdate` of anniversary.
@@ -277,161 +270,7 @@ export class HebrewCalendar {
      */
     static tachanun(hdate: HDate, il: boolean): TachanunResult;
 }
-/**
- * Options to configure which events are returned
- */
-export type CalOptions = {
-    /**
-     * - latitude/longitude/tzid used for candle-lighting
-     */
-    location?: Location | undefined;
-    /**
-     * - Gregorian or Hebrew year
-     */
-    year?: number | undefined;
-    /**
-     * - to interpret year as Hebrew year
-     */
-    isHebrewYear?: boolean | undefined;
-    /**
-     * - Gregorian or Hebrew month (to filter results to a single month)
-     */
-    month?: number | undefined;
-    /**
-     * - generate calendar for multiple years (default 1)
-     */
-    numYears?: number | undefined;
-    /**
-     * - use specific start date (requires end date)
-     */
-    start?: number | HDate | Date | undefined;
-    /**
-     * - use specific end date (requires start date)
-     */
-    end?: number | HDate | Date | undefined;
-    /**
-     * - calculate candle-lighting and havdalah times
-     */
-    candlelighting?: boolean | undefined;
-    /**
-     * - minutes before sundown to light candles (default 18)
-     */
-    candleLightingMins?: number | undefined;
-    /**
-     * - 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 | undefined;
-    /**
-     * - 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 | undefined;
-    /**
-     * - 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 | undefined;
-    /**
-     * - 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 | undefined;
-    /**
-     * - calculate parashah hashavua on Saturdays
-     */
-    sedrot?: boolean | undefined;
-    /**
-     * - Israeli holiday and sedra schedule
-     */
-    il?: boolean | undefined;
-    /**
-     * - suppress minor fasts
-     */
-    noMinorFast?: boolean | undefined;
-    /**
-     * - suppress modern holidays
-     */
-    noModern?: boolean | undefined;
-    /**
-     * - suppress Rosh Chodesh
-     */
-    noRoshChodesh?: boolean | undefined;
-    /**
-     * - add Shabbat Mevarchim
-     */
-    shabbatMevarchim?: boolean | undefined;
-    /**
-     * - suppress Special Shabbat
-     */
-    noSpecialShabbat?: boolean | undefined;
-    /**
-     * - suppress regular holidays
-     */
-    noHolidays?: boolean | undefined;
-    /**
-     * - include Days of the Omer
-     */
-    omer?: boolean | undefined;
-    /**
-     * - include event announcing the molad
-     */
-    molad?: boolean | undefined;
-    /**
-     * - use Ashkenazi transliterations for event titles (default Sephardi transliterations)
-     */
-    ashkenazi?: boolean | undefined;
-    /**
-     * - 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 | undefined;
-    /**
-     * - print the Hebrew date for the entire date range
-     */
-    addHebrewDates?: boolean | undefined;
-    /**
-     * - print the Hebrew date for dates with some events
-     */
-    addHebrewDatesForEvents?: boolean | undefined;
-    /**
-     * - use bitmask from `flags` to filter events
-     */
-    mask?: number | undefined;
-    /**
-     * - 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 | undefined;
-    /**
-     * - 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 | undefined;
-    /**
-     * - 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?: {
-        [x: string]: any;
-    } | undefined;
-};
+export type CalOptions = import('./CalOptions').CalOptions;
 export type TachanunResult = {
     /**
      * Tachanun is said at Shacharit
@@ -448,4 +287,3 @@ export type TachanunResult = {
 };
 export type Event = import('./event').Event;
 import { HDate } from '@hebcal/hdate';
-import { Location } from './location.js';

package/dist/holidays.d.ts

@@ -7,11 +7,6 @@
  * @return {Map<string,Event[]>}
  */
 export function getHolidaysForYear_(year: number): Map<string, Event[]>;
-/** Represents a built-in holiday like Pesach, Purim or Tu BiShvat */
-export class HolidayEvent extends Event {
-    /** @return {string} */
-    urlDateSuffix(): string;
-}
 /** Represents Rosh Chodesh, the beginning of a new month */
 export class RoshChodeshEvent extends HolidayEvent {
     /**
@@ -21,24 +16,6 @@ export class RoshChodeshEvent extends HolidayEvent {
      */
     constructor(date: HDate, monthName: string);
 }
-/**
- * Because Asara B'Tevet often occurs twice in the same Gregorian year,
- * we subclass HolidayEvent to override the `url()` method.
- */
-export class AsaraBTevetEvent extends HolidayEvent {
-}
-/** Represents Mevarchim haChodesh, the announcement of the new month */
-export class MevarchimChodeshEvent extends Event {
-    /**
-     * Constructs Mevarchim haChodesh event
-     * @param {HDate} date Hebrew date event occurs
-     * @param {string} monthName Hebrew month name (not translated)
-     * @param {string} [memo]
-     */
-    constructor(date: HDate, monthName: string, memo?: string | undefined);
-    monthName: string;
-    memo: string;
-}
 /** Represents Rosh Hashana, the Jewish New Year */
 export class RoshHashanaEvent extends HolidayEvent {
     /**
@@ -50,16 +27,6 @@ export class RoshHashanaEvent extends HolidayEvent {
     private constructor();
     hyear: number;
 }
-/** YKK is minor day of atonement on the day preceeding each Rosh Chodesh */
-export class YomKippurKatanEvent extends HolidayEvent {
-    /**
-     * @private
-     * @param {HDate} date Hebrew date event occurs
-     * @param {string} nextMonthName name of the upcoming month
-     */
-    private constructor();
-    nextMonthName: string;
-    memo: string;
-}
-import { Event } from './event.js';
+export const NISAN: number;
+import { HolidayEvent } from './HolidayEvent';
 import { HDate } from '@hebcal/hdate';